Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.2 - release New Zealand flag

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Artifacts Summary

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

Shared Care API definitions

Canonical FHIR Profiles and Definitions

Care In The Community ActivityDefinition Apply Operation

The apply operation applies an ActivityDefinition to a given context

Care In The Community PlanDefinition Apply Operation

The apply operation applies a PlanDefinition to a given context

Care In The Community QuestionnaireResponse Extract Operation

The Extract operation takes a completed QuestionnaireResponse and converts it to a FHIR resource or Bundle of resources by using metadata embedded in the Questionnaire the QuestionnaireResponse is based on

CommunicationPerson

A person resource used to record contact preferences for a person who is part of an HNZ cohort.

ManaakiNgaTahiAllergyIntolerance

AllergyIntolerance FHIR resource for Manaaki Nga Tahi

ManaakiNgaTahiCarePlan

CarePlan FHIR resource for Manaaki Nga Tahi

ManaakiNgaTahiCondition

Condition FHIR resource for Manaaki Nga Tahi

ManaakiNgaTahiDocumentReference

DocumentReference FHIR resource for Manaaki Nga Tahi

ManaakiNgaTahiEncounter

Encounter FHIR resource for Manaaki Nga Tahi

ManaakiNgaTahiObservation

Observation FHIR resource for Manaaki Nga Tahi

ManaakiNgaTahiPlanDefinition

PlanDefinition template which creates Manaaki Nga Tahi (Care in the Community) CarePlans

ManaakiNgaTahiServiceRequest

Service request FHIR resource for Manaaki Nga Tahi

ServiceRequestActivityDefinition

ActivityDefinition resource which creates (templates) ServiceRequests

Template for COVID-19 Care in the Community CCCM MVP Careplans

Creates a care plan suitable for a low to medium-risk COVID-19 case: patient activities include medication delivery, heath checks, RAT self-test and follow-up GP Check

Vital Signs Observation Service Request

Template for care plan activities that capture of patient vital signs

Shared Care API canonical Questionnaires

Standard questionnaire definitions shared by all applications

AIR - Overseas, Historic, Not Done

Submit an overseas, historic, or not-done vaccination to AIR

Antiviral medication eligibility questionnaire

A questionnaire defining eligibility criteria for anti-viral medication

COVID-19 RAT Result Questionnaire

Questionnaire for assisted channel or aged residential care facilities to report a COVID-19 rapid antigen test (RAT) result.

COVID19 Initial Health Assessment Questionnaire

An initial assessment for a patient who has tested positive for COVID-19

COVID19 Public Health History Questionnaire

Questions about a patient's recent COVID-19 history

COVID19 Vaccination Side Effects Questionnaire

Te Whatu Ora post COVID-19 vaccination survey.

Measles Daily Health Check

Te Whatu Ora survey of Symptoms, Context and Quarantine informations surrounding Measles Patients

Mental Health Assessment Survey

Te Whatu Ora Mental Health Assessment Survey

Post Vaccine Symptom Check day 3 survey

Te Whatu Ora 3-day post Influenza/Covid-19 booster vaccination survey.

Post Vaccine Symptom Check day 42 survey

Te Whatu Ora 42-day post Influenza/Covid-19 booster vaccination survey.

Pregnancy Assessment Survey

Te Whatu Ora pregnancy assessment survey.

Private Colposcopy Did Not Attend Questionnaire
Private Colposcopy Discharge Questionnaire
Private Colposcopy Referral Summary Questionnaire
Private Colposcopy Visit Summary Questionnaire
Question Template for COVID-19 Regular Health Check

Gather the status of a patient who is self isolating

Report a Rapid Antigen Test (RAT) result

Consumer COVID RAT Result Questionnaire

Shared Care API QuestionnaireResponse examples

Demonstration QuestionnaireResponses for all Questionnaire resources

ActiveMonitoringDay3SurveyQuestionnaireResponse

Survey of side effects and overall experience of Influenza/COVID-19 Booster vaccination after 3 days.

ActiveMonitoringDay42SurveyQuestionnaireResponse

Survey of side effects and overall experience of Influenza/COVID-19 Booster vaccination after 42 days.

AntiviralEligibilityNoQuestionnaireResponse

Demonstrates payload for a pharmacy review where patient IS NOT eligible for antivirals

AntiviralEligibilityYesQuestionnaireResponse

Demonstrates payload for a pharmacy review where patient IS eligible for antivirals

ConsumerCOVIDRATResultQuestionnaireResponse

