CanShare models
0.1.0 - ci-build

CanShare models, published by David hay. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/davidhay25/models/ and changes regularly. See the Directory of published versions

Logical Model: Patient_cs - Detailed Descriptions

Draft as of 2024-03-04

Definitions for the Patient-cs logical model.

Guidance on how to interpret the contents of this table can be found here

0. Patient-cs
Definition

Identifying and demographic details about the patient.

ShortPatient
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Patient-cs.Nhi
Definition

A unique identifier assigned to a person by the NHI system.

ShortA unique identifier assigned to a person by the NHI system.
Control1..1
TypeIdentifier
4. Patient-cs.NZName
Definition

A person’s name details

ShortA person’s name details
Control1..1
TypeBackboneElement
6. Patient-cs.NZName.Title
Definition

The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person

ShortThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
Control0..1
TypeCodeableConcept
8. Patient-cs.NZName.GivenName
Definition

The person’s forename or given name at birth

ShortThe person’s forename or given name at birth
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. Patient-cs.NZName.OtherGivenName
Definition

The person’s other given names or middle name and initials, but not the family name at birth

ShortThe person’s other given names or middle name and initials, but not the family name at birth
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. Patient-cs.NZName.FamilyName
Definition

The family name (surname) of a person as distinct from their given, second and subsequent name(s)

ShortThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. Patient-cs.NZName.NameSuffix
Definition

The suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership

ShortThe suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. Patient-cs.NZName.PreferredNameIndicator
Definition

An indicator used to denote that a particular person name is the person’s preferred name

ShortAn indicator used to denote that a particular person name is the person’s preferred name
Control0..1
TypeCodeableConcept
18. Patient-cs.NZName.NameProtectionFlag
Definition

This indicator denotes that the person’s name information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s name information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. Patient-cs.NZName.age
Definition

Patient.NZName.age

ShortPatient.NZName.age
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. Patient-cs.NZName.NameInfoSource
Definition

A code indicating the name source

ShortA code indicating the name source
Control0..1
TypeCodeableConcept
24. Patient-cs.NZName.NameEffectivePeriod
Definition

The date(s) the name is effective from and/or to

ShortThe date(s) the name is effective from and/or to
Control0..1
TypePeriod
26. Patient-cs.BirthdatePlace
Definition

A person’s birth details

ShortA person’s birth details
Control0..1
TypeBackboneElement
28. Patient-cs.BirthdatePlace.DOB
Definition

The date on which the person was born

ShortThe date on which the person was born
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. Patient-cs.BirthdatePlace.DOBInfoSource
Definition

A code indicating the origin of date of birth information

ShortA code indicating the origin of date of birth information
Control0..1
TypeCodeableConcept
32. Patient-cs.BirthdatePlace.PlaceBirth
Definition

The town, suburb, city etc where the person was born

ShortThe town, suburb, city etc where the person was born
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. Patient-cs.BirthdatePlace.CountryBirthCode
Definition

Country where the person was born

ShortCountry where the person was born
Control0..1
TypeCodeableConcept
36. Patient-cs.BirthdatePlace.CountryBirthInfoSource
Definition

A code indicating the source of information supporting the code for country of birth

ShortA code indicating the source of information supporting the code for country of birth
Control0..1
TypeCodeableConcept
38. Patient-cs.Age
Definition

The age of the patient at the time the data was recorded.

ShortThe age of the patient at the time the data was recorded.
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. Patient-cs.Gender
Definition

A classification of the person's gender as self-identified by the person

ShortA classification of the person's gender as self-identified by the person
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. Patient-cs.Sex
Definition

A classification of the person's sex characteristics such as chromosomes, hormones and reproductive organs (Stats NZ Statistical standard for gender, sex, and variations of sex characteristics).

ShortA classification of the person's sex characteristics such as chromosomes, hormones and reproductive organs (Stats NZ Statistical standard for gender, sex, and variations of sex characteristics).
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
TypeCodeableConcept
44. Patient-cs.Ethnicity
Definition

A classification of the ethnicity of an individual person as self-identified by the person

ShortA classification of the ethnicity of an individual person as self-identified by the person
Control1..*
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
TypeCodeableConcept
46. Patient-cs.MotherBirthName
Definition

The full name of the person’s mother at the time of the mother’s birth

