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

API


NES FHIR Capabilities



REST APIs



Resource Level Interactions

Coverage
Interactions
NameVerbURLDocumentationScope
read GET [base]/Coverage/[id] Used to retrieve a Patient entitlement by id system/Coverage.r
create POST [base]/Coverage Create a new entitlement - Future Scope system/Coverage.c
update PUT [base]/Coverage/[id] Update a patient's entitlement card details system/Coverage.u
search-type GET [base]/Coverage Search for a patient's entitlements patient:Coverage.s system/Coverage.s
Search Parameters
NameTypeDocumentation
identifier token

external entitlement id - Future scope
beneficiary string

NHI-Id
type token

entitlement type code - Future scope
status token

status code - Future scope
EpisodeOfCare
Interactions
NameVerbURLDocumentationScope
read GET [base]/EpisodeOfCare/[id] Used to retrieve a Patient enrolment by id - Future scope system/EpisodeOfCare.r
create POST [base]/EpisodeOfCare Create a new enrolment system/EpisodeOfCare.c
update PUT [base]/EpisodeOfCare/[id] Update an existing enrolment system/EpisodeOfCare.u
search-type GET [base]/EpisodeOfCare Search for a Patient's enrolment's system/EpisodeOfCare.s
Search Parameters
NameTypeDocumentation
patient string

NHI number
status token

status code
type token

type code - Future scope

Server Level Interactions

Operations
NameVerbURLDocumentationScope
process-message POST [base]/$process-message http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message system/MessageHeader.c

Messages

Definitions
NameDefinitions

sender

http://hl7.org.nz/fhir/MessageDefinition/EnrolmentNominationRequestMessageDefinition

receiver

http://hl7.org.nz/fhir/MessageDefinition/EnrolmentNominationRequestMessageDefinition

receiver

http://hl7.org.nz/fhir/MessageDefinition/EnrolmentNominationResponseMessageDefinition