New Zealand NHI IG
1.5.4 - Release
New Zealand NHI IG - Local Development build (v1.5.4) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://hl7.org.nz/fhir/StructureDefinition/NhiPatient | Version: 1.5.4 | |||
Active as of 2024-06-26 | Computable Name: NhiPatient |
The Patient resource exposed by the NHI.
Describe the Patient resource exposed by the NHI
The NHI Patient resource represents the nationally held identity data for a patient.
This includes the core NHI Profile attributes:
The core NHI Profile attributes are returned to all users that have read and/or $match access to the NHI
For more information click here for website links or click here for the consumer health identity standard, that includes the check digit calculation.
The details for a patient’s General Practice (GP) are returned in the NHI Patient Profile to users who have permission to access a patient’s National Enrolment Service (NES) information.
This is an additional permission required on your NHI FHIR account.
The NES details are maintained in real time in the NES database, which holds the relationship of a Patient (NHI number), to their GP Practice (hpi-organisation-id), GP clinic (hpi-facility-id) and where available the patient’s usual doctor (hpi-person-id / CPN).
Changes to the NES in October 2023 allows a patient’s GP Practice details to be recorded for both patients that are funded and also patients who are registered with a practice but not eligible for PHO funding. This change allows the Get Patient response to return the GP Practice details for both types of patients.
The expiry date for a registered patient is set to 01/01/2100 whereas the expiry date for an enrolled patient is never more than 3 years in the future.
For more information on what is available in the NES FHIR API please see NES UAT Implementation guide.
In the NHI the patient’s GP is only returned with a read on the resource. It is not returned in the $match response – even if a user has the correct permissions.
The patient version-id does not change when the GP changes. This is because the patient’s GP is not held in the NHI but is retrieved from the National Enrolment Service and returned along with the NHI details in the NHI Patient profile. The patient version-id only reflects changes to details held on the NHI.
For information on enrolment history, re-enrolment dates, enrolment status, or the last visit date (qualified encounter date) please subscribe to the NES.
A subset of the NES enrolment information is returned in the NHI FHIR GET response.
Enrolment information is returned in two places in the NHI patient profile:
FHIR attribute (PractitionerRole Resource) | NES Enrolment Information | Description |
---|---|---|
id | The NES enrolment id | Unique identifier of the patient's enrolment record. This will change when a patient transfers to a new practice, but will not reflect minor changes within an enrolment. |
Period.start | enrolment.startDate | The date on which the Enrolment starts |
Period.end | enrolment.expiryDate | The future date on which the Enrolment will expire. |
Practitioner (reference / display) | Practitioner identifier (CPN) and name | The hpi-person-id (CPN) and name of the Practitioner who primarily provides the service to the person. |
Organization (reference / display) | enrolling organisation ID and name | The hpi-organisation-id and name of the Organisation who the person enrols with for the Heath Service. |
Location (reference / display) | Facility ID and name | The hpi-facility-id and name of the Facility where the person primarily receives the service. |
"contained": [
{
"resourceType": "PractitionerRole",
"id": "525599",
"period": {
"start": "2023-01-26T00:00:00+13:00",
"end": "2026-01-26T00:00:00+13:00"
},
"practitioner": {
"reference": "Practitioner/25ADNX",
"display": "Dr Nick"
},
"organization": {
"reference": "Organization/GAAAAA-0"
"display": "Riviera Health Care"
},
"location": [
{
"reference": "Location/FZZ862-H",
"display": "Dr Nick's Guaranteed Health Clinic"
}
]
}
]
The patient’s contact details are returned in the Patient.telecom attribute to users who have permission to access Patient Preferences. This is an additional permission required on your NHI FHIR account.
The contact details are only returned with a read on the resource. They are not returned in the $match response – even if a user has the correct permissions.
The patient version-id does not change when the patient’s contact details change. This is because the patient’s contact details are not held in the NHI but are retrieved from the National Enrolment Service and returned along with the NHI details in the NHI Patient profile. The Patient Version-id only reflects changes to details held on the NHI.
The information returned may include:
"telecom": [
{
"system": "email",
"value": "test.contact@testContact.com",
"use": "home"
},
{
"system": "phone",
"value": "0275151510",
"use": "mobile"
},
{
"system": "phone",
"value": "045882334",
"use": "home"
}
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NzPatient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services nhi-nz-pat-1: only allows certain name name use values |
Slices for contained | 0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
contained:GP | 0..1 | PractitionerRole | Contained resource for the Patient's enrolled general Practitioner | |
Slices for extension | Content/Rules for all slices | |||
extension:ethnicity | 0..6 | Nz_ethnicity | NZ Ethnicity | |
Slices for value[x] | Content/Rules for all slices | |||
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Hip_ethnicity_lvl_4 (2.0) (required) | |
extension:nzCitizen | 0..1 | Nz_citizenship | This field indicates New Zealand citizenship status of the patient | |
Slices for extension | Content/Rules for all slices | |||
extension:source | 0..1 | Extension | Extension | |
Slices for value[x] | Content/Rules for all slices | |||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship Information Source (required) | |
extension:domicile-code | 0..0 | |||
extension:pho | 0..0 | |||
extension:sex-at-birth | 0..0 | |||
extension:iwi | 0..0 | |||
birthPlace | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place | |
Slices for identifier | 0..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system | |
identifier:All Slices | Content/Rules for all slices | |||
type | 0..0 | |||
period | 0..0 | |||
identifier:NHI | 0..* | Identifier | An identifier for this patient | |
type | 0..0 | |||
period | 0..0 | |||
active | 0..0 | |||
name | ||||
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
information-source | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
Slices for value[x] | Content/Rules for all slices | |||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Name Information Source (required) | |
preferred | 1..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred | |
nhi-name-use-extra | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/name-use-extra Binding: NHI Name Use Extra (required) | |
use | 0..1 | code | temp | nickname | maiden | |
text | 0..0 | |||
given | 0..2 | string | Given name and other given name(s) | |
prefix | 0..* | string | Parts that come before the name Binding: Name Prefix Codes (required) | |
suffix | 0..0 | |||
period | 0..0 | |||
telecom | 0..3 | NzContactPoint | The Paient's contact details | |
Slices for extension | Content/Rules for all slices | |||
extension:cp-purpose | 0..0 | |||
system | 0..1 | code | phone | email Binding: NHI ContactPoint System Codes (required) | |
use | 0..1 | code | home | mobile Binding: NHI ContactPoint Use Codes (required) | |
rank | 0..0 | |||
period | 0..0 | |||
gender | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
originalText | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text | |
birthDate | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
information-source | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
Slices for value[x] | Content/Rules for all slices | |||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Date of Birth Information Source (required) | |
deceased[x] | 0..1 | dateTime | Indicates if the individual is deceased or not | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
information-source | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
Slices for value[x] | Content/Rules for all slices | |||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Date of Death Information Source (required) | |
address | 0..* | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
line | 1..* | string | Street name, number, direction & P.O. Box etc. | |
maritalStatus | 0..0 | |||
multipleBirth[x] | 0..0 | |||
photo | 0..0 | |||
contact | 0..0 | |||
communication | 0..0 | |||
generalPractitioner | 0..1 | Reference(PractitionerRole) | Reference for the Patient's enrolled general Practitioner | |
managingOrganization | 0..0 | |||
link | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Patient.extension:ethnicity.value[x]:valueCodeableConcept | required | Hip_ethnicity_lvl_4https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code|2.0 | |
Patient.extension:nzCitizen.extension:source.value[x]:valueCodeableConcept | required | Nhi_citizenship_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-source-code | |
Patient.name.extension:information-source.value[x]:valueCodeableConcept | required | Nhi_name_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/name-source-code | |
Patient.name.prefix | required | Hpi_name_prefixhttps://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code | |
Patient.telecom.system | required | NhiContactPointSystemhttps://nzhts.digital.health.nz/fhir/ValueSet/nhi-contact-point-system-code from this IG | |
Patient.telecom.use | required | NhiContactPointUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhiContactUseType from this IG | |
Patient.birthDate.extension:information-source.value[x]:valueCodeableConcept | required | Nhi_date_of_birth_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/date-of-birth-source-code | |
Patient.deceased[x].extension:information-source.value[x]:valueCodeableConcept | required | Nhi_date_of_death_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code |
Id | Grade | Path(s) | Details | Requirements |
nhi-nz-pat-1 | error | Patient | only allows certain name name use values : Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') ) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services nz-pat-1: only a single official NHI nhi-nz-pat-1: only allows certain name name use values |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for contained | 0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
contained:GP | 0..1 | PractitionerRole | Contained resource for the Patient's enrolled general Practitioner | |
Slices for extension | Content/Rules for all slices | |||
ethnicity | 0..6 | (Complex) | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity" | |
Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Hip_ethnicity_lvl_4 (2.0) (required) | |
nzCitizen | 0..1 | (Complex) | This field indicates New Zealand citizenship status of the patient URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship | |
Slices for extension | Content/Rules for all slices | |||
extension:status | 0..1 | Extension | Extension | |
extension | 0..0 | |||
url | 1..1 | uri | "status" | |
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship status (preferred) | |
extension:source | 0..1 | Extension | Extension | |
extension | 0..0 | |||
url | 1..1 | uri | "source" | |
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship Information Source (required) | |
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship" | |
dhb | 0..1 | CodeableConcept | District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs | |
birthPlace | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system |
identifier:All Slices | Content/Rules for all slices | |||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
identifier:NHI | Σ | 0..* | Identifier | An identifier for this patient |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required) |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id |
telecom | C | 0..3 | NzContactPoint | The Paient's contact details cpt-2: A system is required if a value is provided. |
Slices for extension | Content/Rules for all slices | |||
system | ΣC | 0..1 | code | phone | email Binding: NHI ContactPoint System Codes (required) |
use | ?!Σ | 0..1 | code | home | mobile Binding: NHI ContactPoint Use Codes (required) |
deceased[x] | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
information-source | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Date of Death Information Source (required) | |
address | 0..* | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
Slices for extension | Content/Rules for all slices | |||
nz-geocode | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode | |
suburb | 0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb | |
building-name | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name | |
domicile-code | 0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred) | |
notValidatedAddressReason | 0..1 | CodeableConcept | The reason an address was not validated URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason Binding: Address Not Validated Reason (preferred) | |
nz-address-id | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id | |
nz-address-derived | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required) Example General: home |
type | Σ | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required) Example General: both |
line | Σ | 1..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
generalPractitioner | 0..1 | Reference(PractitionerRole) | Reference for the Patient's enrolled general Practitioner | |
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Patient.extension:ethnicity.value[x]:valueCodeableConcept | required | Hip_ethnicity_lvl_4https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code|2.0 | ||||
Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept | preferred | CitizenshipStatushttps://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code | ||||
Patient.extension:nzCitizen.extension:source.value[x]:valueCodeableConcept | required | Nhi_citizenship_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-source-code | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:NHI.use | required | NHIUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code | ||||
Patient.telecom.system | required | NhiContactPointSystemhttps://nzhts.digital.health.nz/fhir/ValueSet/nhi-contact-point-system-code from this IG | ||||
Patient.telecom.use | required | NhiContactPointUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhiContactUseType from this IG | ||||
Patient.deceased[x].extension:information-source.value[x]:valueCodeableConcept | required | Nhi_date_of_death_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code | ||||
Patient.address.use | required | NhiAddressUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhiaddressUse | ||||
Patient.address.type | required | NhiAddressTypehttps://nzhts.digital.health.nz/fhir/ValueSet/addressType | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
nhi-nz-pat-1 | error | Patient | only allows certain name name use values : Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') ) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services nz-pat-1: only a single official NHI nhi-nz-pat-1: only allows certain name name use values | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
Slices for contained | 0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |||||
contained:GP | 0..1 | PractitionerRole | Contained resource for the Patient's enrolled general Practitioner | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
ethnicity | 0..6 | (Complex) | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity" | |||||
Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Hip_ethnicity_lvl_4 (2.0) (required) | |||||
nzCitizen | 0..1 | (Complex) | This field indicates New Zealand citizenship status of the patient URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
extension:status | 0..1 | Extension | Extension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "status" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship status (preferred) | |||||
extension:source | 0..1 | Extension | Extension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "source" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship Information Source (required) | |||||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship" | |||||
dhb | 0..1 | CodeableConcept | District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs | |||||
birthPlace | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:NHI | Σ | 0..* | Identifier | An identifier for this patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required) | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
name | Σ | 0..* | HumanName | A name associated with the patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
information-source | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Name Information Source (required) | |||||
preferred | 1..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred | |||||
nhi-name-use-extra | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/name-use-extra Binding: NHI Name Use Extra (required) | |||||
use | ?!Σ | 0..1 | code | temp | nickname | maiden Binding: NameUse (required): The use of a human name. | ||||
family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
given | Σ | 0..2 | string | Given name and other given name(s) This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name Binding: Name Prefix Codes (required) This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
telecom | C | 0..3 | NzContactPoint | The Paient's contact details cpt-2: A system is required if a value is provided. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 0..1 | code | phone | email Binding: NHI ContactPoint System Codes (required) | ||||
value | Σ | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | mobile Binding: NHI ContactPoint Use Codes (required) | ||||
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
originalText | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text | |||||
value | 0..1 | string | Primitive value for code | |||||
birthDate | Σ | 0..1 | date | The date of birth for the individual | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
information-source | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Date of Birth Information Source (required) | |||||
value | 0..1 | date | Primitive value for date | |||||
deceased[x] | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
information-source | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Date of Death Information Source (required) | |||||
value | 0..1 | dateTime | Primitive value for dateTime | |||||
address | 0..* | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
nz-geocode | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode | |||||
suburb | 0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb | |||||
building-name | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name | |||||
domicile-code | 0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred) | |||||
notValidatedAddressReason | 0..1 | CodeableConcept | The reason an address was not validated URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason Binding: Address Not Validated Reason (preferred) | |||||
nz-address-id | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id | |||||
nz-address-derived | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required) Example General: home | ||||
type | Σ | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required) Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | Σ | 1..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: ISO 3166-1:2013 (2-alpha country code) (required) | ||||
generalPractitioner | 0..1 | Reference(PractitionerRole) | Reference for the Patient's enrolled general Practitioner | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.extension:ethnicity.value[x]:valueCodeableConcept | required | Hip_ethnicity_lvl_4https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code|2.0 | ||||
Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept | preferred | CitizenshipStatushttps://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code | ||||
Patient.extension:nzCitizen.extension:source.value[x]:valueCodeableConcept | required | Nhi_citizenship_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-source-code | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:NHI.use | required | NHIUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code | ||||
Patient.name.extension:information-source.value[x]:valueCodeableConcept | required | Nhi_name_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/name-source-code | ||||
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.name.prefix | required | Hpi_name_prefixhttps://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code | ||||
Patient.telecom.system | required | NhiContactPointSystemhttps://nzhts.digital.health.nz/fhir/ValueSet/nhi-contact-point-system-code from this IG | ||||
Patient.telecom.use | required | NhiContactPointUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhiContactUseType from this IG | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.birthDate.extension:information-source.value[x]:valueCodeableConcept | required | Nhi_date_of_birth_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/date-of-birth-source-code | ||||
Patient.deceased[x].extension:information-source.value[x]:valueCodeableConcept | required | Nhi_date_of_death_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code | ||||
Patient.address.use | required | NhiAddressUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhiaddressUse | ||||
Patient.address.type | required | NhiAddressTypehttps://nzhts.digital.health.nz/fhir/ValueSet/addressType | ||||
Patient.address.country | required | Hpi_country_code_iso_3166_1https://nzhts.digital.health.nz/fhir/ValueSet/country-code | ||||
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
nhi-nz-pat-1 | error | Patient | only allows certain name name use values : Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') ) |
This structure is derived from NzPatient
Differential View
This structure is derived from NzPatient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services nhi-nz-pat-1: only allows certain name name use values |
Slices for contained | 0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
contained:GP | 0..1 | PractitionerRole | Contained resource for the Patient's enrolled general Practitioner | |
Slices for extension | Content/Rules for all slices | |||
extension:ethnicity | 0..6 | Nz_ethnicity | NZ Ethnicity | |
Slices for value[x] | Content/Rules for all slices | |||
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Hip_ethnicity_lvl_4 (2.0) (required) | |
extension:nzCitizen | 0..1 | Nz_citizenship | This field indicates New Zealand citizenship status of the patient | |
Slices for extension | Content/Rules for all slices | |||
extension:source | 0..1 | Extension | Extension | |
Slices for value[x] | Content/Rules for all slices | |||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship Information Source (required) | |
extension:domicile-code | 0..0 | |||
extension:pho | 0..0 | |||
extension:sex-at-birth | 0..0 | |||
extension:iwi | 0..0 | |||
birthPlace | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place | |
Slices for identifier | 0..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system | |
identifier:All Slices | Content/Rules for all slices | |||
type | 0..0 | |||
period | 0..0 | |||
identifier:NHI | 0..* | Identifier | An identifier for this patient | |
type | 0..0 | |||
period | 0..0 | |||
active | 0..0 | |||
name | ||||
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
information-source | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
Slices for value[x] | Content/Rules for all slices | |||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Name Information Source (required) | |
preferred | 1..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred | |
nhi-name-use-extra | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/name-use-extra Binding: NHI Name Use Extra (required) | |
use | 0..1 | code | temp | nickname | maiden | |
text | 0..0 | |||
given | 0..2 | string | Given name and other given name(s) | |
prefix | 0..* | string | Parts that come before the name Binding: Name Prefix Codes (required) | |
suffix | 0..0 | |||
period | 0..0 | |||
telecom | 0..3 | NzContactPoint | The Paient's contact details | |
Slices for extension | Content/Rules for all slices | |||
extension:cp-purpose | 0..0 | |||
system | 0..1 | code | phone | email Binding: NHI ContactPoint System Codes (required) | |
use | 0..1 | code | home | mobile Binding: NHI ContactPoint Use Codes (required) | |
rank | 0..0 | |||
period | 0..0 | |||
gender | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
originalText | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text | |
birthDate | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
information-source | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
Slices for value[x] | Content/Rules for all slices | |||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Date of Birth Information Source (required) | |
deceased[x] | 0..1 | dateTime | Indicates if the individual is deceased or not | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
information-source | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
Slices for value[x] | Content/Rules for all slices | |||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Date of Death Information Source (required) | |
address | 0..* | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
line | 1..* | string | Street name, number, direction & P.O. Box etc. | |
maritalStatus | 0..0 | |||
multipleBirth[x] | 0..0 | |||
photo | 0..0 | |||
contact | 0..0 | |||
communication | 0..0 | |||
generalPractitioner | 0..1 | Reference(PractitionerRole) | Reference for the Patient's enrolled general Practitioner | |
managingOrganization | 0..0 | |||
link | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Patient.extension:ethnicity.value[x]:valueCodeableConcept | required | Hip_ethnicity_lvl_4https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code|2.0 | |
Patient.extension:nzCitizen.extension:source.value[x]:valueCodeableConcept | required | Nhi_citizenship_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-source-code | |
Patient.name.extension:information-source.value[x]:valueCodeableConcept | required | Nhi_name_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/name-source-code | |
Patient.name.prefix | required | Hpi_name_prefixhttps://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code | |
Patient.telecom.system | required | NhiContactPointSystemhttps://nzhts.digital.health.nz/fhir/ValueSet/nhi-contact-point-system-code from this IG | |
Patient.telecom.use | required | NhiContactPointUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhiContactUseType from this IG | |
Patient.birthDate.extension:information-source.value[x]:valueCodeableConcept | required | Nhi_date_of_birth_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/date-of-birth-source-code | |
Patient.deceased[x].extension:information-source.value[x]:valueCodeableConcept | required | Nhi_date_of_death_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code |
Id | Grade | Path(s) | Details | Requirements |
nhi-nz-pat-1 | error | Patient | only allows certain name name use values : Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') ) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services nz-pat-1: only a single official NHI nhi-nz-pat-1: only allows certain name name use values |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for contained | 0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
contained:GP | 0..1 | PractitionerRole | Contained resource for the Patient's enrolled general Practitioner | |
Slices for extension | Content/Rules for all slices | |||
ethnicity | 0..6 | (Complex) | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity" | |
Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Hip_ethnicity_lvl_4 (2.0) (required) | |
nzCitizen | 0..1 | (Complex) | This field indicates New Zealand citizenship status of the patient URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship | |
Slices for extension | Content/Rules for all slices | |||
extension:status | 0..1 | Extension | Extension | |
extension | 0..0 | |||
url | 1..1 | uri | "status" | |
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship status (preferred) | |
extension:source | 0..1 | Extension | Extension | |
extension | 0..0 | |||
url | 1..1 | uri | "source" | |
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship Information Source (required) | |
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship" | |
dhb | 0..1 | CodeableConcept | District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs | |
birthPlace | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system |
identifier:All Slices | Content/Rules for all slices | |||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
identifier:NHI | Σ | 0..* | Identifier | An identifier for this patient |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required) |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id |
telecom | C | 0..3 | NzContactPoint | The Paient's contact details cpt-2: A system is required if a value is provided. |
Slices for extension | Content/Rules for all slices | |||
system | ΣC | 0..1 | code | phone | email Binding: NHI ContactPoint System Codes (required) |
use | ?!Σ | 0..1 | code | home | mobile Binding: NHI ContactPoint Use Codes (required) |
deceased[x] | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
information-source | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Date of Death Information Source (required) | |
address | 0..* | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
Slices for extension | Content/Rules for all slices | |||
nz-geocode | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode | |
suburb | 0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb | |
building-name | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name | |
domicile-code | 0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred) | |
notValidatedAddressReason | 0..1 | CodeableConcept | The reason an address was not validated URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason Binding: Address Not Validated Reason (preferred) | |
nz-address-id | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id | |
nz-address-derived | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required) Example General: home |
type | Σ | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required) Example General: both |
line | Σ | 1..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
generalPractitioner | 0..1 | Reference(PractitionerRole) | Reference for the Patient's enrolled general Practitioner | |
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Patient.extension:ethnicity.value[x]:valueCodeableConcept | required | Hip_ethnicity_lvl_4https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code|2.0 | ||||
Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept | preferred | CitizenshipStatushttps://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code | ||||
Patient.extension:nzCitizen.extension:source.value[x]:valueCodeableConcept | required | Nhi_citizenship_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-source-code | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:NHI.use | required | NHIUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code | ||||
Patient.telecom.system | required | NhiContactPointSystemhttps://nzhts.digital.health.nz/fhir/ValueSet/nhi-contact-point-system-code from this IG | ||||
Patient.telecom.use | required | NhiContactPointUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhiContactUseType from this IG | ||||
Patient.deceased[x].extension:information-source.value[x]:valueCodeableConcept | required | Nhi_date_of_death_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code | ||||
Patient.address.use | required | NhiAddressUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhiaddressUse | ||||
Patient.address.type | required | NhiAddressTypehttps://nzhts.digital.health.nz/fhir/ValueSet/addressType | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
nhi-nz-pat-1 | error | Patient | only allows certain name name use values : Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') ) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services nz-pat-1: only a single official NHI nhi-nz-pat-1: only allows certain name name use values | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
Slices for contained | 0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |||||
contained:GP | 0..1 | PractitionerRole | Contained resource for the Patient's enrolled general Practitioner | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
ethnicity | 0..6 | (Complex) | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity" | |||||
Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Hip_ethnicity_lvl_4 (2.0) (required) | |||||
nzCitizen | 0..1 | (Complex) | This field indicates New Zealand citizenship status of the patient URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
extension:status | 0..1 | Extension | Extension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "status" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship status (preferred) | |||||
extension:source | 0..1 | Extension | Extension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "source" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship Information Source (required) | |||||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship" | |||||
dhb | 0..1 | CodeableConcept | District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs | |||||
birthPlace | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:NHI | Σ | 0..* | Identifier | An identifier for this patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required) | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
name | Σ | 0..* | HumanName | A name associated with the patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
information-source | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Name Information Source (required) | |||||
preferred | 1..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred | |||||
nhi-name-use-extra | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/name-use-extra Binding: NHI Name Use Extra (required) | |||||
use | ?!Σ | 0..1 | code | temp | nickname | maiden Binding: NameUse (required): The use of a human name. | ||||
family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
given | Σ | 0..2 | string | Given name and other given name(s) This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name Binding: Name Prefix Codes (required) This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
telecom | C | 0..3 | NzContactPoint | The Paient's contact details cpt-2: A system is required if a value is provided. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 0..1 | code | phone | email Binding: NHI ContactPoint System Codes (required) | ||||
value | Σ | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | mobile Binding: NHI ContactPoint Use Codes (required) | ||||
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
originalText | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text | |||||
value | 0..1 | string | Primitive value for code | |||||
birthDate | Σ | 0..1 | date | The date of birth for the individual | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
information-source | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Date of Birth Information Source (required) | |||||
value | 0..1 | date | Primitive value for date | |||||
deceased[x] | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
information-source | 0..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Date of Death Information Source (required) | |||||
value | 0..1 | dateTime | Primitive value for dateTime | |||||
address | 0..* | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
nz-geocode | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode | |||||
suburb | 0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb | |||||
building-name | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name | |||||
domicile-code | 0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred) | |||||
notValidatedAddressReason | 0..1 | CodeableConcept | The reason an address was not validated URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason Binding: Address Not Validated Reason (preferred) | |||||
nz-address-id | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id | |||||
nz-address-derived | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required) Example General: home | ||||
type | Σ | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required) Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | Σ | 1..* | string |