ShortThe full name of the person’s mother at the time of the mother’s birth
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
48. Patient-cs.NZResidencyCitizenship
Definition

New Zealand residency and citizenship details

ShortNew Zealand residency and citizenship details
Control0..1
TypeBackboneElement
50. Patient-cs.NZResidencyCitizenship.NZResidencyStatus
Definition

Code indicating whether the person holds a New Zealand residence class visa (either a resident visa or a permanent resident visa)

ShortCode indicating whether the person holds a New Zealand residence class visa (either a resident visa or a permanent resident visa)
Control0..1
TypeCodeableConcept
52. Patient-cs.NZResidencyCitizenship.NZResidencyStatusInfoSource
Definition

A code indicating the source of information of the person’s New Zealand residency status

ShortA code indicating the source of information of the person’s New Zealand residency status
Control0..1
TypeCodeableConcept
54. Patient-cs.NZResidencyCitizenship.NZCitizenshipStatus
Definition

This field indicates if the person holds New Zealand citizenship

ShortThis field indicates if the person holds New Zealand citizenship
Control0..1
TypeCodeableConcept
56. Patient-cs.NZResidencyCitizenship.NZCitizenshipStatusInformationSource
Definition

A code indicating the source of information of the person’s New Zealand citizenship status

ShortA code indicating the source of information of the person’s New Zealand citizenship status
Control0..1
TypeCodeableConcept
58. Patient-cs.DeathInformation
Definition

Information on patient death

ShortInformation on patient death
Control0..1
TypeBackboneElement
60. Patient-cs.DeathInformation.DateDeath
Definition

The date the person died

ShortThe date the person died
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
62. Patient-cs.DeathInformation.DateDeathInfoSource
Definition

A code indicating the valid date of death information source

ShortA code indicating the valid date of death information source
Control0..1
TypeCodeableConcept
64. Patient-cs.Address
Definition

The person's current address or location details if known (in NZ CIQ address profile format.

ShortThe person's current address or location details if known (in NZ CIQ address profile format.
Control0..*
TypeBackboneElement
66. Patient-cs.Address.Type
Definition

The type of address, e.g. residential (physical), mailing (postal)

ShortThe type of address, e.g. residential (physical), mailing (postal)
Control0..1
TypeCodeableConcept
68. Patient-cs.Address.BuildingName
Definition

The name of the building or institution.

ShortThe name of the building or institution.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
70. Patient-cs.Address.StreetAddress1
Definition

The floor, unit and/or street address details.

ShortThe floor, unit and/or street address details.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
72. Patient-cs.Address.StreetAddress2
Definition

Other geographic information related to the address

ShortOther geographic information related to the address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
74. Patient-cs.Address.Suburb
Definition

The name of the suburb or district within a city/town.

ShortThe name of the suburb or district within a city/town.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
76. Patient-cs.Address.City
Definition

Patient.Address.City

ShortPatient.Address.City
Control0..1
TypeCodeableConcept
78. Patient-cs.Address.Postcode
Definition

The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.

ShortThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
80. Patient-cs.Address.CountryCode
Definition

The two character ISO code that forms part of the address.

ShortThe two character ISO code that forms part of the address.
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
82. Patient-cs.Address.AddressProtectedFlag
Definition

This indicator denotes that the person’s address information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s address information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
84. Patient-cs.Address.PermanentAddressFlag
Definition

An indicator used to denote an address is a permanent address

ShortAn indicator used to denote an address is a permanent address
Control0..1
TypeCodeableConcept
86. Patient-cs.Address.DateAddressPeriod
Definition

Date(s) that an address is effective from and/or to

ShortDate(s) that an address is effective from and/or to
Control0..1
TypePeriod
88. Patient-cs.Address.DomicileCode
Definition

New Zealand health domicile code representing a person’s usual residential address

ShortNew Zealand health domicile code representing a person’s usual residential address
Control0..1
TypeCodeableConcept
90. Patient-cs.Address.PrimaryAddressFlag
Definition

An indicator used to denote that the address is the primary address for the person

ShortAn indicator used to denote that the address is the primary address for the person
Control0..1
TypeCodeableConcept
92. Patient-cs.Language
Definition

A code representing a language spoken or understood by the person

ShortA code representing a language spoken or understood by the person
Control0..*
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
94. Patient-cs.ContactInformation
Definition

