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 entitlement logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. entitlement | |
| Definition | The entitlement or right of a participant to act in a given capacity (as defined by Entitlement Type) within a healthcare context. |
| Short | ADHA CDA extension to represent entitlement |
| Control | 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. entitlement.classCode | |
| Control | 1..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 | COV |
| 4. entitlement.moodCode | |
| Control | 1..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 | EVN |
| 6. entitlement.id | |
| Definition | A number or code issued for the purpose of identifying the entitlement or right of a participant to act in a given capacity (as defined by Entitlement Type) within a healthcare context. |
| Short | ADHA CDA extension to represent entitlement id |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 8. entitlement.code | |
| Definition | he description of the scope of an entitlement. |
| Short | ADHA CDA extension to represent entitlement scope |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 10. entitlement.effectiveTime | |
| Definition | The time interval for which an entitlement is valid. |
| Short | ADHA CDA extension to represent entitlement time |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 12. entitlement.participant | |
| Short | ADHA CDA extension to represent the participant |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/participant |
| 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. entitlement | |
| Definition | The entitlement or right of a participant to act in a given capacity (as defined by Entitlement Type) within a healthcare context. Base definition for all types defined in FHIR type system. |
| Short | ADHA CDA extension to represent entitlementBase for all types and resources |
| Control | 10..* |
| 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. entitlement.classCode | |
| Control | 1..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 | COV |
| 4. entitlement.moodCode | |
| Control | 1..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 | EVN |
| 6. entitlement.id | |
| Definition | A number or code issued for the purpose of identifying the entitlement or right of a participant to act in a given capacity (as defined by Entitlement Type) within a healthcare context. |
| Short | ADHA CDA extension to represent entitlement id |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 8. entitlement.code | |
| Definition | he description of the scope of an entitlement. |
| Short | ADHA CDA extension to represent entitlement scope |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 10. entitlement.effectiveTime | |
| Definition | The time interval for which an entitlement is valid. |
| Short | ADHA CDA extension to represent entitlement time |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 12. entitlement.participant | |
| Short | ADHA CDA extension to represent the participant |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/participant |
| 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. entitlement | |
| Definition | The entitlement or right of a participant to act in a given capacity (as defined by Entitlement Type) within a healthcare context. |
| Short | ADHA CDA extension to represent entitlement |
| Control | 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. entitlement.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. entitlement.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. entitlement.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. entitlement.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. entitlement.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. entitlement.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. entitlement.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. entitlement.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. entitlement.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. entitlement.classCode | |
| Control | 1..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 | COV |
| 22. entitlement.moodCode | |
| Control | 1..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 | EVN |
| 24. entitlement.id | |
| Definition | A number or code issued for the purpose of identifying the entitlement or right of a participant to act in a given capacity (as defined by Entitlement Type) within a healthcare context. |
| Short | ADHA CDA extension to represent entitlement id |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 26. entitlement.code | |
| Definition | he description of the scope of an entitlement. |
| Short | ADHA CDA extension to represent entitlement scope |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 28. entitlement.effectiveTime | |
| Definition | The time interval for which an entitlement is valid. |
| Short | ADHA CDA extension to represent entitlement time |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 30. entitlement.participant | |
| Short | ADHA CDA extension to represent the participant |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/participant |
| 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
