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: Patient

Official URL: http://hl7.org.nz/fhir/ig/nhi/StructureDefinition/PatientModel Version: 1.6.5
Active as of 2025-10-06 Computable Name: PatientModel

Representing a person receiving healthcare

Usages:

  • This Logical Model is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PatientModel 0..* Element Patient

Elements defined in Ancestors:@id, extension
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... name 0..1 HumanName Name of the practitioner
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family Σ 0..1 string Family name (often called 'Surname')
.... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
.... source 0..1 CodeableConcept The source of the name
.... @id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
.... @value 0..1 string Primitive value for string
Max Length:1048576
.... originalText 0..1 string The text from which the gender was derived
... birthDate 0..1 date Date of Birth
.... @id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
.... @value 0..1 date Primitive value for date
.... source 0..1 CodeableConcept The source of the Date of Birth
... deathDate 0..1 date Date of Death
.... @id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
.... @value 0..1 date Primitive value for date
.... source 0..1 CodeableConcept The source of the Date of Death
... ethnicity 0..6 CodeableConcept Ethnicity of the provider
Binding: Ethnicity of a person (required)
... nhi 1..1 Identifier National Health Identifier
... citizenship 0..1 string NZ Citizenship status
.... @id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
.... @value 0..1 string Primitive value for string
Max Length:1048576
.... source 0..1 CodeableConcept The source of the citizenship status
... birthPlace 0..1 BackboneElement Place of Birth
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... country 0..1 string Country of Birth
.... place 0..1 string Area within country
.... source 0..1 CodeableConcept The source of the Birth Place
... residency 0..1 CodeableConcept residency status
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
.... source 0..1 CodeableConcept The source of the residency status

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PatientModel.name.use Base required NameUse 📍4.0.1 FHIR Std.
PatientModel.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
PatientModel.ethnicity Base required Ethnicity of a person 📦2.1.0 HL7® FHIR® New Zealand Base Implementation Guide v2.0

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PatientModel 0..* Element Patient

Elements defined in Ancestors:@id, extension
... name 0..1 HumanName Name of the practitioner
.... source 0..1 CodeableConcept The source of the name
... gender 0..1 string The patients administrative gender
Binding: AdministrativeGender (required)
.... originalText 0..1 string The text from which the gender was derived
... birthDate 0..1 date Date of Birth
.... source 0..1 CodeableConcept The source of the Date of Birth
.... source 0..1 CodeableConcept The source of the Date of Death
... ethnicity 0..6 CodeableConcept Ethnicity of the provider
Binding: Ethnicity of a person (required)
... nhi 1..1 Identifier National Health Identifier
... citizenship 0..1 string NZ Citizenship status
.... source 0..1 CodeableConcept The source of the citizenship status
... birthPlace 0..1 BackboneElement Place of Birth
.... country 0..1 string Country of Birth
.... place 0..1 string Area within country
.... source 0..1 CodeableConcept The source of the Birth Place
... residency 0..1 CodeableConcept residency status
.... source 0..1 CodeableConcept The source of the residency status

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
PatientModel.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
PatientModel.ethnicity Base required Ethnicity of a person 📦2.1.0 HL7® FHIR® New Zealand Base Implementation Guide v2.0
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PatientModel 0..* Element Patient

Elements defined in Ancestors:@id, extension
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... name 0..1 HumanName Name of the practitioner
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family Σ 0..1 string Family name (often called 'Surname')
.... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
.... source 0..1 CodeableConcept The source of the name
.... @id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
.... @value 0..1 string Primitive value for string
Max Length:1048576
.... originalText 0..1 string The text from which the gender was derived
... birthDate 0..1 date Date of Birth
.... @id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
.... @value 0..1 date Primitive value for date
.... source 0..1 CodeableConcept The source of the Date of Birth
... deathDate 0..1 date Date of Death
.... @id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
.... @value 0..1 date Primitive value for date
.... source 0..1 CodeableConcept The source of the Date of Death
... ethnicity 0..6 CodeableConcept Ethnicity of the provider
Binding: Ethnicity of a person (required)
... nhi 1..1 Identifier National Health Identifier
... citizenship 0..1 string NZ Citizenship status
.... @id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
.... @value 0..1 string Primitive value for string
Max Length:1048576
.... source 0..1 CodeableConcept The source of the citizenship status
... birthPlace 0..1 BackboneElement Place of Birth
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... country 0..1 string Country of Birth
.... place 0..1 string Area within country
.... source 0..1 CodeableConcept The source of the Birth Place
... residency 0..1 CodeableConcept residency status
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
.... source 0..1 CodeableConcept The source of the residency status

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PatientModel.name.use Base required NameUse 📍4.0.1 FHIR Std.
PatientModel.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
PatientModel.ethnicity Base required Ethnicity of a person 📦2.1.0 HL7® FHIR® New Zealand Base Implementation Guide v2.0

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Element

