New Zealand NHI IG
1.6.5 - Release

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

## Logical Model: PatientModel - Detailed Descriptions

Active as of 2026-02-09

Definitions for the PatientModel logical model.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

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

0. PatientModel
Definition | Representing a person receiving healthcare Base definition for all elements in a resource.
Short | PatientBase for all elements
Control | 0..* This element is affected by the following invariants: ele-1
Is Modifier | false
Logical Model | Instances of this logical model are not marked to be the target of a Reference
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. PatientModel.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
4. PatientModel.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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())
Slicing | This element introduces a set of slices on `PatientModel.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. PatientModel.name
Definition | Name of the practitioner
Short | Name of the practitioner
Control | 0..1
Type | HumanName
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. PatientModel.name.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
10. PatientModel.name.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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())
Slicing | This element introduces a set of slices on `PatientModel.name.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
12. PatientModel.name.use
Definition | Identifies the purpose for this name.
Short | usual | official | temp | nickname | anonymous | old | maiden
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old.
Control | 0..1
Binding | The codes SHALL be taken from NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/name-use|4.0.1` ) The use of a human name.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. PatientModel.name.text
Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
Short | Text representation of the full name
Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | A renderable, unencoded form.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. PatientModel.name.family
Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
Short | Family name (often called 'Surname')
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | surname
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. PatientModel.name.given
Definition | Given name.
Short | Given names (not always 'first'). Includes middle names
Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | first name, middle name
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. PatientModel.name.prefix
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
Short | Parts that come before the name
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. PatientModel.name.suffix
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
Short | Parts that come after the name
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. PatientModel.name.period
Definition | Indicates the period of time when this name was valid for the named person.
Short | Time period when name was/is in use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Requirements | Allows names to be placed in historical context.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. PatientModel.name.source
Definition | The source of the name
Short | The source of the name
Control | 0..1
Type | CodeableConcept
28. PatientModel.gender
Definition | The patients administrative gender
Short | The patients administrative gender
Control | 0..1
Binding | The codes SHALL be taken from AdministrativeGender (required to `http://hl7.org/fhir/ValueSet/administrative-gender` )
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. PatientModel.gender.id
Definition | unique id for the element within a resource (for internal references) Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
32. PatientModel.gender.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
34. PatientModel.gender.value
Definition | The actual value
Short | Primitive value for string
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Max Length: | 1048576
36. PatientModel.gender.originalText
Definition | The text from which the gender was derived
Short | The text from which the gender was derived
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
38. PatientModel.birthDate
Definition | Date of Birth
Short | Date of Birth
Control | 0..1
Type | date
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. PatientModel.birthDate.id
Definition | unique id for the element within a resource (for internal references) Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
42. PatientModel.birthDate.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
44. PatientModel.birthDate.value
Definition | The actual value
Short | Primitive value for date
Control | 0..1
Type | date
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
46. PatientModel.birthDate.source
Definition | The source of the Date of Birth
Short | The source of the Date of Birth
Control | 0..1
Type | CodeableConcept
48. PatientModel.deathDate
Definition | Date of Death
Short | Date of Death
Control | 0..1
Type | date
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. PatientModel.deathDate.id
Definition | unique id for the element within a resource (for internal references) Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
52. PatientModel.deathDate.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
54. PatientModel.deathDate.value
Definition | The actual value
Short | Primitive value for date
Control | 0..1
Type | date
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
56. PatientModel.deathDate.source
Definition | The source of the Date of Death
Short | The source of the Date of Death
Control | 0..1
Type | CodeableConcept
58. PatientModel.ethnicity
Definition | Ethnicity of the provider
Short | Ethnicity of the provider
Control | 0..6
Binding | The codes SHALL be taken from Ethnicity of a person (required to `https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code` )
Type | CodeableConcept
60. PatientModel.nhi
Definition | National Health Identifier
Short | National Health Identifier
Control | 1..1
Type | Identifier
62. PatientModel.citizenship
Definition | NZ Citizenship status
Short | NZ Citizenship status
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. PatientModel.citizenship.id
Definition | unique id for the element within a resource (for internal references) Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
66. PatientModel.citizenship.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
68. PatientModel.citizenship.value
Definition | The actual value
Short | Primitive value for string
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Max Length: | 1048576
70. PatientModel.citizenship.source
Definition | The source of the citizenship status
Short | The source of the citizenship status
Control | 0..1
Type | CodeableConcept
72. PatientModel.birthPlace
Definition | Place of Birth
Short | Place of Birth
Control | 0..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. PatientModel.birthPlace.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
76. PatientModel.birthPlace.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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())
Slicing | This element introduces a set of slices on `PatientModel.birthPlace.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
78. PatientModel.birthPlace.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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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())
80. PatientModel.birthPlace.country
Definition | Country of Birth
Short | Country of Birth
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
82. PatientModel.birthPlace.place
Definition | Area within country
Short | Area within country
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
84. PatientModel.birthPlace.source
Definition | The source of the Birth Place
Short | The source of the Birth Place
Control | 0..1
Type | CodeableConcept
86. PatientModel.residency
Definition | residency status
Short | residency status
Control | 0..1
Type | CodeableConcept
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. PatientModel.residency.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
90. PatientModel.residency.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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())
Slicing | This element introduces a set of slices on `PatientModel.residency.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
92. PatientModel.residency.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. PatientModel.residency.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. PatientModel.residency.source
Definition | The source of the residency status
Short | The source of the residency status
Control | 0..1
Type | CodeableConcept

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

