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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: Patient

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.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
PatientModel		0..*	Element	Elements defined in Ancestors:@id, extension Patient ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name		0..1	HumanName	Name of the practitioner ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Text representation of the full name ele-1: All FHIR elements must have a @value or children
family	Σ	0..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	Σ	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name ele-1: All FHIR elements must have a @value or children This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children
source		0..1	CodeableConcept	The source of the name
gender		0..1	string	The patients administrative gender Binding: AdministrativeGender (required) ele-1: All FHIR elements must have a @value or children
@id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
@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 ele-1: All FHIR elements must have a @value or children
@id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
@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 ele-1: All FHIR elements must have a @value or children
@id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
@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 ele-1: All FHIR elements must have a @value or children
@id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
@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 ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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 ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
coding	Σ	0..*	Coding	Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
source		0..1	CodeableConcept	The source of the residency status
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PatientModel.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
PatientModel.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
PatientModel.ethnicity	required	Ethnicity https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code

This structure is derived from Element

Name	Flags	Card.	Type	Description & Constraints
PatientModel		0..*	Element	Elements defined in Ancestors:@id, extension Patient
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
deathDate		0..1	date	Date of Death
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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
PatientModel.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
PatientModel.ethnicity	required	Ethnicity https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code

Name	Flags	Card.	Type	Description & Constraints
PatientModel		0..*	Element	Elements defined in Ancestors:@id, extension Patient
@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
gender		0..1	string	The patients administrative gender Binding: AdministrativeGender (required)
@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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PatientModel.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
PatientModel.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
PatientModel.ethnicity	required	Ethnicity 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)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
PatientModel		0..*	Element	Elements defined in Ancestors:@id, extension Patient ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name		0..1	HumanName	Name of the practitioner ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Text representation of the full name ele-1: All FHIR elements must have a @value or children
family	Σ	0..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	Σ	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name ele-1: All FHIR elements must have a @value or children This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children
source		0..1	CodeableConcept	The source of the name
gender		0..1	string	The patients administrative gender Binding: AdministrativeGender (required) ele-1: All FHIR elements must have a @value or children
@id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
@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 ele-1: All FHIR elements must have a @value or children
@id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
@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 ele-1: All FHIR elements must have a @value or children
@id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
@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 ele-1: All FHIR elements must have a @value or children
@id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
@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 ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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 ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
coding	Σ	0..*	Coding	Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
source		0..1	CodeableConcept	The source of the residency status
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PatientModel.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
PatientModel.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
PatientModel.ethnicity	required	Ethnicity https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code

Differential View

This structure is derived from Element

Name	Flags	Card.	Type	Description & Constraints
PatientModel		0..*	Element	Elements defined in Ancestors:@id, extension Patient
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
deathDate		0..1	date	Date of Death
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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
PatientModel.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
PatientModel.ethnicity	required	Ethnicity https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
PatientModel		0..*	Element	Elements defined in Ancestors:@id, extension Patient
@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
gender		0..1	string	The patients administrative gender Binding: AdministrativeGender (required)
@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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PatientModel.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
PatientModel.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
PatientModel.ethnicity	required	Ethnicity 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