The method of electronic communication to be used to contact the patient

ShortThe method of electronic communication to be used to contact the patient
Control0..1
TypeBackboneElement
96. Patient-cs.ContactInformation.ContactUsage
Definition

The classification that specifies the way in which the contact medium is intended to be used

ShortThe classification that specifies the way in which the contact medium is intended to be used
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
TypeCodeableConcept
98. Patient-cs.ContactInformation.ContactType
Definition

The code representing the type of electronic contact medium to be used

ShortThe code representing the type of electronic contact medium to be used
Control0..1
TypeCodeableConcept
100. Patient-cs.ContactInformation.ContactDetail
Definition

The contact details may comprise an electronic address or a number

ShortThe contact details may comprise an electronic address or a number
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
102. Patient-cs.ContactInformation.ContactProtectedFlag
Definition

This indicates that the contact information is confidential

ShortThis indicates that the contact information is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
104. Patient-cs.ContactInformation.ContactDetailsPeriod
Definition

Date contact details effective from and/or to

ShortDate contact details effective from and/or to
Control0..1
TypePeriod
106. Patient-cs.ContactInformation.PerferredContactFlag
Definition

This flag denotes that the contact details provided are the person’s preference

ShortThis flag denotes that the contact details provided are the person’s preference
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
108. Patient-cs.Title
Definition

Patient.Title

ShortPatient.Title
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. Patient-cs
Definition

Identifying and demographic details about the patient.

ShortPatient
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Patient-cs.Nhi
Definition

A unique identifier assigned to a person by the NHI system.

ShortA unique identifier assigned to a person by the NHI system.
Control1..1
TypeIdentifier
4. Patient-cs.NZName
Definition

A person’s name details

ShortA person’s name details
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Patient-cs.NZName.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Patient-cs.NZName.Title
Definition

The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person

ShortThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
Control0..1
TypeCodeableConcept
10. Patient-cs.NZName.GivenName
Definition

The person’s forename or given name at birth

ShortThe person’s forename or given name at birth
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. Patient-cs.NZName.OtherGivenName
Definition

The person’s other given names or middle name and initials, but not the family name at birth

ShortThe person’s other given names or middle name and initials, but not the family name at birth
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. Patient-cs.NZName.FamilyName
Definition

The family name (surname) of a person as distinct from their given, second and subsequent name(s)

ShortThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. Patient-cs.NZName.NameSuffix
Definition

The suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership

ShortThe suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. Patient-cs.NZName.PreferredNameIndicator
Definition

An indicator used to denote that a particular person name is the person’s preferred name

ShortAn indicator used to denote that a particular person name is the person’s preferred name
Control0..1
TypeCodeableConcept
20. Patient-cs.NZName.NameProtectionFlag
Definition

This indicator denotes that the person’s name information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s name information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. Patient-cs.NZName.age
Definition

Patient.NZName.age

ShortPatient.NZName.age
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. Patient-cs.NZName.NameInfoSource
Definition

A code indicating the name source

ShortA code indicating the name source
Control0..1
TypeCodeableConcept
26. Patient-cs.NZName.NameEffectivePeriod
Definition

The date(s) the name is effective from and/or to

ShortThe date(s) the name is effective from and/or to
Control0..1
TypePeriod
28. Patient-cs.BirthdatePlace
Definition

A person’s birth details

ShortA person’s birth details
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Patient-cs.BirthdatePlace.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
32. Patient-cs.BirthdatePlace.DOB
Definition

The date on which the person was born

ShortThe date on which the person was born
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. Patient-cs.BirthdatePlace.DOBInfoSource
Definition

A code indicating the origin of date of birth information

ShortA code indicating the origin of date of birth information
Control0..1
TypeCodeableConcept
36. Patient-cs.BirthdatePlace.PlaceBirth
Definition

The town, suburb, city etc where the person was born

ShortThe town, suburb, city etc where the person was born
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. Patient-cs.BirthdatePlace.CountryBirthCode
Definition

Country where the person was born

ShortCountry where the person was born
Control0..1
TypeCodeableConcept
40. Patient-cs.BirthdatePlace.CountryBirthInfoSource
Definition

A code indicating the source of information supporting the code for country of birth

