New Zealand NHI IG
1.4.1 - Release

New Zealand NHI IG - Local Development build (v1.4.1) 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.4.1
Active as of 2024-01-24 Computable Name: PatientModel

Representing a person receiving healthcare

Usage:

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

Formal Views of Profile Content

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

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraintsdoco
.. PatientModel 0..*Element
Elements defined in Ancestors: @id, extension
Patient
Instances of this logical model are not marked to be the target of a Reference
... name 0..1HumanNameName of the practitioner
.... source 0..1CodeableConceptThe source of the name
... gender 0..1stringThe patients administrative gender
Binding: AdministrativeGender (required)
.... originalText 0..1stringThe text from which the gender was derived
... birthDate 0..1dateDate of Birth
.... source 0..1CodeableConceptThe source of the Date of Birth
.... source 0..1CodeableConceptThe source of the Date of Death
... ethnicity 0..6CodeableConceptEthnicity of the provider
Binding: Ethnicity of a person (required)
... nhi 1..1IdentifierNational Health Identifier
... citizenship 0..1stringNZ Citizenship status
.... source 0..1CodeableConceptThe source of the citizenship status
... birthPlace 0..1BackboneElementPlace of Birth
.... country 0..1stringCountry of Birth
.... place 0..1stringArea within country
.... source 0..1CodeableConceptThe source of the Birth Place
... residency 0..1CodeableConceptresidency status
.... source 0..1CodeableConceptThe source of the residency status

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PatientModel.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
PatientModel.ethnicityrequiredEthnicity
https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
NameFlagsCard.TypeDescription & Constraintsdoco
.. PatientModel 0..*Element
Elements defined in Ancestors: @id, extension
Patient
Instances of this logical model are not marked to be the target of a Reference
... name 0..1HumanNameName of the practitioner
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... source 0..1CodeableConceptThe source of the name
... gender 0..1stringThe patients administrative gender
Binding: AdministrativeGender (required)
.... originalText 0..1stringThe text from which the gender was derived
... birthDate 0..1dateDate of Birth
.... source 0..1CodeableConceptThe source of the Date of Birth
.... source 0..1CodeableConceptThe source of the Date of Death
... ethnicity 0..6CodeableConceptEthnicity of the provider
Binding: Ethnicity of a person (required)
... nhi 1..1IdentifierNational Health Identifier
... citizenship 0..1stringNZ Citizenship status
.... source 0..1CodeableConceptThe source of the citizenship status
... birthPlace 0..1BackboneElementPlace of Birth
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... country 0..1stringCountry of Birth
.... place 0..1stringArea within country
.... source 0..1CodeableConceptThe source of the Birth Place
... residency 0..1CodeableConceptresidency status
.... source 0..1CodeableConceptThe source of the residency status

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PatientModel.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
PatientModel.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
PatientModel.ethnicityrequiredEthnicity
https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
NameFlagsCard.TypeDescription & Constraintsdoco
.. PatientModel 0..*Element
Elements defined in Ancestors: @id, extension
Patient
Instances of this logical model are not marked to be the target of a Reference
... @id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... name 0..1HumanNameName of the practitioner
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ0..1stringText representation of the full name
.... family Σ0..1stringFamily name (often called 'Surname')
.... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
.... source 0..1CodeableConceptThe source of the name
.... @id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... @value 0..1stringPrimitive value for string
Max Length: 1048576
.... originalText 0..1stringThe text from which the gender was derived
... birthDate 0..1dateDate of Birth
.... @id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... @value 0..1datePrimitive value for date
.... source 0..1CodeableConceptThe source of the Date of Birth
... deathDate 0..1dateDate of Death
.... @id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... @value 0..1datePrimitive value for date
.... source 0..1CodeableConceptThe source of the Date of Death
... ethnicity 0..6CodeableConceptEthnicity of the provider
Binding: Ethnicity of a person (required)
... nhi 1..1IdentifierNational Health Identifier
... citizenship 0..1stringNZ Citizenship status
.... @id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... @value 0..1stringPrimitive value for string
Max Length: 1048576
.... source 0..1CodeableConceptThe source of the citizenship status
... birthPlace 0..1BackboneElementPlace of Birth
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... country 0..1stringCountry of Birth
.... place 0..1stringArea within country
.... source 0..1CodeableConceptThe source of the Birth Place
... residency 0..1CodeableConceptresidency status
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
.... source 0..1CodeableConceptThe source of the residency status

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PatientModel.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
PatientModel.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
PatientModel.ethnicityrequiredEthnicity
https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code

