Clinical Document Architecture with Australian Schema
1.0.0 - current
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
| Active as of 2024-11-22 |
Definitions for the ENXP logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. ENXP | |
| Control | 1..* |
| Logical Container | ADHA ClinicalDocument (CDA Class) |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. ENXP.partType | |
| Definition | Indicates whether the name part is a given name, family name, prefix, suffix, etc. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityNamePartType (required to http://terminology.hl7.org/ValueSet/v3-EntityNamePartType) |
| 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 | Name Part Type Code |
| 4. ENXP.qualifier | |
| Definition | qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records. |
| Control | 0..* |
| Binding | The codes SHALL be taken from CDAEntityNamePartQualifier (required to http://hl7.org/cda/stds/core/ValueSet/CDAEntityNamePartQualifier) |
| 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 | Qualifier Code |
Guidance on how to interpret the contents of this table can be found here
| 0. ENXP | |
| Definition | The character string data type stands for text data, primarily intended for machine processing (e.g., sorting, querying, indexing, etc.) Used for names, symbols, and formal expressions. Base definition for all types defined in FHIR type system. |
| Short | Base 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. |
| Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1) |
| 2. ENXP.partType | |
| Definition | Indicates whether the name part is a given name, family name, prefix, suffix, etc. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityNamePartType (required to http://terminology.hl7.org/ValueSet/v3-EntityNamePartType) |
| 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 | Name Part Type Code |
| 4. ENXP.qualifier | |
| Definition | qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records. |
| Control | 0..* |
| Binding | The codes SHALL be taken from CDAEntityNamePartQualifier (required to http://hl7.org/cda/stds/core/ValueSet/CDAEntityNamePartQualifier) |
| 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 | Qualifier Code |
Guidance on how to interpret the contents of this table can be found here
| 0. ENXP | |
| Definition | The character string data type stands for text data, primarily intended for machine processing (e.g., sorting, querying, indexing, etc.) Used for names, symbols, and formal expressions. |
| Short | Base for all types and resources |
| 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. |
| Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1) |
| 2. ENXP.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. ENXP.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| 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. |
| Fixed Value | TXT |
| 6. ENXP.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| 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 | Media Type |
| Fixed Value | text/plain |
| 8. ENXP.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| 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 | Language |
| 10. ENXP.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. |
| 12. ENXP.partType | |
| Definition | Indicates whether the name part is a given name, family name, prefix, suffix, etc. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityNamePartType (required to http://terminology.hl7.org/ValueSet/v3-EntityNamePartType) |
| 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 | Name Part Type Code |
| 14. ENXP.qualifier | |
| Definition | qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records. |
| Control | 0..* |
| Binding | The codes SHALL be taken from CDAEntityNamePartQualifier (required to http://hl7.org/cda/stds/core/ValueSet/CDAEntityNamePartQualifier) |
| 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 | Qualifier Code |
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-11-22
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
