New Zealand NHI IG
1.6.1 - Release

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

OperationDefinition: An operation to update a patients citizenship information

Official URL: https://nhi-ig.hip.digital.health.nz/OperationDefinition/update-eligibility Version: 1.6.1
Draft as of 2023-06-12 Computable Name: Update Eligibility

Update eligibility.

Generated Narrative: OperationDefinition Patient-update-eligibility

URL: [base]/Patient/[id]/$update-eligibility

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INnhi1..1string

The Patient's nhi number

INversion-id1..1string

The current value of the patient resources meta.versionId

INnz-citizenship-status0..1string

NZ citizenship status

INnz-citizenship-source0..1string

NZ citizenship status information source

OUTreturn0..1Patient

The updated patient resource

OUTfailure0..1OperationOutcome

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.