Example payload from an individual consumer reporting a COVID-19 rapid antigen test (RAT) result.

COVIDInitialHealthAssessmentQuestionnaireResponse

Demonstrates responses collected for COVIDInitialHealthAssessmentQuestionnaire

COVIDPublicHealthHistoryQuestionnaireResponseSherrylCarrion

Demonstrates responses collected for COVIDPublicHealthHistoryQuestionnaire in relation to example patient Sherryl Carrion

COVIDRATResultQuestionnaireResponse

Example payload from an aged residential care facility reporting a COVID-19 rapid antigen test (RAT) result.

COVIDRegularHealthCheckQuestionnaireResponse

Demonstrates responses collected for COVIDRegularHealthCheckQuestionnaire

COVIDVaccinationSurveyQuestionnaireResponse

Example payload demonstrating data collected in a post COVID vaccination adverse reaction survey.

ImmsotVaccinationDataEntryQuestionnaireResponse

Example payload of an overseas immunisation being added to ImmSoT.

MeaslesHealthCheckQuestionnaireResponse

Example payload from an asymptomatic measles health check.

MentalHealthAssessmentSurveyQuestionnaireResponse

Demonstrates responses collected for MentalHealthAssessmentSurveyQuestionnaire

PregnancyAssessmentSurveyQuestionnaireResponse

Demonstrates responses collected for Pregnancy Assessment Survey Questionnaire

Shared Care examples

CareyCarrington

An example patient resource

ConditionExample

An example ManaakiNgaTahi Condition

COVID-19 Omicron Response - Carey Carrington

An example ManaakiNgaTahi Care Plan

DocumentReferenceExample

An example ManaakiNgaTahi DocumentReference

DrDottyMcStuffins

Example of a practitioner who plans patient care

EncounterExample

An example ManaakiNgaTahi Encounter

ObservationExample

An example ManaakiNgaTahi Observation

ObservationsServiceRequestExample

An example ManaakiNgaTahi ServiceRequest

Communication Person examples

NIBSCommunicationPersonExample

An example Person record. This resource is used to record detailed contact information related to an individual that Health New Zealand - Te Whatu Ora has reason to communicate with.

WhaihuaCommunicationPersonExample

An example Person record. This resource is used to record detailed contact information related to an individual that Health New Zealand - Te Whatu Ora has reason to communicate with.

CMS API definitions

CMS Communication

A communication Resource used to record the SMS/EMAIL communication performed by Systems

CMS Communication Request

This resource is a record of a request for a communication to be performed. The performance of a CommunicationRequest may result in a communication resource. The following content attachment ID's are special message-body attachment-fileX message-template message-parameters

Record Of all healthcare services

A HealthcareService Resource used to record the details of the service

Record of Template for Email Communication from Any Healthcare System

A DocumentReference FHIR Resource That Define the Template For Email communication. template-message-body, template-message-parameters and template-attachment-fileX are special ID's

CMS Communication Request examples

EmailCommunicationRequestWithoutTemplateExample

An example of a CommunicationRequest resource. This resource is used to record information related to requesting communication with a client using EMAIL as the medium.

EmailCommunicationRequestWithTemplateExample

An example of a CommunicationRequest resource. This resource is used to record information related to requesting communication with a client using EMAIL as the medium.

SMSCommunicationRequestWithoutTemplateExample

An example of a CommunicationRequest resource. This resource is used to record information related to requesting communication with a client using SMS as the medium

SMSCommunicationRequestWithTemplateExample

An example of a CommunicationRequest resource. This resource is used to record information related to requesting communication with a client using SMS as the medium

CMS Communication examples

EmailCommunicationExample

An example of a Communication resource. This resource is used to record information related to communication via Email as the medium

OutreachCommunicationExample

An example of a Communication resource. This resource is used to record information related to communication via SMS as the medium

SMSCommunicationExample

An example of a Communication resource. This resource is used to record information related to communication via SMS as the medium

CMS Communication template examples

EmailCommunicationTemplateExample

An example of an Email Template.

Consent definitions and examples

ActiveConsentExample

Example of an active patient consent lasting for 3 years as recorded by a Rheumatic Fever Secondary Prevention Service org.

ConsentByQuestionnaireExample

An example ManaakiNgaTahi Consent by policy

ConsentByRelatedPersonExample

Example of a data consent given on a subject patient's behalf by a relative.

ConsentExample

An example ManaakiNgaTahi Consent based on policies (but not involving a Questionnaire)

