New Zealand NHI IG
1.6.3 - Release

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

Resource Profile: Create NHI Patient

Official URL: http://hl7.org.nz/fhir/StructureDefinition/CreateNhiPatient Version: 1.6.3
Active as of 2025-03-04 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:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* NhiPatient Information about an individual or animal receiving health care services
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
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
... Slices for contained 0..* Resource Contained, inline Resources
Slice: Unordered, Closed by type:$this
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ethnicity 1..6 (Complex) NZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... 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
ele-1: All FHIR elements must have a @value or children
...... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: Hip_ethnicity_lvl_4 (2.0) (required)
ele-1: All FHIR elements must have a @value or children
.... extension:nzCitizen 1..1 (Complex) NZ Citizenship
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension:status 1..1 Extension Extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension 0..0
....... url 1..1 uri "status"
....... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
........ value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: NZ Citizenship status (preferred)
ele-1: All FHIR elements must have a @value or children
...... extension:source 1..1 Extension Extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension 0..0
....... url 1..1 uri "source"
....... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
........ value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: NZ Citizenship Information Source (required)
ele-1: All FHIR elements must have a @value or children
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
.... extension:birthPlace 0..1 (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension:country 1..1 Extension Extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension 0..0
....... url 1..1 uri "country"
...... extension:place-of-birth 0..1 Extension Extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension 0..0
....... url 1..1 uri "place-of-birth"
...... extension:source 1..1 Extension Extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension 0..0
....... url 1..1 uri "source"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Country of Birth Information Source (required)
ele-1: All FHIR elements must have a @value or children
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/birth-place"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... name ΣC 1..1 HumanName A name associated with the patient
ele-1: All FHIR elements must have a @value or children
EM07225: If name-use-extra is supplied name-use must be temp, and source NPRF
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:information-source 1..1 (Complex) Information Source
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension 0..0
...... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/information-source"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: Name Information Source (required)
ele-1: All FHIR elements must have a @value or children
..... extension:preferred 1..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:nhi-name-use-extra 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/name-use-extra
Binding: NHI Name Use Extra (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 0..1 code temp | nickname | maiden
Binding: NameUse (required): The use of a human name.


ele-1: All FHIR elements must have a @value or children
.... given Σ 0..2 string Given name and other given name(s)
ele-1: All FHIR elements must have a @value or children
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..1 string Parts that come before the name
Binding: Name Prefix Codes (required)
ele-1: All FHIR elements must have a @value or children
This repeating element order: Prefixes appear in the correct order for presenting the name
... gender Σ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.


ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... extension:originalText 0..1 string Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... birthDate Σ 1..1 date The date of birth for the individual
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:information-source 1..1 (Complex) Information Source
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension 0..0
...... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/information-source"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: Date of Birth Information Source (required)
ele-1: All FHIR elements must have a @value or children
... deceased[x] ?!Σ 0..1 dateTime Indicates if the individual is deceased or not
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:information-source 1..1 (Complex) Information Source
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension 0..0
...... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/information-source"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: Date of Death Information Source (required)
ele-1: All FHIR elements must have a @value or children
... address 1..1 NhiAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... extension:nz-geocode 0..1 (Complex) A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:suburb 0..1 string The suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension: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)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension: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)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:nz-address-id 0..1 string Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:nz-address-derived 0..1 (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: NHI Address Use Codes (required)
ele-1: All FHIR elements must have a @value or children
Example General: home
.... type Σ 1..1 code postal | physical
Binding: NHI Address Type Codes (required)
ele-1: All FHIR elements must have a @value or children
Example General: both
.... line Σ 1..2 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.extension:ethnicity.value[x]:valueCodeableConceptrequiredHip_ethnicity_lvl_4
https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code|2.0
Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConceptpreferredCitizenshipStatus
https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code
Patient.extension:nzCitizen.extension:source.value[x]:valueCodeableConceptrequiredNhi_citizenship_source
https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-source-code
Patient.extension:birthPlace.extension:source.value[x]requiredNhi_country_of_birth_source
https://nzhts.digital.health.nz/fhir/ValueSet/country-of-birth-source-code
Patient.identifier:NHI.userequiredNHIUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.name.extension:information-source.value[x]:valueCodeableConceptrequiredNhi_name_source
https://nzhts.digital.health.nz/fhir/ValueSet/name-source-code
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name.prefixrequiredHpi_name_prefix
https://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code
Patient.telecom.userequiredNhiContactPointUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhiContactUseType
from this IG
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.birthDate.extension:information-source.value[x]:valueCodeableConceptrequiredNhi_date_of_birth_source
https://nzhts.digital.health.nz/fhir/ValueSet/date-of-birth-source-code
Patient.deceased[x].extension:information-source.value[x]:valueCodeableConceptrequiredNhi_date_of_death_source
https://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code
Patient.address.userequiredNhiAddressUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhiaddressUse
Patient.address.typerequiredNhiAddressType
https://nzhts.digital.health.nz/fhir/ValueSet/addressType
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
EM02101errorPatientA Patient name must contain either a given or family name
: Patient.name.all(given.exists() and family.exists())
EM02106errorPatientA Patient must have an active Preferred Name
: Patient.name.extension.where((url = 'http://hl7.org/fhir/StructureDefinition/iso21090-preferred') and (valueBoolean=true)).count()=1
EM02201errorPatientA Patient must have a primary residential address
: Patient.address.where( (use = 'home') and (type = 'physical')).count()=1
EM07212errorPatientbirthdate must be after 1 January 1900, and not a future date
: (birthDate > @1900-01-01) and (birthDate < now())
EM07212-1errorPatientDate of Death cannot be a future date
: deceasedDateTime < now()
EM07215errorPatientDate of Death must be greater than, or equal to Date of Birth
: deceasedDateTime >= birthDate
EM07225errorPatient, Patient.nameIf 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 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
... implicitRules 0..0
... language 0..0
... Slices for contained Content/Rules for all slices
.... contained:GP 0..0
... Slices for extension Content/Rules for all slices
.... extension:ethnicity 1..6 Nz_ethnicity NZ Ethnicity
.... extension:nzCitizen 1..1 Nz_citizenship NZ Citizenship
..... extension 2..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:status 1..1 Extension Extension
....... value[x] 1..1 CodeableConcept Value of extension
....... Slices for value[x] Content/Rules for all slices
........ value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
...... extension:source 1..1 Extension Extension
....... value[x] 1..1 CodeableConcept Value of extension
....... Slices for value[x] Content/Rules for all slices
........ value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
.... extension:dhb 0..0
.... extension:birthPlace 0..1 BirthPlace Extension
..... extension 2..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:country 1..1 Extension Extension
...... extension:source 1..1 Extension Extension
....... value[x] 1..1 CodeableConcept Value of extension
... Slices for identifier Content/Rules for all slices
.... identifier:NHI 0..0
... name 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
.... extension 2..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:information-source 1..1 Information_source Information Source
...... value[x] 1..1 CodeableConcept Value of extension
...... Slices for value[x] Content/Rules for all slices
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
.... prefix 0..1 string Parts that come before the name
... telecom 0..0
... gender 1..1 code male | female | other | unknown
... birthDate 1..1 date The date of birth for the individual
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:information-source 1..1 Information_source Information Source
...... value[x] 1..1 CodeableConcept Value of extension
...... Slices for value[x] Content/Rules for all slices
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
... deceased[x]
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:information-source 1..1 Information_source Information Source
...... value[x] 1..1 CodeableConcept Value of extension
...... Slices for value[x] Content/Rules for all slices
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
... address 1..1 NhiAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... use 1..1 code home | work | temp | old | billing - purpose of this address
.... line 1..2 string Street name, number, direction & P.O. Box etc.
... generalPractitioner 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
EM02101errorPatientA Patient name must contain either a given or family name
: Patient.name.all(given.exists() and family.exists())
EM02106errorPatientA Patient must have an active Preferred Name
: Patient.name.extension.where((url = 'http://hl7.org/fhir/StructureDefinition/iso21090-preferred') and (valueBoolean=true)).count()=1
EM02201errorPatientA Patient must have a primary residential address
: Patient.address.where( (use = 'home') and (type = 'physical')).count()=1
EM07212errorPatientbirthdate must be after 1 January 1900, and not a future date
: (birthDate > @1900-01-01) and (birthDate < now())
EM07212-1errorPatientDate of Death cannot be a future date
: deceasedDateTime < now()
EM07215errorPatientDate of Death must be greater than, or equal to Date of Birth
: deceasedDateTime >= birthDate
EM07225errorPatient, Patient.nameIf 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())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 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
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... text 0..1 Narrative Text summary of the resource, for human interpretation
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ethnicity 1..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)
.... extension:nzCitizen 1..1 (Complex) NZ Citizenship
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:status 1..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] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: NZ Citizenship status (preferred)
...... extension:source 1..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] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: NZ Citizenship Information Source (required)
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
.... extension:birthPlace 0..1 (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:country 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "country"
....... value[x] 0..1 CodeableConcept Value of extension
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
...... extension:place-of-birth 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "place-of-birth"
....... value[x] 0..1 string Value of extension
...... extension:source 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "source"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Country of Birth Information Source (required)
..... url 1..1 uri "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
... name Σ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
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:information-source 1..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] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: Name Information Source (required)
..... extension:preferred 1..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... extension: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..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
... gender Σ 1..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
..... extension:originalText 0..1 string Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
.... value 0..1 string Primitive value for code
... birthDate Σ 1..1 date The date of birth for the individual
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:information-source 1..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] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..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 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:information-source 1..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] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: Date of Death Information Source (required)
.... value 0..1 dateTime Primitive value for dateTime
... address 1..1 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
..... extension:nz-geocode 0..1 (Complex) A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
..... extension:suburb 0..1 string The suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
..... extension:building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
..... extension: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)
..... extension: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)
..... extension:nz-address-id 0..1 string Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
..... extension:nz-address-derived 0..1 (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
.... use ?!Σ 1..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..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
.... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.extension:ethnicity.value[x]:valueCodeableConceptrequiredHip_ethnicity_lvl_4
https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code|2.0
Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConceptpreferredCitizenshipStatus
https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code
Patient.extension:nzCitizen.extension:source.value[x]:valueCodeableConceptrequiredNhi_citizenship_source
https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-source-code
Patient.extension:birthPlace.extension:country.value[x]requiredHpi_country_code_iso_3166_1
https://nzhts.digital.health.nz/fhir/ValueSet/country-code
Patient.extension:birthPlace.extension:source.value[x]requiredNhi_country_of_birth_source
https://nzhts.digital.health.nz/fhir/ValueSet/country-of-birth-source-code
Patient.identifier:NHI.userequiredNHIUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.name.extension:information-source.value[x]:valueCodeableConceptrequiredNhi_name_source
https://nzhts.digital.health.nz/fhir/ValueSet/name-source-code
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name.prefixrequiredHpi_name_prefix
https://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code
Patient.telecom.systemrequiredNhiContactPointSystem
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-contact-point-system-code
from this IG
Patient.telecom.userequiredNhiContactPointUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhiContactUseType
from this IG
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.birthDate.extension:information-source.value[x]:valueCodeableConceptrequiredNhi_date_of_birth_source
https://nzhts.digital.health.nz/fhir/ValueSet/date-of-birth-source-code
Patient.deceased[x].extension:information-source.value[x]:valueCodeableConceptrequiredNhi_date_of_death_source
https://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code
Patient.address.userequiredNhiAddressUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhiaddressUse
Patient.address.typerequiredNhiAddressType
https://nzhts.digital.health.nz/fhir/ValueSet/addressType
Patient.address.countryrequiredHpi_country_code_iso_3166_1
https://nzhts.digital.health.nz/fhir/ValueSet/country-code
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
EM02101errorPatientA Patient name must contain either a given or family name
: Patient.name.all(given.exists() and family.exists())
EM02106errorPatientA Patient must have an active Preferred Name
: Patient.name.extension.where((url = 'http://hl7.org/fhir/StructureDefinition/iso21090-preferred') and (valueBoolean=true)).count()=1
EM02201errorPatientA Patient must have a primary residential address
: Patient.address.where( (use = 'home') and (type = 'physical')).count()=1
EM07212errorPatientbirthdate must be after 1 January 1900, and not a future date
: (birthDate > @1900-01-01) and (birthDate < now())
EM07212-1errorPatientDate of Death cannot be a future date
: deceasedDateTime < now()
EM07215errorPatientDate of Death must be greater than, or equal to Date of Birth
: deceasedDateTime >= birthDate
EM07225errorPatient, Patient.nameIf 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

Summary

Mandatory: 20 elements(7 nested mandatory elements)
Prohibited: 7 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* NhiPatient Information about an individual or animal receiving health care services
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
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
... Slices for contained 0..* Resource Contained, inline Resources
Slice: Unordered, Closed by type:$this
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ethnicity 1..6 (Complex) NZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... 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
ele-1: All FHIR elements must have a @value or children
...... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: Hip_ethnicity_lvl_4 (2.0) (required)
ele-1: All FHIR elements must have a @value or children
.... extension:nzCitizen 1..1 (Complex) NZ Citizenship
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension:status 1..1 Extension Extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension 0..0
....... url 1..1 uri "status"
....... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
........ value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: NZ Citizenship status (preferred)
ele-1: All FHIR elements must have a @value or children
...... extension:source 1..1 Extension Extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension 0..0
....... url 1..1 uri "source"
....... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
........ value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: NZ Citizenship Information Source (required)
ele-1: All FHIR elements must have a @value or children
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
.... extension:birthPlace 0..1 (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension:country 1..1 Extension Extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension 0..0
....... url 1..1 uri "country"
...... extension:place-of-birth 0..1 Extension Extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension 0..0
....... url 1..1 uri "place-of-birth"
...... extension:source 1..1 Extension Extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension 0..0
....... url 1..1 uri "source"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Country of Birth Information Source (required)
ele-1: All FHIR elements must have a @value or children
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/birth-place"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... name ΣC 1..1 HumanName A name associated with the patient
ele-1: All FHIR elements must have a @value or children
EM07225: If name-use-extra is supplied name-use must be temp, and source NPRF
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:information-source 1..1 (Complex) Information Source
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension 0..0
...... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/information-source"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: Name Information Source (required)
ele-1: All FHIR elements must have a @value or children
..... extension:preferred 1..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:nhi-name-use-extra 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/name-use-extra
Binding: NHI Name Use Extra (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 0..1 code temp | nickname | maiden
Binding: NameUse (required): The use of a human name.


ele-1: All FHIR elements must have a @value or children
.... given Σ 0..2 string Given name and other given name(s)
ele-1: All FHIR elements must have a @value or children
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..1 string Parts that come before the name
Binding: Name Prefix Codes (required)
ele-1: All FHIR elements must have a @value or children
This repeating element order: Prefixes appear in the correct order for presenting the name
... gender Σ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.


ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... extension:originalText 0..1 string Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... birthDate Σ 1..1 date The date of birth for the individual
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:information-source 1..1 (Complex) Information Source
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension 0..0
...... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/information-source"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: Date of Birth Information Source (required)
ele-1: All FHIR elements must have a @value or children
... deceased[x] ?!Σ 0..1 dateTime Indicates if the individual is deceased or not
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:information-source 1..1 (Complex) Information Source
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension 0..0
...... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/information-source"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: Date of Death Information Source (required)
ele-1: All FHIR elements must have a @value or children
... address 1..1 NhiAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... extension:nz-geocode 0..1 (Complex) A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:suburb 0..1 string The suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension: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)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension: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)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:nz-address-id 0..1 string Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:nz-address-derived 0..1 (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: NHI Address Use Codes (required)
ele-1: All FHIR elements must have a @value or children
Example General: home
.... type Σ 1..1 code postal | physical
Binding: NHI Address Type Codes (required)
ele-1: All FHIR elements must have a @value or children
Example General: both
.... line Σ 1..2 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.extension:ethnicity.value[x]:valueCodeableConceptrequiredHip_ethnicity_lvl_4
https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code|2.0
Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConceptpreferredCitizenshipStatus
https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code
Patient.extension:nzCitizen.extension:source.value[x]:valueCodeableConceptrequiredNhi_citizenship_source
https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-source-code
Patient.extension:birthPlace.extension:source.value[x]requiredNhi_country_of_birth_source
https://nzhts.digital.health.nz/fhir/ValueSet/country-of-birth-source-code
Patient.identifier:NHI.userequiredNHIUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.name.extension:information-source.value[x]:valueCodeableConceptrequiredNhi_name_source
https://nzhts.digital.health.nz/fhir/ValueSet/name-source-code
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name.prefixrequiredHpi_name_prefix
https://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code
Patient.telecom.userequiredNhiContactPointUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhiContactUseType
from this IG
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.birthDate.extension:information-source.value[x]:valueCodeableConceptrequiredNhi_date_of_birth_source
https://nzhts.digital.health.nz/fhir/ValueSet/date-of-birth-source-code
Patient.deceased[x].extension:information-source.value[x]:valueCodeableConceptrequiredNhi_date_of_death_source
https://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code
Patient.address.userequiredNhiAddressUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhiaddressUse
Patient.address.typerequiredNhiAddressType
https://nzhts.digital.health.nz/fhir/ValueSet/addressType
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
EM02101errorPatientA Patient name must contain either a given or family name
: Patient.name.all(given.exists() and family.exists())
EM02106errorPatientA Patient must have an active Preferred Name
: Patient.name.extension.where((url = 'http://hl7.org/fhir/StructureDefinition/iso21090-preferred') and (valueBoolean=true)).count()=1
EM02201errorPatientA Patient must have a primary residential address
: Patient.address.where( (use = 'home') and (type = 'physical')).count()=1
EM07212errorPatientbirthdate must be after 1 January 1900, and not a future date
: (birthDate > @1900-01-01) and (birthDate < now())
EM07212-1errorPatientDate of Death cannot be a future date
: deceasedDateTime < now()
EM07215errorPatientDate of Death must be greater than, or equal to Date of Birth
: deceasedDateTime >= birthDate
EM07225errorPatient, Patient.nameIf 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())

Differential View

This structure is derived from NhiPatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 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
... implicitRules 0..0
... language 0..0
... Slices for contained Content/Rules for all slices
.... contained:GP 0..0
... Slices for extension Content/Rules for all slices
.... extension:ethnicity 1..6 Nz_ethnicity NZ Ethnicity
.... extension:nzCitizen 1..1 Nz_citizenship NZ Citizenship
..... extension 2..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:status 1..1 Extension Extension
....... value[x] 1..1 CodeableConcept Value of extension
....... Slices for value[x] Content/Rules for all slices
........ value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
...... extension:source 1..1 Extension Extension
....... value[x] 1..1 CodeableConcept Value of extension
....... Slices for value[x] Content/Rules for all slices
........ value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
.... extension:dhb 0..0
.... extension:birthPlace 0..1 BirthPlace Extension
..... extension 2..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:country 1..1 Extension Extension
...... extension:source 1..1 Extension Extension
....... value[x] 1..1 CodeableConcept Value of extension
... Slices for identifier Content/Rules for all slices
.... identifier:NHI 0..0
... name 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
.... extension 2..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:information-source 1..1 Information_source Information Source
...... value[x] 1..1 CodeableConcept Value of extension
...... Slices for value[x] Content/Rules for all slices
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
.... prefix 0..1 string Parts that come before the name
... telecom 0..0
... gender 1..1 code male | female | other | unknown
... birthDate 1..1 date The date of birth for the individual
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:information-source 1..1 Information_source Information Source
...... value[x] 1..1 CodeableConcept Value of extension
...... Slices for value[x] Content/Rules for all slices
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
... deceased[x]
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:information-source 1..1 Information_source Information Source
...... value[x] 1..1 CodeableConcept Value of extension
...... Slices for value[x] Content/Rules for all slices
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
... address 1..1 NhiAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... use 1..1 code home | work | temp | old | billing - purpose of this address
.... line 1..2 string Street name, number, direction & P.O. Box etc.
... generalPractitioner 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
EM02101errorPatientA Patient name must contain either a given or family name
: Patient.name.all(given.exists() and family.exists())
EM02106errorPatientA Patient must have an active Preferred Name
: Patient.name.extension.where((url = 'http://hl7.org/fhir/StructureDefinition/iso21090-preferred') and (valueBoolean=true)).count()=1
EM02201errorPatientA Patient must have a primary residential address
: Patient.address.where( (use = 'home') and (type = 'physical')).count()=1
EM07212errorPatientbirthdate must be after 1 January 1900, and not a future date
: (birthDate > @1900-01-01) and (birthDate < now())
EM07212-1errorPatientDate of Death cannot be a future date
: deceasedDateTime < now()
EM07215errorPatientDate of Death must be greater than, or equal to Date of Birth
: deceasedDateTime >= birthDate
EM07225errorPatient, Patient.nameIf 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 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
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... text 0..1 Narrative Text summary of the resource, for human interpretation
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ethnicity 1..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)
.... extension:nzCitizen 1..1 (Complex) NZ Citizenship
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:status 1..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] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: NZ Citizenship status (preferred)
...... extension:source 1..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] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: NZ Citizenship Information Source (required)
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
.... extension:birthPlace 0..1 (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:country 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "country"
....... value[x] 0..1 CodeableConcept Value of extension
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
...... extension:place-of-birth 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "place-of-birth"
....... value[x] 0..1 string Value of extension
...... extension:source 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "source"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Country of Birth Information Source (required)
..... url 1..1 uri "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
... name Σ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
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:information-source 1..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] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: Name Information Source (required)
..... extension:preferred 1..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... extension: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..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
... gender Σ 1..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
..... extension:originalText 0..1 string Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
.... value 0..1 string Primitive value for code
... birthDate Σ 1..1 date The date of birth for the individual
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:information-source 1..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] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..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 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:information-source 1..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] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: Date of Death Information Source (required)
.... value 0..1 dateTime Primitive value for dateTime
... address 1..1 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
..... extension:nz-geocode 0..1 (Complex) A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
..... extension:suburb 0..1 string The suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
..... extension:building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
..... extension: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)
..... extension: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)
..... extension:nz-address-id 0..1 string Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
..... extension:nz-address-derived 0..1 (Complex) Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
.... use ?!Σ 1..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..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
.... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.extension:ethnicity.value[x]:valueCodeableConceptrequiredHip_ethnicity_lvl_4
https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code|2.0
Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConceptpreferredCitizenshipStatus
https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code
Patient.extension:nzCitizen.extension:source.value[x]:valueCodeableConceptrequiredNhi_citizenship_source
https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-source-code
Patient.extension:birthPlace.extension:country.value[x]requiredHpi_country_code_iso_3166_1
https://nzhts.digital.health.nz/fhir/ValueSet/country-code
Patient.extension:birthPlace.extension:source.value[x]requiredNhi_country_of_birth_source
https://nzhts.digital.health.nz/fhir/ValueSet/country-of-birth-source-code
Patient.identifier:NHI.userequiredNHIUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.name.extension:information-source.value[x]:valueCodeableConceptrequiredNhi_name_source
https://nzhts.digital.health.nz/fhir/ValueSet/name-source-code
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name.prefixrequiredHpi_name_prefix
https://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code
Patient.telecom.systemrequiredNhiContactPointSystem
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-contact-point-system-code
from this IG
Patient.telecom.userequiredNhiContactPointUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhiContactUseType
from this IG
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.birthDate.extension:information-source.value[x]:valueCodeableConceptrequiredNhi_date_of_birth_source
https://nzhts.digital.health.nz/fhir/ValueSet/date-of-birth-source-code
Patient.deceased[x].extension:information-source.value[x]:valueCodeableConceptrequiredNhi_date_of_death_source
https://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code
Patient.address.userequiredNhiAddressUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhiaddressUse
Patient.address.typerequiredNhiAddressType
https://nzhts.digital.health.nz/fhir/ValueSet/addressType
Patient.address.countryrequiredHpi_country_code_iso_3166_1
https://nzhts.digital.health.nz/fhir/ValueSet/country-code
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
EM02101errorPatientA Patient name must contain either a given or family name
: Patient.name.all(given.exists() and family.exists())
EM02106errorPatientA Patient must have an active Preferred Name
: Patient.name.extension.where((url = 'http://hl7.org/fhir/StructureDefinition/iso21090-preferred') and (valueBoolean=true)).count()=1
EM02201errorPatientA Patient must have a primary residential address
: Patient.address.where( (use = 'home') and (type = 'physical')).count()=1
EM07212errorPatientbirthdate must be after 1 January 1900, and not a future date
: (birthDate > @1900-01-01) and (birthDate < now())
EM07212-1errorPatientDate of Death cannot be a future date
: deceasedDateTime < now()
EM07215errorPatientDate of Death must be greater than, or equal to Date of Birth
: deceasedDateTime >= birthDate
EM07225errorPatient, Patient.nameIf 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

Summary

Mandatory: 20 elements(7 nested mandatory elements)
Prohibited: 7 elements

 

Other representations of profile: CSV, Excel, Schematron