New Zealand NHI IG
1.4.1 - Release
New Zealand NHI IG - Local Development build (v1.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hl7.org.nz/fhir/ig/nhi/CapabilityStatement/NhiCapabilityStatement | Version: 1.4.1 | |||
| Draft as of 2020-04-21 | Computable Name: | |||
A FHIR API in front of the New Zealand NHI
Raw OpenAPI-Swagger Definition file | Download
jsonjsonNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
serverThe summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| Patient | http://hl7.org.nz/fhir/StructureDefinition/NhiPatient | y |
read.| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $match | POST, [base]/Patient/$Match, /$Match (Find NHI) with In parameter onlyCertainMatches: 0 (False) An operation to search the NHI by demographics using fuzzy logic. Returns a bundle of results with match scores. HTTP Request 'POST'. Scope required: patient:search / Patient.s. $Match (Validate) with In parameter onlyCertainMatches: 1 (True) An operation to 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.v |
| SHALL | $set-preferred-name | POST, [base]/Patient/$set-preferred-name, Set the patient's preferred name, system/Patient.u |
| SHALL | $set-address | POST, [base]/Patient/$set-address,Update a patient's address, system/Patient.u |
| SHALL | $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 |
| SHALL | $remove-postal-address | POST, [base]/Patient/$remove-postal-address, Remove a patient's postal address,system/Patient.u |
| SHALL | $update-birth | POST, [base]/Patient/$update-birth, Update a patient's birth information, system/Patient.u, system/Patient.a |
| SHALL | $update-identity | POST, [base]/Patient/$update-identity, An operation to update a patient's identity details., system/Patient.u, system/Patient.a |
| SHALL | $add-name | POST, [base]/Patient/$add-name, Add a name to a patient's NHI record, system/Patient.u, system/Patient.a |
| SHALL | $replace-name | POST, [base]/Patient/$replace-name, An operation to replace a name on a patient's record, system/Patient.u, system/Patient.a |
| SHALL | $inactivate-name | POST, [base]/Patient/$inactivate-name, Inactivate a name that is currently active on a patients record ,system/Patient.u, system/Patient.a |
| SHALL | $update-eligibility | POST, [base]/Patient/$update-eligibility, Update a patient's citizenship information, system/Patient.u, system/Patient.a |
| SHALL | $create | POST, [base]/Patient/$create,Create a new patient record in the NHI, system/Patient.c, system/Patient.a |