0. PatientModel
Definition | Representing a person receiving healthcare
Short | Patient
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. PatientModel.name
Definition | Name of the practitioner
Short | Name of the practitioner
Control | 0..1
Type | HumanName
4. PatientModel.name.source
Definition | The source of the name
Short | The source of the name
Control | 0..1
Type | CodeableConcept
6. PatientModel.gender
Definition | The patients administrative gender
Short | The patients administrative gender
Control | 0..1
Binding | The codes SHALL be taken from AdministrativeGender (required to `http://hl7.org/fhir/ValueSet/administrative-gender` )
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
8. PatientModel.gender.originalText
Definition | The text from which the gender was derived
Short | The text from which the gender was derived
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
10. PatientModel.birthDate
Definition | Date of Birth
Short | Date of Birth
Control | 0..1
Type | date
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
12. PatientModel.birthDate.source
Definition | The source of the Date of Birth
Short | The source of the Date of Birth
Control | 0..1
Type | CodeableConcept
14. PatientModel.deathDate
Definition | Date of Death
Short | Date of Death
Control | 0..1
Type | date
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
16. PatientModel.deathDate.source
Definition | The source of the Date of Death
Short | The source of the Date of Death
Control | 0..1
Type | CodeableConcept
18. PatientModel.ethnicity
Definition | Ethnicity of the provider
Short | Ethnicity of the provider
Control | 0..6
Binding | The codes SHALL be taken from Ethnicity of a person (required to `https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code` )
Type | CodeableConcept
20. PatientModel.nhi
Definition | National Health Identifier
Short | National Health Identifier
Control | 1..1
Type | Identifier
22. PatientModel.citizenship
Definition | NZ Citizenship status
Short | NZ Citizenship status
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
24. PatientModel.citizenship.source
Definition | The source of the citizenship status
Short | The source of the citizenship status
Control | 0..1
Type | CodeableConcept
26. PatientModel.birthPlace
Definition | Place of Birth
Short | Place of Birth
Control | 0..1
Type | BackboneElement
28. PatientModel.birthPlace.country
Definition | Country of Birth
Short | Country of Birth
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
30. PatientModel.birthPlace.place
Definition | Area within country
Short | Area within country
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
32. PatientModel.birthPlace.source
Definition | The source of the Birth Place
Short | The source of the Birth Place
Control | 0..1
Type | CodeableConcept
34. PatientModel.residency
Definition | residency status
Short | residency status
Control | 0..1
Type | CodeableConcept
36. PatientModel.residency.source
Definition | The source of the residency status
Short | The source of the residency status
Control | 0..1
Type | CodeableConcept

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

