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
| Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/entitlement | Version: 1.0.0 | |||
| Active as of 2025-08-28 | Maturity Level: 1 | Computable Name: entitlement | ||
Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
||||
The entitlement or right of a participant to act in a given capacity (as defined by Entitlement Type) within a healthcare context.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  entitlement |
1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent entitlement Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
  @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
 realmCode |
0..* | CS | ||
 typeId |
C | 0..1 | II | Constraints: II-1 |
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
 @extension |
1..1 | st | ||
| templateId |
0..* | II | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement templateId XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| @classCode |
1..1 | cs | Fixed Value: COV | |
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| id |
1..1 | II | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement id XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| code |
1..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement scope XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| effectiveTime |
0..1 | IVL_TS | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement time XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| participant |
0..* | participant | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the participant XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| entitlement.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| entitlement.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | entitlement.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| entitlement |
1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent entitlement Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @classCode |
1..1 | cs | Fixed Value: COV | |
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| templateId |
0..* | II | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement templateId XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| id |
1..1 | II | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement id XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| code |
1..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement scope XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| effectiveTime |
0..1 | IVL_TS | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement time XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| participant |
0..* | participant | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the participant XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| entitlement |
1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent entitlement Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement templateId XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| @classCode |
1..1 | cs | Fixed Value: COV | |
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| id |
1..1 | II | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement id XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| code |
1..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement scope XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| effectiveTime |
0..1 | IVL_TS | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement time XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| participant |
0..* | participant | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the participant XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| entitlement.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| entitlement.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | entitlement.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
This structure is derived from InfrastructureRoot
Summary
Mandatory: 0 element(4 nested mandatory elements)
Fixed: 2 elements
Structures
This structure refers to these other structures:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| entitlement |
1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent entitlement Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement templateId XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| @classCode |
1..1 | cs | Fixed Value: COV | |
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| id |
1..1 | II | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement id XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| code |
1..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement scope XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| effectiveTime |
0..1 | IVL_TS | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement time XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| participant |
0..* | participant | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the participant XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| entitlement.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| entitlement.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | entitlement.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| entitlement |
1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent entitlement Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @classCode |
1..1 | cs | Fixed Value: COV | |
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| templateId |
0..* | II | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement templateId XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| id |
1..1 | II | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement id XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| code |
1..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement scope XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| effectiveTime |
0..1 | IVL_TS | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement time XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| participant |
0..* | participant | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the participant XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| entitlement |
1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent entitlement Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement templateId XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| @classCode |
1..1 | cs | Fixed Value: COV | |
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| id |
1..1 | II | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement id XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| code |
1..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement scope XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| effectiveTime |
0..1 | IVL_TS | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entitlement time XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| participant |
0..* | participant | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the participant XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| entitlement.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| entitlement.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | entitlement.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
This structure is derived from InfrastructureRoot
Summary
Mandatory: 0 element(4 nested mandatory elements)
Fixed: 2 elements
Structures
This structure refers to these other structures:
Maturity: 1
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2025-08-28
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
