Clinical Document Architecture with Australian Schema
1.0.0 - current
Clinical Document Architecture with Australian Schema
1.0.0 - current
Clinical Document Architecture with Australian Schema - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2024-08-29 |
Definitions for the au-Entity logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. Entity | |
| Short | Australian adaptation of the HL7 International CDA Entity class |
| Control | 1..1 |
| Logical Container | ADHA ClinicalDocument (CDA Class) |
| Validation | Instance of this type are validated by templateId |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. Entity.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityClassRoot (required to http://terminology.hl7.org/ValueSet/v3-EntityClassRoot) |
| 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. |
| Default Value | ENT |
| 4. Entity.determinerCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityDeterminer (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer) |
| 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 | INSTANCE |
| 6. Entity.id | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 8. Entity.code | |
| Control | 0..1 |
| Binding | For example codes, see CDAEntityCode (example to http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode) |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-CE |
| 10. Entity.name | |
| Short | ADHA CDA extension to represent entity's name |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationName(ADHA ON: OrganizationName (V3 Data Type)) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 12. Entity.desc | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 14. Entity.telecom | |
| Short | ADHA CDA extension to represent entity's telecommunication details |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Telecom(ADHA TEL: TelecommunicationAddress (V3 Data Type)) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 16. Entity.addr | |
| Short | ADHA CDA extension to represent entity's address |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Address(ADHA AD: PostalAddress (V3 Data Type)) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 18. Entity.asOrganizationPartOf | |
| Short | ADHA CDA extension to represent a which organisation the entity is part of |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationPartOf(ADHA OrganizationPartOf (CDA Class)) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 20. Entity.asEntityIdentifier | |
| Short | ADHA CDA extension to represent a entity's identifier |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/asEntityIdentifier(ADHA extension asEntityIdentifier) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 22. Entity.asQualifiedEntity | |
| Short | ADHA CDA extension to represent a qualified entity |
| Control | 0..1 |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/asQualifiedEntity(ADHA extension asQualifiedEntity) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 24. Entity.personalRelationship | |
| Short | ADHA CDA extension to represent personal relationship of the entity |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/personalRelationship(ADHA extension personalRelationship) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
Guidance on how to interpret the contents of this table can be found here
| 0. Entity | |
| Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. Base definition for all types defined in FHIR type system. |
| Short | Australian adaptation of the HL7 International CDA Entity classBase for all types and resources |
| Control | 10..1* |
| Is Modifier | false |
| Logical Container | ADHA ClinicalDocument (CDA Class) |
| Validation | Instance of this type are validated by templateId |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. Entity.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityClassRoot (required to http://terminology.hl7.org/ValueSet/v3-EntityClassRoot) |
| 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. |
| Default Value | ENT |
| 4. Entity.determinerCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityDeterminer (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer) |
| 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 | INSTANCE |
| 6. Entity.id | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 8. Entity.code | |
| Control | 0..1 |
| Binding | For example codes, see CDAEntityCode (example to http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode) |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-CE |
| 10. Entity.name | |
| Short | ADHA CDA extension to represent entity's name |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationName(ADHA ON: OrganizationName (V3 Data Type)) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 12. Entity.desc | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 14. Entity.telecom | |
| Short | ADHA CDA extension to represent entity's telecommunication details |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Telecom(ADHA TEL: TelecommunicationAddress (V3 Data Type)) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 16. Entity.addr | |
| Short | ADHA CDA extension to represent entity's address |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Address(ADHA AD: PostalAddress (V3 Data Type)) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 18. Entity.asOrganizationPartOf | |
| Short | ADHA CDA extension to represent a which organisation the entity is part of |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationPartOf(ADHA OrganizationPartOf (CDA Class)) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 20. Entity.asEntityIdentifier | |
| Short | ADHA CDA extension to represent a entity's identifier |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/asEntityIdentifier(ADHA extension asEntityIdentifier) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 22. Entity.asQualifiedEntity | |
| Short | ADHA CDA extension to represent a qualified entity |
| Control | 0..1 |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/asQualifiedEntity(ADHA extension asQualifiedEntity) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 24. Entity.personalRelationship | |
| Short | ADHA CDA extension to represent personal relationship of the entity |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/personalRelationship(ADHA extension personalRelationship) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
Guidance on how to interpret the contents of this table can be found here
| 0. Entity | |
| Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. |
| Short | Australian adaptation of the HL7 International CDA Entity class |
| Control | 1..1 |
| Is Modifier | false |
| Logical Container | ADHA ClinicalDocument (CDA Class) |
| Validation | Instance of this type are validated by templateId |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. Entity.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. Entity.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 6. Entity.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 8. Entity.typeId.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 |
| 10. Entity.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| 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 an attribute. |
| Label | Assigning Authority Name |
| 12. Entity.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| 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 | Displayable |
| 14. Entity.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| 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 | Root |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 16. Entity.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..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 an attribute. |
| Label | Extension |
| 18. Entity.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 20. Entity.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityClassRoot (required to http://terminology.hl7.org/ValueSet/v3-EntityClassRoot) |
| 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. |
| Default Value | ENT |
| 22. Entity.determinerCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityDeterminer (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer) |
| 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 | INSTANCE |
| 24. Entity.id | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 26. Entity.code | |
| Control | 0..1 |
| Binding | For example codes, see CDAEntityCode (example to http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode) |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-CE |
| 28. Entity.name | |
| Short | ADHA CDA extension to represent entity's name |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationName(ADHA ON: OrganizationName (V3 Data Type)) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 30. Entity.desc | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 32. Entity.telecom | |
| Short | ADHA CDA extension to represent entity's telecommunication details |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Telecom(ADHA TEL: TelecommunicationAddress (V3 Data Type)) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 34. Entity.addr | |
| Short | ADHA CDA extension to represent entity's address |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Address(ADHA AD: PostalAddress (V3 Data Type)) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 36. Entity.asOrganizationPartOf | |
| Short | ADHA CDA extension to represent a which organisation the entity is part of |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationPartOf(ADHA OrganizationPartOf (CDA Class)) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 38. Entity.asEntityIdentifier | |
| Short | ADHA CDA extension to represent a entity's identifier |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/asEntityIdentifier(ADHA extension asEntityIdentifier) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 40. Entity.asQualifiedEntity | |
| Short | ADHA CDA extension to represent a qualified entity |
| Control | 0..1 |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/asQualifiedEntity(ADHA extension asQualifiedEntity) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 42. Entity.personalRelationship | |
| Short | ADHA CDA extension to represent personal relationship of the entity |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/personalRelationship(ADHA extension personalRelationship) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-08-29
Links: Table of Contents |
QA Report
| Version History
| Report an issue or propose a change
