New Zealand MWS IG
1.1.3 - Release

New Zealand MWS IG - Local Development build (v1.1.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Onboarding

Medical Warning Service Onboarding

Who can apply for access?

To the test environment:

Health Practitioners providing healthcare in relation to the prescribing and dispensing medications, or the recording, treatment or diagnosis of allergies or the risk of adverse drug reactions, this includes administrators recording warnings on behalf of practitioners and their software vendors, will be given access to the Medical Warnings Service (MWS) in the Health Identity Platform (HIP) Compliance environment for testing and training after completing the on-boarding process described below.

To the production environment:

Health Practitioners providing healthcare in relation to the prescribing and dispensing medications, or the recording, treatment or diagnosis of allergies or the risk of adverse drug reactions, this includes administrators recording warnings on behalf of practitioners.

Each organisation and user that has access to the MWS accepts their obligations under the Privacy Act 1993 and the Health Information Privacy Code 1994 to only access information about patients they are treating and are authorised to do so.

On-boarding and Implementation

  1. To get started, head to 'Consumer onboarding', over at the digital services hub. You will need to provide information about your organisation, the product you are developing and the API's you want to integrate with.
  2. Once your onboarding request has been approved, you will be provided with the information to start integration. The integration team will be in touch if further information is required.
    • You will receive your credentials, access token url, provided scopes, and the compliance environment endpoint.
  3. Complete your development and testing.
  4. When you are ready for compliance testing, email the integration team to get a compliance testing template.
  5. Submit the results of the compliance tests using this form [HIP Compliance Submission] (https://mohapis.atlassian.net/servicedesk/customer/portal/3/group/11/create/129).
  6. The integration team will issue a compliance test report. Your application will receive certification to be used in production or additional requirements will need to be met.
    • This can be an iterative process, so please get in touch as needed to discuss the compliance testing process.
  7. Each organisation using your application with NHI integrated services must apply individually for access to the production environment (and recieve their own set of credentials) by completing the production form, please email NHI Access.

  • Please allow at least 5 working days for compliance environment applications to be processed.

  • Please allow at least 2 weeks for compliance testing to be signed off and returned.

  • If Production credentials are required by a large number of organisations accessing your product, please get in touch to discuss options around bulk credential requests and how we can streamline this process.

Assistance

Please fill in the Digital Services Hub Support and Feedback form.

Business Functions

See below for available business functions.
By using Te Whatu Ora APIs you are accessing personally identifiable information from the NES which is not directly from the individual concerned. You need to consider your obligations under HIPC principle 2, and we may request to see your privacy impact assessment prior to access to production.

Business Functions
Business Functions Description Comments
Drug Allergy read To allow access to get a MWS Allergy Intolerance record by mws-id, or to get a person’s MWS Allergy Intolerance records using NHI and other search parameters ​See Get MWS Allergy Intolerance. use case
See Search MWS Allergy Intolerance. use case
Drug Allergy maintain Create and update MWS Allergy Intolerance records See Update MWS Allergy Intolerance use case
Drug Allergy delete Delete a legacy MWS record ​See Delete Legacy Medical Warning use case
Medication Dispense read Get information about a person’s medications See Get Year-to-date Co-payments for Whanau use case