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: https://nhi-ig.hip.digital.health.nz/OperationDefinition/update-eligibility | Version: 1.4.1 | |||
| Draft as of 2023-06-12 | Computable Name: Update Eligibility | |||
Update eligibility.
URL: [base]/Patient/[id]/$update-eligibility
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | nhi | 1..1 | string | The Patient's nhi number | ||
| IN | version-id | 1..1 | string | The current value of the patient resources meta.versionId | ||
| IN | nz-citizenship-status | 0..1 | string | NZ citizenship status | ||
| IN | nz-citizenship-source | 0..1 | string | NZ citizenship status information source | ||
| OUT | return | 0..1 | Patient | The updated patient resource | ||
| OUT | failure | 0..1 | OperationOutcome | Error response |
The NHI is validated, the versionId is validated, the parameters validated. If all request parameters are valid the included items are updated on the Patients NHI record.