ConsentQuestionnaireResponseExample

An example ManaakiNgaTahi QuestionnaireResponse

ManaakiNgaTahiConsent

Consent FHIR resource for Manaaki Nga Tahi

ProvisionalConsentExample

Example of a 3 month provisional data consent.

Provisional consents are needed when an organisation creates FHIR data about a patient but has not yet officially received their consent. This can arise in real world health scenarios when the first opportunity for a patient to read and sign a consent form occurs some time after their registration with representations in FHIR.

Question Template for COVID-19 Privacy Statement Question

A response to this questionnaire is used by Consent resources that enable access to other FHIR resources.

New Dunedin Hospital Outpatient definitions

New Dunedin Hospital Outpatient Appointment Profile

This profile derives from the Appointment Resource with localisations using international and NZ standards including the FHIR NZ Base IG, for use in the NZ context.

New Dunedin Hospital Outpatient Appointment Response Profile

This profile derives from the AppointmentResponse Resource with localisations using international and NZ standards including the FHIR NZ Base IG, for use in the NZ context.

New Dunedin Hospital Outpatient Get Patient Profile

This profile derives from the Patient Resource with localisations using international and NZ standards including the FHIR NZ Base IG, for use in the NZ context.

New Dunedin Hospital Outpatient Update profile

This profile derives from the Patient Resource with localisations using international and NZ standards including the FHIR NZ Base IG, for use in the NDH outpatients context.

New Dunedin Hospital Outpatient examples

NDHOutpatientAppointmentExample

An example New Dunedin Hospital Outpatient Appointment

NDHOutpatientAppointmentResponseExample

An example New Dunedin Hospital Outpatient Appointment

NDHOutpatientExample

An example New Dunedin Hospital Outpatient

NDHOutpatientUpdateExample

An example New Dunedin Hospital Outpatient Update demographics (phone and email)

Outreach Referral Definitions

OutreachServiceRequest

Service request FHIR resource for outreach referral service

OutreachTask

Task FHIR resource for the outreach referral service

Outreach Referral Examples

OutreachServiceRequestExample

An example of an outreach ServiceRequest

OutreachTaskExample

An example of an outreach task

Canonical FHIR Profiles and Definitions used in the Remote Patient Monitoring Pilot

Template for Remote Monitoring Cardiac Rehab Care Plan

Published by Wellington Hospital Cardiac Rehab Team for national use

Template for Remote Monitoring Heart Failure Care Plan

This careplan designed to support ongoing monitoring of long term conditions (heart failure) in primary care.

Vital Signs Observation Service Request

Remote Monitoring Observation Request

Examples of Resources used in the Remote Patient Monitoring Pilot

Educational Content Delivery Task

Task assigned to deliver educational content to a patient.

RPMCardiacRehabCarePlanExample
RPMCareTeamExample
RPMConsentExample
RPMObservationExample
RPMObservationServiceRequestExample
RPMPatientOnboardingCommunicationRequest

Resources used in the Pharmacy Claim Process

New Zealand Pharmacy Claim Response

FHIR profile for New Zealand pharmacy claim responses

NZ Medication Dispense

A FHIR profile for NZ Medication Dispense, including extensions for NZePS script number.

NZ Medication Request

A FHIR profile for NZ Medication Requests, including extensions for NZePS endorsement and funding category.

NZ Pharmacy Claim

A FHIR resource profile for NZ Pharmacy Claims, including extensions for patient cohort and claimant information.

Examples of Resources used in the Pharmacy Claim Process

HSAAPAdjudicatedClaimResponse
New Zealand Pharmacy Claim Response Example

Example of a New Zealand pharmacy claim response

PharmacySubmittedClaim

Resources used in the Claim Process

NZ SharedCare Appointment

A FHIR resource profile for NZ Telehealth Appointments for 24/7 telehealth services.

NZ SharedCare Encounter

A FHIR resource profile for NZ SharedCare Encounters.

diagnosis.condition: Do we need a condition profile for this?

NZ Telehealth Claim

A FHIR resource profile for NZ Telehealth Claims for 24/7 telehealth services.

Note: In 4B insurance, priority and item.productOrService are compulsory fields.

NZ Telehealth Claim Response

A FHIR resource profile for NZ Telehealth Claim Responses for 24/7 telehealth services.

Note: In 4B item.adjudication, item.detail.adjudication, payment.amount, insurer are compulsory fields, but not utilized in the telehealth implementation. item.adjudication.quantity R5 is item.adjudication.value in R4B.

