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/CreateNhiPatient | Version: 1.5.4 | |||
Active as of 2024-06-26 | Computable Name: CreateNhiPatient |
The information to be supplied when requesting that a new Patient resource be created in the NHI.
Describe information to be supplied when requesting that a new Patient resource be created in the NHI
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NhiPatient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | NhiPatient | Information about an individual or animal receiving health care services EM02106: A Patient must have an active Preferred Name EM02201: A Patient must have a primary residential address EM02101: A Patient name must contain either a given or family name EM07225: If name-use-extra is supplied name-use must be temp, and source NPRF EM07212: birthdate must be after 1 January 1900, and not a future date EM07212-1: Date of Death cannot be a future date EM07215: Date of Death must be greater than, or equal to Date of Birth |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
2..* | Extension | Extension | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
1..6 | Nz_ethnicity | NZ Ethnicity | |
![]() ![]() ![]() ![]() |
1..1 | Nz_citizenship | NZ Citizenship | |
![]() ![]() ![]() ![]() ![]() |
2..* | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..1 | BirthPlace | Extension | |
![]() ![]() ![]() ![]() ![]() |
2..* | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
C | 1..1 | HumanName | A name associated with the patient EM07225: If name-use-extra is supplied name-use must be temp, and source NPRF |
![]() ![]() ![]() ![]() |
2..* | Extension | Extension | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | Information_source | Information Source | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() |
0..1 | string | Parts that come before the name | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | code | male | female | other | unknown | |
![]() ![]() ![]() |
1..1 | date | The date of birth for the individual | |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | Information_source | Information Source | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | Information_source | Information Source | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() |
1..1 | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
![]() ![]() ![]() ![]() |
1..1 | code | home | work | temp | old | billing - purpose of this address | |
![]() ![]() ![]() ![]() |
1..2 | string | Street name, number, direction & P.O. Box etc. | |
![]() ![]() ![]() |
0..0 | |||
![]() |
Id | Grade | Path(s) | Details | Requirements |
EM02101 | error | Patient | A Patient name must contain either a given or family name : Patient.name.all(given.exists() and family.exists()) | |
EM02106 | error | Patient | A Patient must have an active Preferred Name : Patient.name.extension.where((url = 'http://hl7.org/fhir/StructureDefinition/iso21090-preferred') and (valueBoolean=true)).count()=1 | |
EM02201 | error | Patient | A Patient must have a primary residential address : Patient.address.where( (use = 'home') and (type = 'physical')).count()=1 | |
EM07212 | error | Patient | birthdate must be after 1 January 1900, and not a future date : (birthDate > @1900-01-01) and (birthDate < now()) | |
EM07212-1 | error | Patient | Date of Death cannot be a future date : deceasedDateTime < now() | |
EM07215 | error | Patient | Date of Death must be greater than, or equal to Date of Birth : deceasedDateTime >= birthDate | |
EM07225 | error | Patient, Patient.name | If name-use-extra is supplied name-use must be temp, and source NPRF : name.where(use='temp').exists() implies (extension.where((url='http://hl7.org.nz/fhir/StructureDefinition/information-source') and (valueCodeableConcept.coding.code ='NPRF')).exists()) |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | NhiPatient | 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 EM02106: A Patient must have an active Preferred Name EM02201: A Patient must have a primary residential address EM02101: A Patient name must contain either a given or family name EM07225: If name-use-extra is supplied name-use must be temp, and source NPRF EM07212: birthdate must be after 1 January 1900, and not a future date EM07212-1: Date of Death cannot be a future date EM07215: Date of Death must be greater than, or equal to Date of Birth |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
1..6 | (Complex) | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Hip_ethnicity_lvl_4 (2.0) (required) | |
![]() ![]() ![]() ![]() |
1..1 | (Complex) | NZ Citizenship URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship | |
![]() ![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "status" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: NZ Citizenship status (preferred) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "source" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: NZ Citizenship Information Source (required) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship" | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place | |
![]() ![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "country" | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "place-of-birth" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "source" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Country of Birth Information Source (required) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/birth-place" | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system |
![]() ![]() ![]() |
ΣC | 1..1 | HumanName | A name associated with the patient EM07225: If name-use-extra is supplied name-use must be temp, and source NPRF |
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Name Information Source (required) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/name-use-extra Binding: NHI Name Use Extra (required) | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | temp | nickname | maiden Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | 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 |
![]() ![]() ![]() |
Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text | |
![]() ![]() ![]() |
Σ | 1..1 | date | The date of birth for the individual |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Date of Birth Information Source (required) | |
![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Date of Death Information Source (required) | |
![]() ![]() ![]() |
1..1 | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred) | |
![]() ![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived | |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required) Example General: home |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required) Example General: both |
![]() ![]() ![]() ![]() |
Σ | 1..2 | 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 |
![]() |
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.extension:birthPlace.extension:source.value[x] | required | Nhi_country_of_birth_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/country-of-birth-source-code | ||||
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.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.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 |
EM02101 | error | Patient | A Patient name must contain either a given or family name : Patient.name.all(given.exists() and family.exists()) | |
EM02106 | error | Patient | A Patient must have an active Preferred Name : Patient.name.extension.where((url = 'http://hl7.org/fhir/StructureDefinition/iso21090-preferred') and (valueBoolean=true)).count()=1 | |
EM02201 | error | Patient | A Patient must have a primary residential address : Patient.address.where( (use = 'home') and (type = 'physical')).count()=1 | |
EM07212 | error | Patient | birthdate must be after 1 January 1900, and not a future date : (birthDate > @1900-01-01) and (birthDate < now()) | |
EM07212-1 | error | Patient | Date of Death cannot be a future date : deceasedDateTime < now() | |
EM07215 | error | Patient | Date of Death must be greater than, or equal to Date of Birth : deceasedDateTime >= birthDate | |
EM07225 | error | Patient, Patient.name | If name-use-extra is supplied name-use must be temp, and source NPRF : name.where(use='temp').exists() implies (extension.where((url='http://hl7.org.nz/fhir/StructureDefinition/information-source') and (valueCodeableConcept.coding.code ='NPRF')).exists()) |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | NhiPatient | 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 EM02106: A Patient must have an active Preferred Name EM02201: A Patient must have a primary residential address EM02101: A Patient name must contain either a given or family name EM07225: If name-use-extra is supplied name-use must be temp, and source NPRF EM07212: birthdate must be after 1 January 1900, and not a future date EM07212-1: Date of Death cannot be a future date EM07215: Date of Death must be greater than, or equal to Date of Birth |
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
1..6 | (Complex) | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Hip_ethnicity_lvl_4 (2.0) (required) | |
![]() ![]() ![]() ![]() |
1..1 | (Complex) | NZ Citizenship URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "status" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: NZ Citizenship status (preferred) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "source" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: NZ Citizenship Information Source (required) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship" | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "country" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: ISO 3166-1:2013 (2-alpha country code) (required) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "place-of-birth" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "source" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Country of Birth Information Source (required) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/birth-place" | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system |
![]() ![]() ![]() |
ΣC | 1..1 | HumanName | A name associated with the patient EM07225: If name-use-extra is supplied name-use must be temp, and source NPRF |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Name Information Source (required) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/name-use-extra Binding: NHI Name Use Extra (required) | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | temp | nickname | maiden Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | 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 |
![]() ![]() ![]() |
Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text | |
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for code | |
![]() ![]() ![]() |
Σ | 1..1 | date | The date of birth for the individual |
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Date of Birth Information Source (required) | |
![]() ![]() ![]() ![]() |
0..1 | date | Primitive value for date | |
![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not |
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Date of Death Information Source (required) | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | Primitive value for dateTime | |
![]() ![]() ![]() |
1..1 | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred) | |
![]() ![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived | |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required) Example General: home |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required) Example General: both |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() ![]() |
Σ | 1..2 | 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 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Postal code for area Example General: 9132 |
![]() ![]() ![]() ![]() |
Σ | 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) |
![]() |
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.extension:birthPlace.extension:country.value[x] | required | Hpi_country_code_iso_3166_1https://nzhts.digital.health.nz/fhir/ValueSet/country-code | ||||
Patient.extension:birthPlace.extension:source.value[x] | required | Nhi_country_of_birth_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/country-of-birth-source-code | ||||
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 |
EM02101 | error | Patient | A Patient name must contain either a given or family name : Patient.name.all(given.exists() and family.exists()) | |
EM02106 | error | Patient | A Patient must have an active Preferred Name : Patient.name.extension.where((url = 'http://hl7.org/fhir/StructureDefinition/iso21090-preferred') and (valueBoolean=true)).count()=1 | |
EM02201 | error | Patient | A Patient must have a primary residential address : Patient.address.where( (use = 'home') and (type = 'physical')).count()=1 | |
EM07212 | error | Patient | birthdate must be after 1 January 1900, and not a future date : (birthDate > @1900-01-01) and (birthDate < now()) | |
EM07212-1 | error | Patient | Date of Death cannot be a future date : deceasedDateTime < now() | |
EM07215 | error | Patient | Date of Death must be greater than, or equal to Date of Birth : deceasedDateTime >= birthDate | |
EM07225 | error | Patient, Patient.name | If name-use-extra is supplied name-use must be temp, and source NPRF : name.where(use='temp').exists() implies (extension.where((url='http://hl7.org.nz/fhir/StructureDefinition/information-source') and (valueCodeableConcept.coding.code ='NPRF')).exists()) |
This structure is derived from NhiPatient
Differential View
This structure is derived from NhiPatient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | NhiPatient | Information about an individual or animal receiving health care services EM02106: A Patient must have an active Preferred Name EM02201: A Patient must have a primary residential address EM02101: A Patient name must contain either a given or family name EM07225: If name-use-extra is supplied name-use must be temp, and source NPRF EM07212: birthdate must be after 1 January 1900, and not a future date EM07212-1: Date of Death cannot be a future date EM07215: Date of Death must be greater than, or equal to Date of Birth |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
2..* | Extension | Extension | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
1..6 | Nz_ethnicity | NZ Ethnicity | |
![]() ![]() ![]() ![]() |
1..1 | Nz_citizenship | NZ Citizenship | |
![]() ![]() ![]() ![]() ![]() |
2..* | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..1 | BirthPlace | Extension | |
![]() ![]() ![]() ![]() ![]() |
2..* | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
C | 1..1 | HumanName | A name associated with the patient EM07225: If name-use-extra is supplied name-use must be temp, and source NPRF |
![]() ![]() ![]() ![]() |
2..* | Extension | Extension | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | Information_source | Information Source | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() |
0..1 | string | Parts that come before the name | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | code | male | female | other | unknown | |
![]() ![]() ![]() |
1..1 | date | The date of birth for the individual | |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | Information_source | Information Source | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | Information_source | Information Source | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() |
1..1 | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
![]() ![]() ![]() ![]() |
1..1 | code | home | work | temp | old | billing - purpose of this address | |
![]() ![]() ![]() ![]() |
1..2 | string | Street name, number, direction & P.O. Box etc. | |
![]() ![]() ![]() |
0..0 | |||
![]() |
Id | Grade | Path(s) | Details | Requirements |
EM02101 | error | Patient | A Patient name must contain either a given or family name : Patient.name.all(given.exists() and family.exists()) | |
EM02106 | error | Patient | A Patient must have an active Preferred Name : Patient.name.extension.where((url = 'http://hl7.org/fhir/StructureDefinition/iso21090-preferred') and (valueBoolean=true)).count()=1 | |
EM02201 | error | Patient | A Patient must have a primary residential address : Patient.address.where( (use = 'home') and (type = 'physical')).count()=1 | |
EM07212 | error | Patient | birthdate must be after 1 January 1900, and not a future date : (birthDate > @1900-01-01) and (birthDate < now()) | |
EM07212-1 | error | Patient | Date of Death cannot be a future date : deceasedDateTime < now() | |
EM07215 | error | Patient | Date of Death must be greater than, or equal to Date of Birth : deceasedDateTime >= birthDate | |
EM07225 | error | Patient, Patient.name | If name-use-extra is supplied name-use must be temp, and source NPRF : name.where(use='temp').exists() implies (extension.where((url='http://hl7.org.nz/fhir/StructureDefinition/information-source') and (valueCodeableConcept.coding.code ='NPRF')).exists()) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | NhiPatient | 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 EM02106: A Patient must have an active Preferred Name EM02201: A Patient must have a primary residential address EM02101: A Patient name must contain either a given or family name EM07225: If name-use-extra is supplied name-use must be temp, and source NPRF EM07212: birthdate must be after 1 January 1900, and not a future date EM07212-1: Date of Death cannot be a future date EM07215: Date of Death must be greater than, or equal to Date of Birth |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
1..6 | (Complex) | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Hip_ethnicity_lvl_4 (2.0) (required) | |
![]() ![]() ![]() ![]() |
1..1 | (Complex) | NZ Citizenship URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship | |
![]() ![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "status" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: NZ Citizenship status (preferred) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "source" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: NZ Citizenship Information Source (required) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship" | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place | |
![]() ![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "country" | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "place-of-birth" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "source" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Country of Birth Information Source (required) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/birth-place" | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system |
![]() ![]() ![]() |
ΣC | 1..1 | HumanName | A name associated with the patient EM07225: If name-use-extra is supplied name-use must be temp, and source NPRF |
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Name Information Source (required) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/name-use-extra Binding: NHI Name Use Extra (required) | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | temp | nickname | maiden Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | 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 |
![]() ![]() ![]() |
Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text | |
![]() ![]() ![]() |
Σ | 1..1 | date | The date of birth for the individual |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Date of Birth Information Source (required) | |
![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Date of Death Information Source (required) | |
![]() ![]() ![]() |
1..1 | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred) | |
![]() ![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived | |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required) Example General: home |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required) Example General: both |
![]() ![]() ![]() ![]() |
Σ | 1..2 | 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 |
![]() |
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.extension:birthPlace.extension:source.value[x] | required | Nhi_country_of_birth_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/country-of-birth-source-code | ||||
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.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.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 |
EM02101 | error | Patient | A Patient name must contain either a given or family name : Patient.name.all(given.exists() and family.exists()) | |
EM02106 | error | Patient | A Patient must have an active Preferred Name : Patient.name.extension.where((url = 'http://hl7.org/fhir/StructureDefinition/iso21090-preferred') and (valueBoolean=true)).count()=1 | |
EM02201 | error | Patient | A Patient must have a primary residential address : Patient.address.where( (use = 'home') and (type = 'physical')).count()=1 | |
EM07212 | error | Patient | birthdate must be after 1 January 1900, and not a future date : (birthDate > @1900-01-01) and (birthDate < now()) | |
EM07212-1 | error | Patient | Date of Death cannot be a future date : deceasedDateTime < now() | |
EM07215 | error | Patient | Date of Death must be greater than, or equal to Date of Birth : deceasedDateTime >= birthDate | |
EM07225 | error | Patient, Patient.name | If name-use-extra is supplied name-use must be temp, and source NPRF : name.where(use='temp').exists() implies (extension.where((url='http://hl7.org.nz/fhir/StructureDefinition/information-source') and (valueCodeableConcept.coding.code ='NPRF')).exists()) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | NhiPatient | 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 EM02106: A Patient must have an active Preferred Name EM02201: A Patient must have a primary residential address EM02101: A Patient name must contain either a given or family name EM07225: If name-use-extra is supplied name-use must be temp, and source NPRF EM07212: birthdate must be after 1 January 1900, and not a future date EM07212-1: Date of Death cannot be a future date EM07215: Date of Death must be greater than, or equal to Date of Birth |
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
1..6 | (Complex) | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Hip_ethnicity_lvl_4 (2.0) (required) | |
![]() ![]() ![]() ![]() |
1..1 | (Complex) | NZ Citizenship URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "status" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: NZ Citizenship status (preferred) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "source" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: NZ Citizenship Information Source (required) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship" | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "country" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: ISO 3166-1:2013 (2-alpha country code) (required) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "place-of-birth" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "source" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Country of Birth Information Source (required) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/birth-place" | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system |
![]() ![]() ![]() |
ΣC | 1..1 | HumanName | A name associated with the patient EM07225: If name-use-extra is supplied name-use must be temp, and source NPRF |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Name Information Source (required) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/name-use-extra Binding: NHI Name Use Extra (required) | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | temp | nickname | maiden Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | 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 |
![]() ![]() ![]() |
Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text | |
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for code | |
![]() ![]() ![]() |
Σ | 1..1 | date | The date of birth for the individual |
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Date of Birth Information Source (required) | |
![]() ![]() ![]() ![]() |
0..1 | date | Primitive value for date | |
![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not |
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/information-source" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Date of Death Information Source (required) | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | Primitive value for dateTime | |
![]() ![]() ![]() |
1..1 | NhiAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred) | |
![]() ![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived | |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required) Example General: home |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required) Example General: both |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() ![]() |
Σ | 1..2 | 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 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Postal code for area Example General: 9132 |
![]() ![]() ![]() ![]() |
Σ | 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) |
![]() |
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.extension:birthPlace.extension:country.value[x] | required | Hpi_country_code_iso_3166_1https://nzhts.digital.health.nz/fhir/ValueSet/country-code | ||||
Patient.extension:birthPlace.extension:source.value[x] | required | Nhi_country_of_birth_sourcehttps://nzhts.digital.health.nz/fhir/ValueSet/country-of-birth-source-code | ||||
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 |
EM02101 | error | Patient | A Patient name must contain either a given or family name : Patient.name.all(given.exists() and family.exists()) | |
EM02106 | error | Patient | A Patient must have an active Preferred Name : Patient.name.extension.where((url = 'http://hl7.org/fhir/StructureDefinition/iso21090-preferred') and (valueBoolean=true)).count()=1 | |
EM02201 | error | Patient | A Patient must have a primary residential address : Patient.address.where( (use = 'home') and (type = 'physical')).count()=1 | |
EM07212 | error | Patient | birthdate must be after 1 January 1900, and not a future date : (birthDate > @1900-01-01) and (birthDate < now()) | |
EM07212-1 | error | Patient | Date of Death cannot be a future date : deceasedDateTime < now() | |
EM07215 | error | Patient | Date of Death must be greater than, or equal to Date of Birth : deceasedDateTime >= birthDate | |
EM07225 | error | Patient, Patient.name | If name-use-extra is supplied name-use must be temp, and source NPRF : name.where(use='temp').exists() implies (extension.where((url='http://hl7.org.nz/fhir/StructureDefinition/information-source') and (valueCodeableConcept.coding.code ='NPRF')).exists()) |
This structure is derived from NhiPatient
Cannot invoke "Object.hashCode()" because "key" is null
Other representations of profile: CSV, Excel, Schematron