ShortA code indicating the source of information supporting the code for country of birth
Control0..1
TypeCodeableConcept
42. Patient-cs.Age
Definition

The age of the patient at the time the data was recorded.

ShortThe age of the patient at the time the data was recorded.
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. Patient-cs.Gender
Definition

A classification of the person's gender as self-identified by the person

ShortA classification of the person's gender as self-identified by the person
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. Patient-cs.Sex
Definition

A classification of the person's sex characteristics such as chromosomes, hormones and reproductive organs (Stats NZ Statistical standard for gender, sex, and variations of sex characteristics).

ShortA classification of the person's sex characteristics such as chromosomes, hormones and reproductive organs (Stats NZ Statistical standard for gender, sex, and variations of sex characteristics).
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
TypeCodeableConcept
48. Patient-cs.Ethnicity
Definition

A classification of the ethnicity of an individual person as self-identified by the person

ShortA classification of the ethnicity of an individual person as self-identified by the person
Control1..*
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
TypeCodeableConcept
50. Patient-cs.MotherBirthName
Definition

The full name of the person’s mother at the time of the mother’s birth

ShortThe full name of the person’s mother at the time of the mother’s birth
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. Patient-cs.NZResidencyCitizenship
Definition

New Zealand residency and citizenship details

ShortNew Zealand residency and citizenship details
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Patient-cs.NZResidencyCitizenship.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
56. Patient-cs.NZResidencyCitizenship.NZResidencyStatus
Definition

Code indicating whether the person holds a New Zealand residence class visa (either a resident visa or a permanent resident visa)

ShortCode indicating whether the person holds a New Zealand residence class visa (either a resident visa or a permanent resident visa)
Control0..1
TypeCodeableConcept
58. Patient-cs.NZResidencyCitizenship.NZResidencyStatusInfoSource
Definition

A code indicating the source of information of the person’s New Zealand residency status

ShortA code indicating the source of information of the person’s New Zealand residency status
Control0..1
TypeCodeableConcept
60. Patient-cs.NZResidencyCitizenship.NZCitizenshipStatus
Definition

This field indicates if the person holds New Zealand citizenship

ShortThis field indicates if the person holds New Zealand citizenship
Control0..1
TypeCodeableConcept
62. Patient-cs.NZResidencyCitizenship.NZCitizenshipStatusInformationSource
Definition

A code indicating the source of information of the person’s New Zealand citizenship status

ShortA code indicating the source of information of the person’s New Zealand citizenship status
Control0..1
TypeCodeableConcept
64. Patient-cs.DeathInformation
Definition

Information on patient death

ShortInformation on patient death
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Patient-cs.DeathInformation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
68. Patient-cs.DeathInformation.DateDeath
Definition

The date the person died

ShortThe date the person died
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
70. Patient-cs.DeathInformation.DateDeathInfoSource
Definition

A code indicating the valid date of death information source

ShortA code indicating the valid date of death information source
Control0..1
TypeCodeableConcept
72. Patient-cs.Address
Definition

The person's current address or location details if known (in NZ CIQ address profile format.

ShortThe person's current address or location details if known (in NZ CIQ address profile format.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. Patient-cs.Address.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
76. Patient-cs.Address.Type
Definition

The type of address, e.g. residential (physical), mailing (postal)

ShortThe type of address, e.g. residential (physical), mailing (postal)
Control0..1
TypeCodeableConcept
78. Patient-cs.Address.BuildingName
Definition

The name of the building or institution.

ShortThe name of the building or institution.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
80. Patient-cs.Address.StreetAddress1
Definition

The floor, unit and/or street address details.

ShortThe floor, unit and/or street address details.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
82. Patient-cs.Address.StreetAddress2
Definition

Other geographic information related to the address

ShortOther geographic information related to the address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
84. Patient-cs.Address.Suburb
Definition

The name of the suburb or district within a city/town.

ShortThe name of the suburb or district within a city/town.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
86. Patient-cs.Address.City
Definition

Patient.Address.City

ShortPatient.Address.City
Control0..1
TypeCodeableConcept
88. Patient-cs.Address.Postcode
Definition

The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.

ShortThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
90. Patient-cs.Address.CountryCode
Definition

The two character ISO code that forms part of the address.

ShortThe two character ISO code that forms part of the address.
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
92. Patient-cs.Address.AddressProtectedFlag
Definition

