ADHA EN: EntityName (V3 Data Type) - Definitions - Clinical Document Architecture with Australian Schema v1.0.0

Clinical Document Architecture with Australian Schema, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/cda-au-schema/ and changes regularly. See the Directory of published versions

Logical Model: au-EntityName - Detailed Descriptions

Active as of 2024-11-22

Definitions for the au-EntityName logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

0. EN
Definition	A name for a person, organization, place or thing. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for entity name values are "Jim Bob Walton, Jr.", "Health Level Seven, Inc.", "Lake Tahoe", etc. An entity name may be as simple as a character string or may consist of several entity name parts, such as, "Jim", "Bob", "Walton", and "Jr.", "Health Level Seven" and "Inc.", "Lake" and "Tahoe".
Short	Australian adaptation of the HL7 International EntityName (EN) dataType
Control	1..*
Logical Container	ADHA ClinicalDocument (CDA Class)
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. EN.use
Definition	A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose
Control	0..*
Binding	The codes SHALL be taken from Entity Name Use (required to `http://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Use Code
4. EN.item
Definition	A series of items that constitute the name.
Control	0..*
Type	http://hl7.org/fhir/StructureDefinition/Base
Choice Group	This is a repeating choice group that does not appear directly in the instance
Invariants	EN-1: Can only have only one of the possible item elements in each choice (`(delimiter \| family \| given \| prefix \| suffix \| xmlText).count() = 1`)
6. EN.item.delimiter
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
8. EN.item.family
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
10. EN.item.given
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
12. EN.item.prefix
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
14. EN.item.suffix
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
16. EN.item.xmlText
Short	Allows for mixed text content
Comments	This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as unadorned text.
18. EN.validTime
Definition	An interval of time specifying the time during which the name is or was used for the entity. This accomodates the fact that people change names for people, places and things.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
Label	Valid Time

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

0. EN
Definition	A name for a person, organization, place or thing. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for entity name values are "Jim Bob Walton, Jr.", "Health Level Seven, Inc.", "Lake Tahoe", etc. An entity name may be as simple as a character string or may consist of several entity name parts, such as, "Jim", "Bob", "Walton", and "Jr.", "Health Level Seven" and "Inc.", "Lake" and "Tahoe". Base definition for all types defined in FHIR type system.
Short	Australian adaptation of the HL7 International EntityName (EN) dataTypeBase for all types and resources
Control	10..*
Is Modifier	false
Logical Container	ADHA ClinicalDocument (CDA Class)
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. EN.use
Definition	A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose
Control	0..*
Binding	The codes SHALL be taken from Entity Name Use (required to `http://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Use Code
4. EN.item
Definition	A series of items that constitute the name.
Control	0..*
Type	http://hl7.org/fhir/StructureDefinition/Base
Choice Group	This is a repeating choice group that does not appear directly in the instance
Invariants	EN-1: Can only have only one of the possible item elements in each choice (`(delimiter \| family \| given \| prefix \| suffix \| xmlText).count() = 1`)
6. EN.item.delimiter
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
8. EN.item.family
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
10. EN.item.given
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
12. EN.item.prefix
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
14. EN.item.suffix
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
16. EN.item.xmlText
Short	Allows for mixed text content
Comments	This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as unadorned text.
18. EN.validTime
Definition	An interval of time specifying the time during which the name is or was used for the entity. This accomodates the fact that people change names for people, places and things.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
Label	Valid Time

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

0. EN
Definition	A name for a person, organization, place or thing. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for entity name values are "Jim Bob Walton, Jr.", "Health Level Seven, Inc.", "Lake Tahoe", etc. An entity name may be as simple as a character string or may consist of several entity name parts, such as, "Jim", "Bob", "Walton", and "Jr.", "Health Level Seven" and "Inc.", "Lake" and "Tahoe".
Short	Australian adaptation of the HL7 International EntityName (EN) dataType
Control	1..*
Is Modifier	false
Logical Container	ADHA ClinicalDocument (CDA Class)
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. EN.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
4. EN.use
Definition	A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose
Control	0..*
Binding	The codes SHALL be taken from Entity Name Use (required to `http://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Use Code
6. EN.item
Definition	A series of items that constitute the name.
Control	0..*
Type	http://hl7.org/fhir/StructureDefinition/Base
Choice Group	This is a repeating choice group that does not appear directly in the instance
Invariants	EN-1: Can only have only one of the possible item elements in each choice (`(delimiter \| family \| given \| prefix \| suffix \| xmlText).count() = 1`)
8. EN.item.delimiter
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
10. EN.item.family
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
12. EN.item.given
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
14. EN.item.prefix
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
16. EN.item.suffix
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
18. EN.item.xmlText
Short	Allows for mixed text content
Comments	This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as unadorned text.
20. EN.validTime
Definition	An interval of time specifying the time during which the name is or was used for the entity. This accomodates the fact that people change names for people, places and things.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
Label	Valid Time