New Zealand NES IG
1.4.6 - Release

New Zealand NES IG - Local Development build (v1.4.6) 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.

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.

NESCapabilityStatement

NES FHIR Capabilities

Behavior: Message Definitions

These define the types of messages that can be sent and/or received by systems conforming to this implementation guide.

EnrolmentNominationRequestMessageDefinition

Defines the message used to request an enrolment

EnrolmentNominationResponseMessageDefinition

Defines the message used to respond to a request for an enrolment

Structures: Resource Profiles

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

EnrolmentNominationResponse

Adds additional, NES specific extensions

NES Enrolment

Adds additional, NES specific extensions for enrolments

NES Entitlements

The coverage resource contains information related to Patient entitlements

NES Patient

A minimal profile of NzPatient, containing just enough information to validate a patient's NHI for the purposes of enrolment

NES PractitionerRole

A minimal profile of PractitionerRole, which just contains references to the enrolling facility, organisation and practitioner

NesEncounter

Restricts Encounter to the elemrnts need to describe an NES Enrolment qualified Encounter

Structures: Extension Definitions

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

Enrolment_encounter

The last qualified encounter foe this enrolment

Enrolment_expiry_date

The enrolment expiry date

Enrolment_owner_org

Org that creates the enrolment

Nes_enrolment_termination_reason

NES Enrolment Termination Reason Code

Reenrolment_expiry_date

The re-enrolment date

Example: Example Instances

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

do-not-populate-id

Example enrolment create request payload

enrolment-1

Example enrolment

enrolment-2-ended

Example enrolment update request with termination reason

enrolment-bundle1

Example enrolment search response (active enrolments for NHI)

enrolment-nomination-request-error-response-1

Example of a synchronous 422 error response to a enrolment nomination request message

enrolment-nomination-request-message-1

Example enrolment nomination request message

enrolment-nomination-request-message-2

Example of a minimal enrolment nomination request message sent by Whaihua to NES which will be enriched by NES before being forwarded to the HealthLink AIR broker

enrolment-nomination-response-error-response-1

Example of a synchronous 40x error response to a enrolment nomination request message

enrolment-nomination-response-message-1

Example enrolment nomination request message

enrolment-nomination-response-message-2

Example enrolment nomination error response message

entitlement-1

Example CSC entitlement

entitlement-2

Example CSC dependant entitlement

entitlement-3

Example create payload for CSC entitlement

entitlement-4

Example PSC entitlement