This indicator denotes that the person’s address information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s address information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
94. Patient-cs.Address.PermanentAddressFlag
Definition

An indicator used to denote an address is a permanent address

ShortAn indicator used to denote an address is a permanent address
Control0..1
TypeCodeableConcept
96. Patient-cs.Address.DateAddressPeriod
Definition

Date(s) that an address is effective from and/or to

ShortDate(s) that an address is effective from and/or to
Control0..1
TypePeriod
98. Patient-cs.Address.DomicileCode
Definition

New Zealand health domicile code representing a person’s usual residential address

ShortNew Zealand health domicile code representing a person’s usual residential address
Control0..1
TypeCodeableConcept
100. Patient-cs.Address.PrimaryAddressFlag
Definition

An indicator used to denote that the address is the primary address for the person

ShortAn indicator used to denote that the address is the primary address for the person
Control0..1
TypeCodeableConcept
102. Patient-cs.Language
Definition

A code representing a language spoken or understood by the person

ShortA code representing a language spoken or understood by the person
Control0..*
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
104. Patient-cs.ContactInformation
Definition

The method of electronic communication to be used to contact the patient

ShortThe method of electronic communication to be used to contact the patient
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. Patient-cs.ContactInformation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
108. Patient-cs.ContactInformation.ContactUsage
Definition

The classification that specifies the way in which the contact medium is intended to be used

ShortThe classification that specifies the way in which the contact medium is intended to be used
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
TypeCodeableConcept
110. Patient-cs.ContactInformation.ContactType
Definition

The code representing the type of electronic contact medium to be used

ShortThe code representing the type of electronic contact medium to be used
Control0..1
TypeCodeableConcept
112. Patient-cs.ContactInformation.ContactDetail
Definition

The contact details may comprise an electronic address or a number

ShortThe contact details may comprise an electronic address or a number
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
114. Patient-cs.ContactInformation.ContactProtectedFlag
Definition

This indicates that the contact information is confidential

ShortThis indicates that the contact information is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
116. Patient-cs.ContactInformation.ContactDetailsPeriod
Definition

Date contact details effective from and/or to

ShortDate contact details effective from and/or to
Control0..1
TypePeriod
118. Patient-cs.ContactInformation.PerferredContactFlag
Definition

This flag denotes that the contact details provided are the person’s preference

ShortThis flag denotes that the contact details provided are the person’s preference
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
120. Patient-cs.Title
Definition

Patient.Title

ShortPatient.Title
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. Patient-cs
Definition

Identifying and demographic details about the patient.

ShortPatient
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Patient-cs.Nhi
Definition

A unique identifier assigned to a person by the NHI system.

ShortA unique identifier assigned to a person by the NHI system.
Control1..1
TypeIdentifier
4. Patient-cs.NZName
Definition

A person’s name details

ShortA person’s name details
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Patient-cs.NZName.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
8. Patient-cs.NZName.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Patient-cs.NZName.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
10. Patient-cs.NZName.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Patient-cs.NZName.Title
Definition

The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person

ShortThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
Control0..1
TypeCodeableConcept
14. Patient-cs.NZName.GivenName
Definition

The person’s forename or given name at birth

ShortThe person’s forename or given name at birth
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. Patient-cs.NZName.OtherGivenName
Definition

The person’s other given names or middle name and initials, but not the family name at birth

ShortThe person’s other given names or middle name and initials, but not the family name at birth
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. Patient-cs.NZName.FamilyName
Definition

The family name (surname) of a person as distinct from their given, second and subsequent name(s)

ShortThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. Patient-cs.NZName.NameSuffix
Definition

The suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership

ShortThe suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. Patient-cs.NZName.PreferredNameIndicator
Definition

An indicator used to denote that a particular person name is the person’s preferred name

ShortAn indicator used to denote that a particular person name is the person’s preferred name
Control0..1
TypeCodeableConcept
24. Patient-cs.NZName.NameProtectionFlag
Definition

This indicator denotes that the person’s name information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s name information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. Patient-cs.NZName.age
Definition

Patient.NZName.age

ShortPatient.NZName.age
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. Patient-cs.NZName.NameInfoSource
Definition

A code indicating the name source

ShortA code indicating the name source
Control0..1
TypeCodeableConcept
30. Patient-cs.NZName.NameEffectivePeriod
Definition

