New Zealand NHI IG
1.6.5 - Release

New Zealand NHI IG - Local Development build (v1.6.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## API

A FHIR API in front of the New Zealand NHI

### REST APIs

#### Resource Level Interactions

##### Patient

Interactions

Name | Verb | URL | Documentation | Scope
--- | --- | --- | --- | ---
read | GET | [base]/Patient/[nhi-id] | Retrieve a Patient resource by Id | patient:Patient.r system/Patient.r

Operations
Name | Definition | Verb | URL | Documentation | Scope
--- | --- | --- | --- | --- | ---
match | http://hl7.org/fhir/OperationDefinition/Patient-match | POST | [base]/Patient/$match | Match: with In parameter `onlyCertainMatches=0` (False) the operation will search the NHI by demographics using fuzzy logic. Returns a bundle of results with match scores. Validate: with In parameter `onlyCertainMatches=1` (True) the operation will validate known patient demographic details against an NHI number. Returns a bundle of results with one patient resource that only includes the live nhi-id. | system/Patient.s system/Patient.v
set-preferred-name | https://nhi-ig.hip.digital.health.nz/OperationDefinition/set-preferred-name | POST | [base]/Patient/$set-preferred-name | Set the patient's preferred name | patient:Patient.u system/Patient.u
set-address | https://nhi-ig.hip.digital.health.nz/OperationDefinition/set-address | POST | [base]/Patient/$set-address | Update a patient's address | patient:Patient.u system/Patient.u
set-unvalidated-address | https://nhi-ig.hip.digital.health.nz/OperationDefinition/set-unvalidated-address | POST | [base]/Patient/$set-unvalidated-address | Allows a user to replace a physical address OR add or replace a postal address with an unvalidated address | system/Patient.u
remove-postal-address | https://nhi-ig.hip.digital.health.nz/OperationDefinition/remove-postal-address | POST | [base]/Patient/$remove-postal-address | Remove a patient's postal address | patient:Patient.u system/Patient.u
update-birth | https://nhi-ig.hip.digital.health.nz/OperationDefinition/update-birth | POST | [base]/Patient/$update-birth | Update a patient's birth information | system/Patient.u
update-identity | https://nhi-ig.hip.digital.health.nz/OperationDefinition/update-identity | POST | [base]/Patient/$update-identity | An operation to update a patient's identity details. | patient:Patient.u system/Patient.u
add-name | https://nhi-ig.hip.digital.health.nz/OperationDefinition/add-name | POST | [base]/Patient/$add-name | Add a name to a patient's NHI record | system/Patient.u
replace-name | https://nhi-ig.hip.digital.health.nz/OperationDefinition/replace-name | POST | [base]/Patient/$replace-name | An operation to replace a name on a patient's record | system/Patient.u
inactivate-name | https://nhi-ig.hip.digital.health.nz/OperationDefinition/inactivate-name | POST | [base]/Patient/$inactivate-name | Inactivate a name that is currently active on a patients record | system/Patient.u
update-eligibility | https://nhi-ig.hip.digital.health.nz/OperationDefinition/update-eligibility | POST | [base]/Patient/$update-eligibility | Update a patient's citizenship information | system/Patient.u
create | https://nhi-ig.hip.digital.health.nz/OperationDefinition/create-patient | POST | [base]/Patient/$create | Create a new patient record in the NHI | system/Patient.c
add-contact | https://nhi-ig.hip.digital.health.nz/OperationDefinition/add-contact | POST | [base]/Patient/$add-contact | add a contact to a patient's NHI record | system/Patient.u
replace-contact | https://nhi-ig.hip.digital.health.nz/OperationDefinition/replace-contact | POST | [base]/Patient/$replace-contact | replace a contact on a patient's NHI record | system/Patient.u
delete-contact | https://nhi-ig.hip.digital.health.nz/OperationDefinition/delete-contact | POST | [base]/Patient/$delete-contact | Delete a contact from a patient's NHI record | system/Patient.u