FHIR New Zealand Patient Summary IG
0.3.0 - ci-build New Zealand flag

FHIR New Zealand Patient Summary IG - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

NZPS Library

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

HNZ Patient Summary CapabilityStatement

HNZ Patient Summary API capability statement. This API supports the $summary operation to return an NZPS compliant FHIR document containing a summary of a patient based on infomration held by Health New Zealand collated from multiple systems of record and sources of truth systems.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

NZPS Summary

The NZPS uses the $summary operation to allow clients to query by NHI number and be returned an NZPS compliant FHIR document.

The $summary operation is invoked by POST’ing a Parameters resource containing the NHI number of the patient to the $summary endpoint.

Request URL:

POST [base]/Patient/$summary

Example Parameters body:

` [example Parameters resource here] `

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

NZPS-AllergyIntolerance

A record of a clinical assessment of an allergy or intolerance; a propensity, or a potential risk to an individual, to have an adverse reaction on future exposure to the specified substance, or class of substance.

Where a propensity is identified, to record information or evidence about a reaction event that is characterized by any harmful or undesirable physiological response that is specific to the individual and triggered by exposure of an individual to the identified substance or class of substance.

NZPS-Bundle

This profile represents the constraints applied to the Bundle resource for the New Zealand Patient summary and is based on the profile for the International Patient Summary (IPS) Document Bundle.

NZPS-CarePlan

Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.

NZPS-Clinical-Impression

A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient’s condition.

NZPS-Communication

The NZPS Communication is a profile for the FHIR Communication resource. It is used to record communication between a health professional and a patient or other person about their wishes for future care.

NZPS-Composition

Clinical document used to represent the NZPS data set. It is an electronic health record extract containing essential healthcare information about a subject of care. The NZIPS dataset is minimal and non-exhaustive; specialty-agnostic and condition-independent; but still clinically relevant.

NZPS-Coverage

The coverage resource is used to record NZ health system entitlement information

NZPS-DiagnosticReport

This profile constrains the DiagnosticReport resource to represent diagnostic test and procedure reports in a patient summary.

NZPS-DocumentReference

A reference to a document.

NZPS-Encounter

An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. Encounter is primarily used to record information about the actual activities that occurred, where Appointment is used to record planned activities.

NZPS-Flag

Information used to warn or call to a state of preparedness. Information flagged (or intended) to raise awareness of a potential danger to/from the subject of the patient summary or to/from another individual or awareness of a potential obstacle to care

NZPS-Immunization

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

NZPS-Medication

Medication as referenced by the MedicationStatement resource constrained by this profile. Based on the IPS profile.

NZPS-MedicationDispense

Medication dispensing information using NZMT codes for medication

NZPS-MedicationRequest

MedicationRequest as referenced by the MedicationStatement resource constrained by this profile. Based on the IPS profile.

NZPS-MedicationStatement

A record of medication being taken is represented in the patient summary as an instance of an MedicationStatement resource constrained by this profile. Based on the IPS profile.

NZPS-Observation-Alcohol-Use

This profile constrains the Observation resource to represent alcohol use assessment in the patient summary.

NZPS-Observation-Pregnancy-EDD

This profile constrains the Observation resource to represent the pregnancy expected delivery date.

NZPS-Observation-Pregnancy-outcome

This profile constrains the Observation resource to represent the pregnancy outcome.

NZPS-Observation-Pregnancy-status

This profile constrains the Observation resource to represent the pregnancy status.

NZPS-Observation-Results

This profile constrains the Observation resource to represent various types of results and associated observations in a patient summary. This is the base profile from which the other results profiles are derived.

NZPS-Observation-Results-Laboratory

This profile constrains the Observation resource to represent results produced by laboratory tests or panels/studies in a patient summary.

NZPS-Observation-Smoking-Status

This profile constrains the Observation resource to represent Tobacco use assessment in a patient summary.

NZPS-Observation-Vaping-Status

This profile constrains the Observation resource to represent Vaping use in a patient summary.

NZPS-Observation-Vital-Signs

This profile is based on the R4 VitalSigns profile.

NZPS-Organization

The NZ Patient Summary organisation resource. This profile derives from the International Patient summary with localisations using international and NZ standards including the FHIR NZ Base IG, for use in the NZ context.

NZPS-Patient

The NZ International Patient Summary patient resource. This profile derives from the International Patient summary with localisations using international and NZ standards including the FHIR NZ Base IG, for use in the NZ context.

NZPS-Practitioner

The NZ International Patient Summary patient resource. This profile derives from the International Patient summary with localisations using international and NZ standards including the FHIR NZ Base IG, for use in the NZ context.

NZPS-PractitionerRole

The NZ International PractitionerRole Summary patient resource. This profile derives from the International Patient summary with localisations using international and NZ standards including the FHIR NZ Base IG, for use in the NZ context.

NZPS-Problem (Condition)

NZPS problem (FHIR Condition resource). This profile derives from the International Patient Summary Condition resource used to document a health problem, with localisations using international and NZ Government standards for the NZ context.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

NZPS List Empty Reason ValueSet

Codes for why a list/section is empty

Vaping Status

ValueSet for Vaping Status based on the New Zealand vaping status reference set.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Codes for why a list/section is empty

NZPS Specific codes for why a list/section is empty

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

NZPS Communication Patient Story Example one (one Communication Resource for many content items)
NZPS Communication Patient Story Example two (one Communication Resource per content item)