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-12-18

Definitions for the au-EntityName logical model.

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".

ShortAustralian adaptation of the HL7 International EntityName (EN) dataType
Control1..*
Logical ContainerADHA ClinicalDocument (CDA Class)
XML FormatIn 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

Control0..*
BindingThe codes SHALL be taken from Entity Name Use
(required to http://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelUse Code
4. EN.item
Definition

A series of items that constitute the name.

Control0..*
Typehttp://hl7.org/fhir/StructureDefinition/Base
Choice GroupThis is a repeating choice group that does not appear directly in the instance
InvariantsEN-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
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
8. EN.item.family
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
10. EN.item.given
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
12. EN.item.prefix
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
14. EN.item.suffix
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
16. EN.item.xmlText
ShortAllows 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.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn 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.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
LabelValid 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.

ShortAustralian adaptation of the HL7 International EntityName (EN) dataTypeBase for all types and resources
Control10..*
Is Modifierfalse
Logical ContainerADHA ClinicalDocument (CDA Class)
XML FormatIn 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.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional 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

Control0..*
BindingThe codes SHALL be taken from Entity Name Use
(required to http://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelUse Code
6. EN.item
Definition

A series of items that constitute the name.

Control0..*
Typehttp://hl7.org/fhir/StructureDefinition/Base
Choice GroupThis is a repeating choice group that does not appear directly in the instance
InvariantsEN-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
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
10. EN.item.family
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
12. EN.item.given
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
14. EN.item.prefix
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
16. EN.item.suffix
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
18. EN.item.xmlText
ShortAllows 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.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn 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.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
LabelValid 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".

ShortAustralian adaptation of the HL7 International EntityName (EN) dataType
Control1..*
Is Modifierfalse
Logical ContainerADHA ClinicalDocument (CDA Class)
XML FormatIn 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.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional 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

Control0..*
BindingThe codes SHALL be taken from Entity Name Use
(required to http://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelUse Code
6. EN.item
Definition

A series of items that constitute the name.

Control0..*
Typehttp://hl7.org/fhir/StructureDefinition/Base
Choice GroupThis is a repeating choice group that does not appear directly in the instance
InvariantsEN-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
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
10. EN.item.family
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
12. EN.item.given
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
14. EN.item.prefix
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
16. EN.item.suffix
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
18. EN.item.xmlText
ShortAllows 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.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn 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.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
LabelValid Time