Medicines Data Repository Implementation Guide
0.1.0 - ci-build
Medicines Data Repository Implementation Guide, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/mdr/ and changes regularly. See the Directory of published versions
This page describes the API interface for the Provider View API and its supported interactions.
The API implements a subset of the standard FHIR REST API functionality that is relevant to Medicines prescribing and dispensing.
The supported interactions are described by the CapabilityStatement for the Consumer View API and are summarised at the bottom of this page.
The CapabilityStatement for the API can be returned with the following query (also useful for checking connectivity):
https://apibroker.whanautahi.com/mcv/fhir/metadata
All Medication Requests for a single e-Script – including Dispenses & Observations (example Response Bundle attached):
https://apibroker.whanautahi.com/mdr/fhir/MedicationRequest ?identifier=https://standards.digital.health.nz/ns/nzeps-scid-item-id| 9A0A002KP580YPFDQ7-1&_revinclude=MedicationDispense:prescription &_revinclude=Observation:based-on
All Medication Requests for a single Patient NHI and Date Range:
https://apibroker.whanautahi.com/mdr/fhir/MedicationRequest?patient=ZZZ0008&authoredon=ge2023-01-01&authoredon=le2023-08-31
All Medication Requests for a single Prescriber HPI:
https://apibroker.whanautahi.com/mdr/fhir/MedicationRequest?requester=55REXH
All Medication Requests for a single Prescribing HPI Facility and Drug Code:
https://apibroker.whanautahi.com/mdr/fhir/MedicationRequest? location=F0K068-E&code=50185041000117105
The below summary is generated from the CapabilityStatement resource and lists the supported Resources, interactions, and parameters.
MDR Provider View Capability Statement
| Code | Documentation |
|---|---|
| read | Supports retrieving a resource by its id. Will return a single resource. |
| Name | Type | Documentation |
|---|---|---|
| _id | token | Definition: http://hl7.org/fhir/SearchParameter/Resource-id Logical id of this artifact |
| identifier | token | Definition: http://hl7.org/fhir/SearchParameter/clinical-identifier Return prescriptions with this external identifier (SCID Item Identifier) |
| _lastUpdated | date | Definition: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated When the resource version last changed |
| _security | token | Definition: http://hl7.org/fhir/SearchParameter/Resource-security Security Labels applied to this resource |
| code | token | Definition: http://hl7.org/fhir/SearchParameter/clinical-code Return prescriptions of this medication code (NZULM) |
| status | token | Definition: http://hl7.org/fhir/SearchParameter/medications-status Status of the prescription |
| authoredon | date | Definition: http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon Return prescriptions written on this date |
| patient | reference | Definition: http://hl7.org/fhir/SearchParameter/clinical-patient Returns prescriptions for a specific patient (NHI) |
| requester | reference | Definition: http://hl7.org/fhir/SearchParameter/MedicationRequest-requester Returns prescriptions prescribed by this prescriber (CPN) |
| location | reference | Definition: https://apibroker.whanautahi.com/mdr/fhir/SearchParameter/MedicationRequest-location Returns prescriptions prescribed at the facility (HPI Facility ID) |
| Code | Documentation |
|---|---|
| read | Supports retrieving a resource by its id. Will return a single resource. |
| Name | Type | Documentation |
|---|---|---|
| _id | token | Definition: http://hl7.org/fhir/SearchParameter/Resource-id Logical id of this artifact |
| identifier | token | Definition: http://hl7.org/fhir/SearchParameter/clinical-identifier Returns dispenses with this external identifier (SCID Item Identifier) |
| _lastUpdated | date | Definition: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated When the resource version last changed |
| _security | token | Definition: http://hl7.org/fhir/SearchParameter/Resource-security Security Labels applied to this resource |
| code | token | Definition: http://hl7.org/fhir/SearchParameter/clinical-code Returns dispenses of this medicine code (NZULM) |
| patient | reference | Definition: http://hl7.org/fhir/SearchParameter/clinical-patient The identity of a patient to list dispenses for (NHI) |
| location | reference | Definition: https://apibroker.whanautahi.com/mdr/fhir/SearchParameter/MedicationDispense-location Returns dispenses performed at the principal physical location (HPI Facility ID) |
| whenprepared | date | Definition: http://hl7.org/fhir/SearchParameter/MedicationDispense-whenprepared Returns dispenses prepared on this date |
| whenhandedover | date | Definition: http://hl7.org/fhir/SearchParameter/MedicationDispense-whenhandedover Returns dispenses handed over on this date |
| status | token | Definition: http://hl7.org/fhir/SearchParameter/medications-status Returns dispenses with a specified dispense status |
| Name |
|---|
| MedicationDispense:prescription |