FHIR New Zealand Patient Summary IG
0.3.0 - ci-build
FHIR New Zealand Patient Summary IG
0.3.0 - ci-build
FHIR New Zealand Patient Summary IG, published by Health NZ | Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-nzps/ and changes regularly. See the Directory of published versions
| Official URL: https://standards.digital.health.nz/fhir/OperationDefinition/nzps-summary | Version: 0.3.0 | |||
| Draft as of 2024-01-01 | Computable Name: NzpsSummary | |||
The NZPS uses the $summary operation to allow clients to query by NHI number and be returned an NZPS compliant FHIR document.
The $summary operation is invoked by POST’ing a Parameters resource containing the NHI number of the patient to the $summary endpoint.
Request URL:
POST [base]/Patient/$summary
Example Parameters body:
` [example Parameters resource here] `
URL: [base]/Patient/$summary
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | identifier | 1..1 | string (token) | The NHI number of the patient for whom the summary is being requested. This should be provided with the NHI namespace (e.g. 'https://standards.digital.health.nz/ns/nhi-id|ZZZ0032) | ||
| IN | profile | 1..1 | uri | The profile for the patient summary being requested. For now, only a single profile is supported - the NZPS Bundle: https://standards.digital.health.nz/fhir/StructureDefinition/nzps-bundle | ||
| IN | graph | 0..1 | uri | Currently the NZPS summary operation does not require or support a graph definition. This parameter is included for future compatibility if needed. | ||
| OUT | return | 0..1 | Bundle | The Bundle returned is a document conforming to the specified input profile parameter or the NZPS Bundle profile (if not otherwise specified) |