0. PatientModel
Definition | Representing a person receiving healthcare
Short | Patient
Control | 0..* This element is affected by the following invariants: ele-1
Is Modifier | false
Logical Model | Instances of this logical model are not marked to be the target of a Reference
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
2. PatientModel.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
4. PatientModel.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
Slicing | This element introduces a set of slices on `PatientModel.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. PatientModel.name
Definition | Name of the practitioner
Short | Name of the practitioner
Control | 0..1
Type | HumanName
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. PatientModel.name.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
10. PatientModel.name.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
Slicing | This element introduces a set of slices on `PatientModel.name.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
12. PatientModel.name.use
Definition | Identifies the purpose for this name.
Short | usual | official | temp | nickname | anonymous | old | maiden
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old.
Control | 0..1
Binding | The codes SHALL be taken from NameUse (required to `http://hl7.org/fhir/ValueSet/name-use|4.0.1` ) The use of a human name.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. PatientModel.name.text
Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
Short | Text representation of the full name
Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | A renderable, unencoded form.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
16. PatientModel.name.family
Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
Short | Family name (often called 'Surname')
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | surname
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
18. PatientModel.name.given
Definition | Given name.
Short | Given names (not always 'first'). Includes middle names
Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | first name, middle name
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. PatientModel.name.prefix
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
Short | Parts that come before the name
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. PatientModel.name.suffix
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
Short | Parts that come after the name
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. PatientModel.name.period
Definition | Indicates the period of time when this name was valid for the named person.
Short | Time period when name was/is in use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Requirements | Allows names to be placed in historical context.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. PatientModel.name.source
Definition | The source of the name
Short | The source of the name
Control | 0..1
Type | CodeableConcept
28. PatientModel.gender
Definition | The patients administrative gender
Short | The patients administrative gender
Control | 0..1
Binding | The codes SHALL be taken from AdministrativeGender (required to `http://hl7.org/fhir/ValueSet/administrative-gender` )
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. PatientModel.gender.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
32. PatientModel.gender.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
34. PatientModel.gender.value
Definition | The actual value
Short | Primitive value for string
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Max Length: | 1048576
36. PatientModel.gender.originalText
Definition | The text from which the gender was derived
Short | The text from which the gender was derived
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
38. PatientModel.birthDate
Definition | Date of Birth
Short | Date of Birth
Control | 0..1
Type | date
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. PatientModel.birthDate.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
42. PatientModel.birthDate.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
44. PatientModel.birthDate.value
Definition | The actual value
Short | Primitive value for date
Control | 0..1
Type | date
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
46. PatientModel.birthDate.source
Definition | The source of the Date of Birth
Short | The source of the Date of Birth
Control | 0..1
Type | CodeableConcept
48. PatientModel.deathDate
Definition | Date of Death
Short | Date of Death
Control | 0..1
Type | date
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. PatientModel.deathDate.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
52. PatientModel.deathDate.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
54. PatientModel.deathDate.value
Definition | The actual value
Short | Primitive value for date
Control | 0..1
Type | date
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
56. PatientModel.deathDate.source
Definition | The source of the Date of Death
Short | The source of the Date of Death
Control | 0..1
Type | CodeableConcept
58. PatientModel.ethnicity
Definition | Ethnicity of the provider
Short | Ethnicity of the provider
Control | 0..6
Binding | The codes SHALL be taken from Ethnicity of a person (required to `https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code` )
Type | CodeableConcept
60. PatientModel.nhi
Definition | National Health Identifier
Short | National Health Identifier
Control | 1..1
Type | Identifier
62. PatientModel.citizenship
Definition | NZ Citizenship status
Short | NZ Citizenship status
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. PatientModel.citizenship.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
66. PatientModel.citizenship.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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. PatientModel.citizenship.value
Definition | The actual value
Short | Primitive value for string
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Max Length: | 1048576
70. PatientModel.citizenship.source
Definition | The source of the citizenship status
Short | The source of the citizenship status
Control | 0..1
Type | CodeableConcept
72. PatientModel.birthPlace
Definition | Place of Birth
Short | Place of Birth
Control | 0..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. PatientModel.birthPlace.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
76. PatientModel.birthPlace.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
Slicing | This element introduces a set of slices on `PatientModel.birthPlace.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
78. PatientModel.birthPlace.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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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()`)
80. PatientModel.birthPlace.country
Definition | Country of Birth
Short | Country of Birth
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
82. PatientModel.birthPlace.place
Definition | Area within country
Short | Area within country
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
84. PatientModel.birthPlace.source
Definition | The source of the Birth Place
Short | The source of the Birth Place
Control | 0..1
Type | CodeableConcept
86. PatientModel.residency
Definition | residency status
Short | residency status
Control | 0..1
Type | CodeableConcept
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. PatientModel.residency.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
90. PatientModel.residency.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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
Slicing | This element introduces a set of slices on `PatientModel.residency.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
92. PatientModel.residency.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
94. PatientModel.residency.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
96. PatientModel.residency.source
Definition | The source of the residency status
Short | The source of the residency status
Control | 0..1
Type | CodeableConcept