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
| Official URL: https://apibroker.whanautahi.com/mdr/fhir/metadata | Version: 0.1.0 | |||
| Draft as of 2022-09-01 | Computable Name: NZ_MDR | |||
MDR Capability Statement
Raw OpenAPI-Swagger Definition file | Download
application/fhir+jsonNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
serverOAuthSupports OAuth 2.0 - Client Credential flow. [OAuth token endpoint] (https://login.microsoftonline.com/7a71250a-e506-4080-8e6a-ae1e8a771e22/oauth2/v2.0/token)
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| MedicationRequest | http://hl7.org/fhir/StructureDefinition/MedicationRequest | y | _id, identifier, _lastUpdated, _security, code, status, authoredon, patient, requester, location | Observation:based-on, MedicationDispense:prescription | |||||
| MedicationDispense | http://hl7.org/fhir/StructureDefinition/MedicationDispense | y | _id, identifier, _lastUpdated, _security, code, patient, location, whenprepared, whenhandedover, status | MedicationDispense:prescription |
literal, localread.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Logical id of this artifact |
| SHALL | identifier | token | Return prescriptions with this external identifier (SCID Item Identifier) |
| SHALL | _lastUpdated | date | When the resource version last changed |
| SHALL | _security | token | Security Labels applied to this resource |
| SHALL | code | token | Return prescriptions of this medication code (NZULM) |
| SHALL | status | token | Status of the prescription |
| SHALL | authoredon | date | Return prescriptions written on this date |
| SHALL | patient | reference | Returns prescriptions for a specific patient (NHI) |
| SHALL | requester | reference | Returns prescriptions prescribed by this prescriber (CPN) |
| SHALL | location | reference | Returns prescriptions prescribed at the facility (HPI Facility ID) |
literal, localread.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Logical id of this artifact |
| SHALL | identifier | token | Returns dispenses with this external identifier (SCID Item Identifier) |
| SHALL | _lastUpdated | date | When the resource version last changed |
| SHALL | _security | token | Security Labels applied to this resource |
| SHALL | code | token | Returns dispenses of this medicine code (NZULM) |
| SHALL | patient | reference | The identity of a patient to list dispenses for (NHI) |
| SHALL | location | reference | Returns dispenses performed at the principal physical location (HPI Facility ID) |
| SHALL | whenprepared | date | Returns dispenses prepared on this date |
| SHALL | whenhandedover | date | Returns dispenses handed over on this date |
| SHALL | status | token | Returns dispenses with a specified dispense status |