Examples of Resources used in the Telehealth Claim Process

NZ Telehealth Appointment Example

Example of a telehealth appointment for 24/7 telehealth services

NZ Telehealth Claim Example

Example of a telehealth claim for 24/7 telehealth services

NZ Telehealth Claim Response Example

Example of a NZ Telehealth Claim Response for 24/7 telehealth services

NZ Telehealth Encounter Example

Example of a telehealth encounter for 24/7 telehealth services

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.

Shared Care FHIR Server Capability Statement
Health NZ Te Whatu Ora Shared Care FHIR API

Behavior: Operation Definitions

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

RunOperation

Run a flat data view operation to aggregate data for a specific patient using a defined ViewDefinition.

Structures: Questionnaires

These define forms used by systems conforming to this implementation guide to capture or expose data to end users.

Remote Monitoring COPD Survey

A questionnaire for a daily symptom surveying for Remote Monitoring of COPD Patients

Remote Monitoring Feedback Survey

A questionnaire for a weekly feedback survey with regard to the remote monitoring pilot

Remote Monitoring Heart Failure Symptom Survey Questionnaire

A questionnaire for a daily symptom surveying for Heart Failure patients

Structures: Resource Profiles

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

Record of Engagement with a Remote Patient Monitoring Education Module

A DocumentReference FHIR Resource That Define the Template For Email communication. template-message-body, template-message-parameters and template-attachment-fileX are special ID's

Structures: Extension Definitions

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

Accident Related

Whether the encounter is accident-related (ACC vs HNZ funding)

Attachment details

Extra details for attachment to help with rendering

Balance Owing

Indicates the balance owing for the pharmacy claim item detail.

CBS Pack Size

Indicates the CBS pack size for the pharmacy claim item detail.

CBS Subsidy

Indicates the CBS subsidy for the pharmacy claim item detail.

CSC Number

Community Services Card holder number

Callback Url

Callback Url for system

Campaign details

For storing campaign codes and names

Claimant Number

The claimant number for the patient.

Dose Flag

Indicates a flag relevant to the dose for the pharmacy claim.

For sms reply

Specifies whether a reply is expected and provides a webhook URL for the reply.

Group ID

A group identifier relevant to the pharmacy claim.

HNZ Patient Contact Role

The nature of the functional role between the patient and the contact person.

HNZ Person Telecom Count Shared

Where a telecom is attributed to more than one Person this extension records the number of records this particular telecom is shared with.

HNZ Person Telecom Information Source

Property to record the source system where the contact details were collected

HNZ Person Telecom Invalid Indicator

Records the validity of the telecom generally based on most recent contact attempt.

HNZ Person Telecom Last Contacted

Records the last time that a particular contact method has been used.

HNZ Person Telecom Phone Type

Records the last time that a particular contact method has been used.

HNZ Person Telecom Score

Record an accuracy score for a Person telecom property.

Item Tax

Claimed tax amount for the item

NZePS Endorsement

Endorsement details for NZ Electronic Prescription Service.

NZePS Funding Category

Funding category for NZ Electronic Prescription Service.

NZePS Script Number Local

Local script number for NZ Electronic Prescription Service, used as a unique transaction number.

Originating Claimant Number

The claimant number for the the previous owner.

Patient Cohort

Indicates the cohort for which the patient belongs, such as CRC, ARRC, LTC, CDOS, PRISON, etc.

Patient Flag

Indicates a flag relevant to the patient for the pharmacy claim.

Patient Paid Amount

Co-payment amount paid by the patient

Prescriber Flag

Indicates a flag relevant to the prescriber for the pharmacy claim.

Prescription Flag

Indicates a flag relevant to the prescription for the pharmacy claim.

Product Or Service

To enable validation and, if required, supply or correction of the PU code

Registration Code

Whether the patient is enrolled at the practice (enrolled or casual)

Remote Patient Monitoring Education Module Extension

An extension to reference the education module associated with a learning activity.

Review Outcome

Result of adjudication for this item

Send to and from communication to contact points

Communication send to and from contact point

Status DateTime

Status updated date time

Trace Number

Internal primary key ID for the claim

Triage Category

Australasian Triage Scale (ATS) category

Wastage Quantity

Indicates the wastage quantity for the pharmacy claim item detail.

Terminology: Value Sets

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

Adjudication Reason Codes

Codes for adjudication reasons

Adjudication Value Codes

Codes for adjudication values