This structure is derived from Element

Summary

Mandatory: 0 element (1 nested mandatory element)

Differential View

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraintsdoco
.. PatientModel 0..*Element
Elements defined in Ancestors: @id, extension
Patient
Instances of this logical model are not marked to be the target of a Reference
... name 0..1HumanNameName of the practitioner
.... source 0..1CodeableConceptThe source of the name
... gender 0..1stringThe patients administrative gender
Binding: AdministrativeGender (required)
.... originalText 0..1stringThe text from which the gender was derived
... birthDate 0..1dateDate of Birth
.... source 0..1CodeableConceptThe source of the Date of Birth
.... source 0..1CodeableConceptThe source of the Date of Death
... ethnicity 0..6CodeableConceptEthnicity of the provider
Binding: Ethnicity of a person (required)
... nhi 1..1IdentifierNational Health Identifier
... citizenship 0..1stringNZ Citizenship status
.... source 0..1CodeableConceptThe source of the citizenship status
... birthPlace 0..1BackboneElementPlace of Birth
.... country 0..1stringCountry of Birth
.... place 0..1stringArea within country
.... source 0..1CodeableConceptThe source of the Birth Place
... residency 0..1CodeableConceptresidency status
.... source 0..1CodeableConceptThe source of the residency status

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PatientModel.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
PatientModel.ethnicityrequiredEthnicity
https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PatientModel 0..*Element
Elements defined in Ancestors: @id, extension
Patient
Instances of this logical model are not marked to be the target of a Reference
... name 0..1HumanNameName of the practitioner
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... source 0..1CodeableConceptThe source of the name
... gender 0..1stringThe patients administrative gender
Binding: AdministrativeGender (required)
.... originalText 0..1stringThe text from which the gender was derived
... birthDate 0..1dateDate of Birth
.... source 0..1CodeableConceptThe source of the Date of Birth
.... source 0..1CodeableConceptThe source of the Date of Death
... ethnicity 0..6CodeableConceptEthnicity of the provider
Binding: Ethnicity of a person (required)
... nhi 1..1IdentifierNational Health Identifier
... citizenship 0..1stringNZ Citizenship status
.... source 0..1CodeableConceptThe source of the citizenship status
... birthPlace 0..1BackboneElementPlace of Birth
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... country 0..1stringCountry of Birth
.... place 0..1stringArea within country
.... source 0..1CodeableConceptThe source of the Birth Place
... residency 0..1CodeableConceptresidency status
.... source 0..1CodeableConceptThe source of the residency status

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PatientModel.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
PatientModel.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
PatientModel.ethnicityrequiredEthnicity
https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PatientModel 0..*Element
Elements defined in Ancestors: @id, extension
Patient
Instances of this logical model are not marked to be the target of a Reference
... @id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... name 0..1HumanNameName of the practitioner
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ0..1stringText representation of the full name
.... family Σ0..1stringFamily name (often called 'Surname')
.... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
.... source 0..1CodeableConceptThe source of the name
.... @id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... @value 0..1stringPrimitive value for string
Max Length: 1048576
.... originalText 0..1stringThe text from which the gender was derived
... birthDate 0..1dateDate of Birth
.... @id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... @value 0..1datePrimitive value for date
.... source 0..1CodeableConceptThe source of the Date of Birth
... deathDate 0..1dateDate of Death
.... @id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... @value 0..1datePrimitive value for date
.... source 0..1CodeableConceptThe source of the Date of Death
... ethnicity 0..6CodeableConceptEthnicity of the provider
Binding: Ethnicity of a person (required)
... nhi 1..1IdentifierNational Health Identifier
... citizenship 0..1stringNZ Citizenship status
.... @id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... @value 0..1stringPrimitive value for string
Max Length: 1048576
.... source 0..1CodeableConceptThe source of the citizenship status
... birthPlace 0..1BackboneElementPlace of Birth
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... country 0..1stringCountry of Birth
.... place 0..1stringArea within country
.... source 0..1CodeableConceptThe source of the Birth Place
... residency 0..1CodeableConceptresidency status
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
.... source 0..1CodeableConceptThe source of the residency status

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PatientModel.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
PatientModel.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
PatientModel.ethnicityrequiredEthnicity
https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code

This structure is derived from Element

Summary

Mandatory: 0 element (1 nested mandatory element)

 

Other representations of profile: CSV, Excel