Summary

Mandatory: 0 element(1 nested mandatory element)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PatientModel 0..* Element Patient

Elements defined in Ancestors:@id, extension
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... name 0..1 HumanName Name of the practitioner
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family Σ 0..1 string Family name (often called 'Surname')
.... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
.... source 0..1 CodeableConcept The source of the name
.... @id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
.... @value 0..1 string Primitive value for string
Max Length:1048576
.... originalText 0..1 string The text from which the gender was derived
... birthDate 0..1 date Date of Birth
.... @id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
.... @value 0..1 date Primitive value for date
.... source 0..1 CodeableConcept The source of the Date of Birth
... deathDate 0..1 date Date of Death
.... @id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
.... @value 0..1 date Primitive value for date
.... source 0..1 CodeableConcept The source of the Date of Death
... ethnicity 0..6 CodeableConcept Ethnicity of the provider
Binding: Ethnicity of a person (required)
... nhi 1..1 Identifier National Health Identifier
... citizenship 0..1 string NZ Citizenship status
.... @id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
.... @value 0..1 string Primitive value for string
Max Length:1048576
.... source 0..1 CodeableConcept The source of the citizenship status
... birthPlace 0..1 BackboneElement Place of Birth
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... country 0..1 string Country of Birth
.... place 0..1 string Area within country
.... source 0..1 CodeableConcept The source of the Birth Place
... residency 0..1 CodeableConcept residency status
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
.... source 0..1 CodeableConcept The source of the residency status

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PatientModel.name.use Base required NameUse 📍4.0.1 FHIR Std.
PatientModel.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
PatientModel.ethnicity Base required Ethnicity of a person 📦2.1.0 HL7® FHIR® New Zealand Base Implementation Guide v2.0

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PatientModel 0..* Element Patient

Elements defined in Ancestors:@id, extension
... name 0..1 HumanName Name of the practitioner
.... source 0..1 CodeableConcept The source of the name
... gender 0..1 string The patients administrative gender
Binding: AdministrativeGender (required)
.... originalText 0..1 string The text from which the gender was derived
... birthDate 0..1 date Date of Birth
.... source 0..1 CodeableConcept The source of the Date of Birth
.... source 0..1 CodeableConcept The source of the Date of Death
... ethnicity 0..6 CodeableConcept Ethnicity of the provider
Binding: Ethnicity of a person (required)
... nhi 1..1 Identifier National Health Identifier
... citizenship 0..1 string NZ Citizenship status
.... source 0..1 CodeableConcept The source of the citizenship status
... birthPlace 0..1 BackboneElement Place of Birth
.... country 0..1 string Country of Birth
.... place 0..1 string Area within country
.... source 0..1 CodeableConcept The source of the Birth Place
... residency 0..1 CodeableConcept residency status
.... source 0..1 CodeableConcept The source of the residency status

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
PatientModel.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
PatientModel.ethnicity Base required Ethnicity of a person 📦2.1.0 HL7® FHIR® New Zealand Base Implementation Guide v2.0

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PatientModel 0..* Element Patient

Elements defined in Ancestors:@id, extension
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... name 0..1 HumanName Name of the practitioner
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family Σ 0..1 string Family name (often called 'Surname')
.... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
.... source 0..1 CodeableConcept The source of the name
.... @id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
.... @value 0..1 string Primitive value for string
Max Length:1048576
.... originalText 0..1 string The text from which the gender was derived
... birthDate 0..1 date Date of Birth
.... @id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
.... @value 0..1 date Primitive value for date
.... source 0..1 CodeableConcept The source of the Date of Birth
... deathDate 0..1 date Date of Death
.... @id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
.... @value 0..1 date Primitive value for date
.... source 0..1 CodeableConcept The source of the Date of Death
... ethnicity 0..6 CodeableConcept Ethnicity of the provider
Binding: Ethnicity of a person (required)
... nhi 1..1 Identifier National Health Identifier
... citizenship 0..1 string NZ Citizenship status
.... @id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional content defined by implementations
.... @value 0..1 string Primitive value for string
Max Length:1048576
.... source 0..1 CodeableConcept The source of the citizenship status
... birthPlace 0..1 BackboneElement Place of Birth
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... country 0..1 string Country of Birth
.... place 0..1 string Area within country
.... source 0..1 CodeableConcept The source of the Birth Place
... residency 0..1 CodeableConcept residency status
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
.... source 0..1 CodeableConcept The source of the residency status

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PatientModel.name.use Base required NameUse 📍4.0.1 FHIR Std.
PatientModel.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
PatientModel.ethnicity Base required Ethnicity of a person 📦2.1.0 HL7® FHIR® New Zealand Base Implementation Guide v2.0

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Element

Summary

Mandatory: 0 element(1 nested mandatory element)

 

Other representations of profile: CSV, Excel