Australasian Triage Scale

Australasian Triage Scale (ATS) categories used in New Zealand and Australia

COVID19 vaccines recognised by NZ public health

The COVID19 vaccine codes, as defined by NZ national immunisation register, for patient vaccination history recording purposes

Claim Care Team Role Codes

Roles for care team members in claims

Claim Decision Codes

Codes for claim decisions

Claim Decision Reason Codes

Codes for claim decision reasons

Codes for Task code

Each code represents the type of referral request

Diagnosis Use Codes

Codes for diagnosis use (working vs final)

Education Module ValueSet

Codes representing available education modules.

Information source when using the telecom information source extension

Applicable values for information source when using the telecom information source extension. Identifies the source of information, the system where a contact detail is recorded.

NZ Claim Subtypes

Subtypes of claims in New Zealand

NZ Claim Types

Types of claims in New Zealand

NZ purpose of use

Reason for performing one or more operations on information, which may be permitted by source system's security policy in accordance with one or more privacy policies and consent directives. Usage Notes: The rationale or purpose for an act relating to the management of personal health information, such as collecting personal health information for research or public health purposes.

Patient Cohort ValueSet

Allowed values for the Patient Cohort extension.

Payment Type Codes

Codes for payment types

Pharmacy Adjudication Category

Categories for pharmacy claim adjudication amounts

Provider Qualification Codes

Qualification codes for providers

Status Reason for ServiceRequest

Each code represents the type of referral request

System that last updated the record

When a system updates a record the intent is that this value set would be used to populate a meta.tag property in the updated resource indicating the system that is updating the resource.

Telecom phone type indicator

Enables the recording of a special type for a telecom record.

Telecom record score indicator

Indicates the accuracy score for a telecom record.

Valueset for Communication Delivery Status

Valueset for Communication Delivery Status

Valueset for Participation Mode

Valueset for Participation Mode

Valueset for Template Category

Valueset for Template Category

Terminology: Code Systems

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

Australasian Triage Scale Code System

Code system for Australasian Triage Scale (ATS) categories

Claim Care Team Role Code System

Code system for claim care team roles

Claim Decision Code System

Code system for claim decisions

Claim Decision Reason Code System

Code system for claim decision reasons based on FHIR R5 claim-decision-reason

Codes for CommunicationStatus

Each code represents a communication delivery status

Codes for ServiceRequest code

Each code represents the type of referral request

Codes for Telecom Phone Types

Each code represents a phone type

Codes for Telecom Score

Each code represents an indication of a telecom records accuracy score

Codes for Telecom Source Systems

Each code represents different source system

Codes for Template category

Each code represents a Template category

Codings for COVID-19 vaccination brands recognised in New Zealand public health

Each code represents a recognised COVID-19 vaccine

Education Module CodeSystem

CodeSystem for education modules.

NZ Claim Subtype Code System

Code system for NZ claim subtypes

NZ Claim Type Code System

Code system for NZ claim types

NZ Purpose Of Use

Additional codes to be incorporated with HL7 v3 Value Set Purpose of Use

ParticipationMode

A set of codes specifying the modality by which the Entity playing the Role is participating in the Act.

Examples: Physically present, over the telephone, written communication.

Rationale: Particularly for author (originator) participants this is used to specify whether the information represented by the act was initially provided verbally, (hand-)written, or electronically.

Open Issue: There needs to be a reexamination of the hierarchies as there seems to be some muddling between ELECTRONIC and other concepts that involve electronic communication that are in other hierarchies.

Patient Cohort CodeSystem

Cohort classifications for patients.

Pharmacy Adjudication Category Code System

Code system for pharmacy adjudication categories

Status Reason for ServiceRequest

Each code represents the type of referral request

Example: Example Instances

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

AllergyIntoleranceExample

An example payload for the Manaaki Nga Tahi AllergyIntolerance resource indicating an allergy to Penicillin

BSAService

An example of a Health Service. This resource is used to record information related to individual Health Service.

GOFSH-GENERATED-ID-0
New Zealand Pharmacy Claim Example

Example of a New Zealand pharmacy claim

RPMEducationCompletionExample
Remote Patient Monitoring Educational Content Feedback Survey/Questionnaire

This questionnaire is used to collect Patient feedback regarding an educational content module

RemoteMonitoringHeartFailureSymptomSurveyQuestionnaireResponse
Template for COVID-19 Care in the Community CCCM MVP Careplans

An example ManaakiNgaTahi PlanDefinition