The date(s) the name is effective from and/or to

ShortThe date(s) the name is effective from and/or to
Control0..1
TypePeriod
32. Patient-cs.BirthdatePlace
Definition

A person’s birth details

ShortA person’s birth details
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Patient-cs.BirthdatePlace.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
36. Patient-cs.BirthdatePlace.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Patient-cs.BirthdatePlace.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
38. Patient-cs.BirthdatePlace.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
40. Patient-cs.BirthdatePlace.DOB
Definition

The date on which the person was born

ShortThe date on which the person was born
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. Patient-cs.BirthdatePlace.DOBInfoSource
Definition

A code indicating the origin of date of birth information

ShortA code indicating the origin of date of birth information
Control0..1
TypeCodeableConcept
44. Patient-cs.BirthdatePlace.PlaceBirth
Definition

The town, suburb, city etc where the person was born

ShortThe town, suburb, city etc where the person was born
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. Patient-cs.BirthdatePlace.CountryBirthCode
Definition

Country where the person was born

ShortCountry where the person was born
Control0..1
TypeCodeableConcept
48. Patient-cs.BirthdatePlace.CountryBirthInfoSource
Definition

A code indicating the source of information supporting the code for country of birth

ShortA code indicating the source of information supporting the code for country of birth
Control0..1
TypeCodeableConcept
50. Patient-cs.Age
Definition

The age of the patient at the time the data was recorded.

ShortThe age of the patient at the time the data was recorded.
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. Patient-cs.Gender
Definition

A classification of the person's gender as self-identified by the person

ShortA classification of the person's gender as self-identified by the person
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
54. Patient-cs.Sex
Definition

A classification of the person's sex characteristics such as chromosomes, hormones and reproductive organs (Stats NZ Statistical standard for gender, sex, and variations of sex characteristics).

ShortA classification of the person's sex characteristics such as chromosomes, hormones and reproductive organs (Stats NZ Statistical standard for gender, sex, and variations of sex characteristics).
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
TypeCodeableConcept
56. Patient-cs.Ethnicity
Definition

A classification of the ethnicity of an individual person as self-identified by the person

ShortA classification of the ethnicity of an individual person as self-identified by the person
Control1..*
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
TypeCodeableConcept
58. Patient-cs.MotherBirthName
Definition

The full name of the person’s mother at the time of the mother’s birth

ShortThe full name of the person’s mother at the time of the mother’s birth
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
60. Patient-cs.NZResidencyCitizenship
Definition

New Zealand residency and citizenship details

ShortNew Zealand residency and citizenship details
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Patient-cs.NZResidencyCitizenship.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
64. Patient-cs.NZResidencyCitizenship.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Patient-cs.NZResidencyCitizenship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
66. Patient-cs.NZResidencyCitizenship.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
68. Patient-cs.NZResidencyCitizenship.NZResidencyStatus
Definition

Code indicating whether the person holds a New Zealand residence class visa (either a resident visa or a permanent resident visa)

ShortCode indicating whether the person holds a New Zealand residence class visa (either a resident visa or a permanent resident visa)
Control0..1
TypeCodeableConcept
70. Patient-cs.NZResidencyCitizenship.NZResidencyStatusInfoSource
Definition

A code indicating the source of information of the person’s New Zealand residency status

ShortA code indicating the source of information of the person’s New Zealand residency status
Control0..1
TypeCodeableConcept
72. Patient-cs.NZResidencyCitizenship.NZCitizenshipStatus
Definition

This field indicates if the person holds New Zealand citizenship

ShortThis field indicates if the person holds New Zealand citizenship
Control0..1
TypeCodeableConcept
74. Patient-cs.NZResidencyCitizenship.NZCitizenshipStatusInformationSource
Definition

A code indicating the source of information of the person’s New Zealand citizenship status

ShortA code indicating the source of information of the person’s New Zealand citizenship status
Control0..1
TypeCodeableConcept
76. Patient-cs.DeathInformation
Definition

Information on patient death

ShortInformation on patient death
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. Patient-cs.DeathInformation.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
80. Patient-cs.DeathInformation.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Patient-cs.DeathInformation.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
82. Patient-cs.DeathInformation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
84. Patient-cs.DeathInformation.DateDeath
Definition

The date the person died

