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

## CapabilityStatement: NhiCapabilityStatement

Official URL: http://hl7.org.nz/fhir/ig/nhi/CapabilityStatement/NhiCapabilityStatement | Version: 1.6.5
Draft as of 2020-04-21 | Computable Name:

A FHIR API in front of the New Zealand NHI

Raw OpenAPI-Swagger Definition file | Download

##

- Implementation Guide Version: 1.6.5
- FHIR Version: 4.0.1
- Supported Formats: `json`
- Supported Patch Formats: `json`
- Published on: 2020-04-21
- Published by: Te Whatu Ora

> Note 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.

### SHALL Support the Following Implementation Guides

- http://hl7.org.nz/fhir/StructureDefinition/NHI

## FHIR RESTful Capabilities

### Mode: `server`

### Capabilities by Resource/Profile

#### Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

- The relevant profiles (if any)
- The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
- The required, recommended, and some optional search parameters (if any).
- The linked resources enabled for `_include`
- The other resources enabled for `_revinclude`
- The operations on the resource (if any)

Resource Type | Profile | R | S | U | C | Searches | `_include` | `_revinclude` | Operations
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
Patient | http://hl7.org.nz/fhir/StructureDefinition/NhiPatient | y |  |  |  |  |  |  | `$match`, `$set-preferred-name`, `$set-address`, `$set-unvalidated-address`, `$remove-postal-address`, `$update-birth`, `$update-identity`, `$add-name`, `$replace-name`, `$inactivate-name`, `$update-eligibility`, `$create`, `$add-contact`, `$replace-contact`, `$delete-contact`

#### Resource Conformance: supportedPatient

Base System Profile
NHI Patient
Profile Conformance
SHALL
Reference Policy

Interaction summary

- Supports
  `read`

  GET,[base]/Patient/[nhi-id], Retrieve a Patient resource by Id , patient:Patient.r system/Patient.r

Extended Operations

Conformance | Operation | Documentation
--- | --- | ---
SHALL | $match | POST, [base]/Patient/$match, <b>Match</b>: with In parameter <code>onlyCertainMatches=0</code> (False) the operation will search the NHI by demographics using fuzzy logic. Returns a bundle of results with match scores. <br/><b>Validate:</b> with In parameter <code>onlyCertainMatches=1</code> (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
SHALL | $set-preferred-name | POST, [base]/Patient/$set-preferred-name, Set the patient's preferred name,patient:Patient.u system/Patient.u
SHALL | $set-address | POST, [base]/Patient/$set-address,Update a patient's address, patient:Patient.u 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,patient:Patient.u system/Patient.u
SHALL | $update-birth | POST, [base]/Patient/$update-birth, Update a patient's birth information, system/Patient.u
SHALL | $update-identity | POST, [base]/Patient/$update-identity, An operation to update a patient's identity details., patient:Patient.u system/Patient.u
SHALL | $add-name | POST, [base]/Patient/$add-name, Add a name to a patient's NHI record, system/Patient.u
SHALL | $replace-name | POST, [base]/Patient/$replace-name, An operation to replace a name on a patient's record, system/Patient.u
SHALL | $inactivate-name | POST, [base]/Patient/$inactivate-name, Inactivate a name that is currently active on a patients record ,system/Patient.u
SHALL | $update-eligibility | POST, [base]/Patient/$update-eligibility, Update a patient's citizenship information, system/Patient.u
SHALL | $create | POST, [base]/Patient/$create,Create a new patient record in the NHI, system/Patient.c
SHALL | $add-contact | POST, [base]/Patient/$add-contact, add a contact to a patient's NHI record, system/Patient.u
SHALL | $replace-contact | POST, [base]/Patient/$replace-contact, replace a contact on a patient's NHI record, system/Patient.u
SHALL | $delete-contact | POST, [base]/Patient/$delete-contact, Delete a contact from a patient's NHI record, system/Patient.u