Coming soon

Information about digital assets available for integration in the near future.

National Cervical Screening Summary

The Screening History Summary API (Application Programming Interface) is an information service which allows authorised healthcare applications to search for and obtain a cervical screening history. This summary includes patient demographic data, previous screening results, pathway status and next expected events (ie next due screening date, follow-up due date). The API is intended to enable timely, secure and audited access to screening information for Primary and Community screen-takers, colposcopy practitioners, health professionals involved with cervical cancer treatment and participants (health consumers). While the initial focus of the API is on cervical screening programme participation, it is intended that its scope will broaden in future to support enquiries about participation in other national screening programmes.

Service description

The initial version of the API lets other systems or applications search for Cervical Screening History Summaries by NHI. A Screening History Summary combines participation data from the National Cervical Screening Programme Register (screening programme enrolment status and next action, etc) and screening history such as cytology test results and other relevant lab test records. As a FHIR API, screening summaries are returned as PDF/HTML documents attached to FHIR R4B Document Reference resource instances. A user of this API retrieves a screening summary by doing a FHIR search operation on the Document Reference REST resource space. API users are expected to parse the search set Bundle returned by the FHIR search operation as it may contain special match outcome messages in addition to the Document Reference and an included Patient instance for the matching screening summary.

Refer to the FHIR implementation guide for full details of the service.

Medicines Data Repository

The Medicines Data Repository (MDR) is a trusted source of prescribed and dispensed medicines information for New Zealanders. It is based on real-time information received directly from the New Zealand ePrescription Service (NZePS).

The purpose of the MDR is to provide FHIR based API access to a consolidated single source of NZePS data, accessible by NHI and HPI, that can be used by consumers and health providers.

Overview

The MRD API provides read-only access to a person's prescription and dispensing history. This information can be access through an approved system application via a FHIR API.

Medicines reconciliation: The process of confirming what medication has currently, or recently, been prescribed or dispensed to a consumer and what the consumer has taken. This process is normally undertaken prior to any medical intervention by a health professional.

Medicines adherence: The process of confirming what medication a consumer is currently taking based on what was prescribed and dispensed. This process is normally undertaken when a consumer is not responding as expected to the medication prescribed.

Real-time access to controlled drug prescribing: The process of confirming a consumer's medication history before prescribing controlled drugs. The primary purpose is to ensure that the consumer is not over-prescribed controlled drugs.

Who can use this API

Access to the MDR is for organisations that meet the eligibility criteria related to medicines prescribing, dispensing, reconciliation and administering.

Use cases

The information held in MDR is currently approved for the following uses.

Request a person's medication history according to their NHI.
Request medication activity over a date range.
Lookup medications prescribed by a specific provider for a patient.
Request records of specific prescribed and dispensed medications.