ShortThe date the person died
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
86. Patient-cs.DeathInformation.DateDeathInfoSource
Definition

A code indicating the valid date of death information source

ShortA code indicating the valid date of death information source
Control0..1
TypeCodeableConcept
88. Patient-cs.Address
Definition

The person's current address or location details if known (in NZ CIQ address profile format.

ShortThe person's current address or location details if known (in NZ CIQ address profile format.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. Patient-cs.Address.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
92. Patient-cs.Address.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Patient-cs.Address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
94. Patient-cs.Address.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
96. Patient-cs.Address.Type
Definition

The type of address, e.g. residential (physical), mailing (postal)

ShortThe type of address, e.g. residential (physical), mailing (postal)
Control0..1
TypeCodeableConcept
98. Patient-cs.Address.BuildingName
Definition

The name of the building or institution.

ShortThe name of the building or institution.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
100. Patient-cs.Address.StreetAddress1
Definition

The floor, unit and/or street address details.

ShortThe floor, unit and/or street address details.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
102. Patient-cs.Address.StreetAddress2
Definition

Other geographic information related to the address

ShortOther geographic information related to the address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
104. Patient-cs.Address.Suburb
Definition

The name of the suburb or district within a city/town.

ShortThe name of the suburb or district within a city/town.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
106. Patient-cs.Address.City
Definition

Patient.Address.City

ShortPatient.Address.City
Control0..1
TypeCodeableConcept
108. Patient-cs.Address.Postcode
Definition

The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.

ShortThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
110. Patient-cs.Address.CountryCode
Definition

The two character ISO code that forms part of the address.

ShortThe two character ISO code that forms part of the address.
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
112. Patient-cs.Address.AddressProtectedFlag
Definition

This indicator denotes that the person’s address information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s address information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
114. Patient-cs.Address.PermanentAddressFlag
Definition

An indicator used to denote an address is a permanent address

ShortAn indicator used to denote an address is a permanent address
Control0..1
TypeCodeableConcept
116. Patient-cs.Address.DateAddressPeriod
Definition

Date(s) that an address is effective from and/or to

ShortDate(s) that an address is effective from and/or to
Control0..1
TypePeriod
118. Patient-cs.Address.DomicileCode
Definition

New Zealand health domicile code representing a person’s usual residential address

ShortNew Zealand health domicile code representing a person’s usual residential address
Control0..1
TypeCodeableConcept
120. Patient-cs.Address.PrimaryAddressFlag
Definition

An indicator used to denote that the address is the primary address for the person

ShortAn indicator used to denote that the address is the primary address for the person
Control0..1
TypeCodeableConcept
122. Patient-cs.Language
Definition

A code representing a language spoken or understood by the person

ShortA code representing a language spoken or understood by the person
Control0..*
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
124. Patient-cs.ContactInformation
Definition

The method of electronic communication to be used to contact the patient

ShortThe method of electronic communication to be used to contact the patient
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. Patient-cs.ContactInformation.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
128. Patient-cs.ContactInformation.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Patient-cs.ContactInformation.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
130. Patient-cs.ContactInformation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
132. Patient-cs.ContactInformation.ContactUsage
Definition

The classification that specifies the way in which the contact medium is intended to be used

ShortThe classification that specifies the way in which the contact medium is intended to be used
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
TypeCodeableConcept
134. Patient-cs.ContactInformation.ContactType
Definition

The code representing the type of electronic contact medium to be used

ShortThe code representing the type of electronic contact medium to be used
Control0..1
TypeCodeableConcept
136. Patient-cs.ContactInformation.ContactDetail
Definition

The contact details may comprise an electronic address or a number

ShortThe contact details may comprise an electronic address or a number
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
138. Patient-cs.ContactInformation.ContactProtectedFlag
Definition

This indicates that the contact information is confidential

ShortThis indicates that the contact information is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
140. Patient-cs.ContactInformation.ContactDetailsPeriod
Definition

Date contact details effective from and/or to

ShortDate contact details effective from and/or to
Control0..1
TypePeriod
142. Patient-cs.ContactInformation.PerferredContactFlag
Definition

This flag denotes that the contact details provided are the person’s preference

ShortThis flag denotes that the contact details provided are the person’s preference
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
144. Patient-cs.Title
Definition

Patient.Title

ShortPatient.Title
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension