Medical Warning System Allergy Intolerance FHIR API
View and maintain allergies and adverse drug reactions
Pātiki and Waharua Kōpito patterns
On this page
Brief description
The Medical Warnings System (MWS), sometimes referred to as the “National Medical Warnings System” (NMWS), is a value-added service closely aligned with the National Health Index (NHI). It is designed to warn healthcare providers of the presence of any known risk factors that may be important when making clinical decisions about patient care.
The responsibility for maintaining the content of the MWS rests with healthcare providers and the New Zealand Pharmacovigilance Centre (CARM).
This FHIR API will initially provide access to medical warnings related to allergies and adverse drug reactions.
Overview
Allergies and adverse drug reactions from the national Medical Warning System are accessed and updated using the MWS AllergyIntolerance FHIR API. These warnings when made available to clinicians at point of care can reduce the risk of medicines and treatment errors. The MWS FHIR API is available for integration across the many health settings for example Hospital, General practice, and Community pharmacy.
This is a FHIR API made up of one resource:
- MwsAllergyIntolerance, derived from the HL7 FHIR AllergyIntolerance resource
Accessible data
The MWS AllergyIntolerance FHIR API holds the following information:
- clinicalStatus
- verificationStatus
- category
- patient (NHI)
- substance
- reaction manifestations
- onsetDate
- Recorder
- Recorded date
- notes
Other attributes from the standard profile maybe considered for future releases.
Use case
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.
Onboarding and implementation
To begin the onboarding process for this API, please visit the Consumer onboarding page.
For more information on integrating, please review the Implementation guide.
Business functions and risk scores’
To view what these risk scores mean, click here.
|
Name |
Function |
Description |
Clinical Risk Score |
Privacy Risk Score |
|
MWS Allergy Intolerance Read |
Get a specific AllergyIntolerance record using a known mws id.
NOTE: Requesting this business function gives you access to BOTH read and search operations so score the highest risk function. |
GET AllergyIntolerance – Return an AllergyIntolerance using the mws id.
SEARCH AllergyIntolerance – Search Patient Entitlements using an NHI number. A SEARCH request is used to bring back all AllergyIntolerance records for a Patient when the NHI number is known. The search response will return a bundle That may include multiple AllergyIntolerance records.
The search returns all drug and allergy records added by a FHIR api user as well as those added by legacy api users |
HIGH |
EXTREME Level 3 identify verification |
|
MWS Allergy Intolerance Maintain |
Create a new AllergyIntolerances Update an existing MWS Allergy Intolerance record
NOTE: Requesting this business function gives you access to BOTH create and update operations so score the highest risk function. |
Create AllergyIntolerance. A CREATE request is used create a new AllergyIntolerance record for a Patient. The request is validated and business rules applied. If the request is acceptable an AllergyIntolerance record is created.
Update AllergyIntolerance. An update request is used change an attribute(s) of an AllergyIntolerance record. The request should contain the full profile of the AllergyIntolerance record. The request parameters are validated and business rules applied. If the request is acceptable the AllergyIntolerance record is updated. |
HIGH |
EXTREME Level 3 identify verification |
|
DELETE AllergyIntolerance |
Capability to delete a legacy warning |
A DELETE request is used to delete a legacy AllergyIntolerance record. Records created by the FHIR api cannot be deleted, they would have their clinical status set to inactive. The the id is a legacy mws-id then the record is deleted. |
EXTREME |
EXTREME Level 3 identify verification |
API types
FHIR API
All FHIR API endpoints adhere to Fast Healthcare Interoperable Resources (FHIR) interoperability standards and follow REST protocols.
Service levels
Target 99.99 percent service availability 24 hours a day, seven days a week.
Restrictions
Geo restriction
Geo restriction rules prevent access from clients with IPs located in countries other than those listed below.
- New Zealand
- Australia
- Canada
- Cook Islands
Usage Plans
|
Plan |
Rate |
Burst |
Quota |
|
Bronze |
1 request per second |
5 |
10,000 requests per day |
|
Silver |
5 requests per second |
25 |
250,000 requests per day |
|
Gold |
10 requests per second |
50 |
500,000 requests per day |
All test accounts will be assigned to the bronze usage plan. Production accounts will be assigned to the silver usage plan. If a vendor wishes to be assigned to a higher plan, they should contact us via the support form. Please request a change to the usage plan and make sure you include the ClientID at minimum (AppId and OrgId also recommended).