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

CapabilityStatement: Medicines Data Repository FHIR Server (Experimental)

Official URL: https://preprod-apibroker.whanautahi.com/mcv/fhir/metadata Version: 0.1.0
Draft as of 2023-02-24 Computable Name: NZ_MDR

MDR Consumer View Capability Statement

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement ConsumerCapabliityStatement

Medicines Data Repository FHIR Server

  • Implementation Guide Version: 0.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+json
  • Supported Patch Formats:
  • Published on: 2023-02-24 01:15:23+0000
  • Published by: Te Whatu Ora

Note 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.

FHIR RESTful Capabilities

Mode: server

Security
Enable CORS: no
Security services supported: OAuth

Supports OAuth 2.0 - Client Credential flow. [OAuth token endpoint] (https://login.microsoftonline.com/7a71250a-e506-4080-8e6a-ae1e8a771e22/oauth2/v2.0/token)

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
MedicationRequesthttp://hl7.org/fhir/StructureDefinition/MedicationRequesty_lastUpdated, _security, status, authoredon, patientMedicationDispense:prescription
MedicationDispensehttp://hl7.org/fhir/StructureDefinition/MedicationDispensey_lastUpdated, _security, patient, whenprepared, whenhandedover, statusMedicationDispense:prescription, MedicationDispense:medication

Resource Conformance: supported MedicationRequest

Base System Profile
MedicationRequest
Profile Conformance
SHALL
Reference Policy
literal, local

Interaction summary
  • Supports read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_lastUpdateddate

When the resource version last changed (use format yyyy-mm-ddThh:mm:ssZ)

SHALL_securitytoken

Security Labels applied to this resource

SHALLstatustoken

Status of the prescription

SHALLauthoredondate

Return prescriptions written on this date (use format yyyy-mm-ddThh:mm:ssZ)

SHALLpatientreference

Returns prescriptions for a specific patient (NHI)

 

Resource Conformance: supported MedicationDispense

Base System Profile
MedicationDispense
Profile Conformance
SHALL
Reference Policy
literal, local

Interaction summary
  • Supports read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_lastUpdateddate

When the resource version last changed (use format yyyy-mm-ddThh:mm:ssZ)

SHALL_securitytoken

Security Labels applied to this resource

SHALLpatientreference

The identity of a patient to list dispenses for (NHI)

SHALLwhenprepareddate

Returns dispenses prepared on this date (use format yyyy-mm-ddThh:mm:ssZ)

SHALLwhenhandedoverdate

Returns dispenses handed over on this date (use format yyyy-mm-ddThh:mm:ssZ)

SHALLstatustoken

Returns dispenses with a specified dispense status