ADHA extension entitlement - Clinical Document Architecture with Australian Schema v1.0.1

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.1 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: ADHA extension entitlement

Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/entitlement		Version: 1.0.1
Active as of 2025-11-02	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:

Use this Logical Model: ADHA extension coverage2

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
entitlement		1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 ADHA CDA extension to represent entitlement Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId 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

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
entitlement.nullFlavor	Base	required	CDANullFlavor	📦1.0.1	This IG
entitlement.typeId.nullFlavor	Base	required	CDANullFlavor	📦1.0.1	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
entitlement	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 ADHA CDA extension to represent entitlement Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId 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: Bindings Constraints Obligations
entitlement		1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 ADHA CDA extension to represent entitlement Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId 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

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
entitlement.nullFlavor	Base	required	CDANullFlavor	📦1.0.1	This IG
entitlement.typeId.nullFlavor	Base	required	CDANullFlavor	📦1.0.1	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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:

cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
entitlement		1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 ADHA CDA extension to represent entitlement Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId 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

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
entitlement.nullFlavor	Base	required	CDANullFlavor	📦1.0.1	This IG
entitlement.typeId.nullFlavor	Base	required	CDANullFlavor	📦1.0.1	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
entitlement	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 ADHA CDA extension to represent entitlement Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId 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: Bindings Constraints Obligations
entitlement		1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 ADHA CDA extension to represent entitlement Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId 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

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
entitlement.nullFlavor	Base	required	CDANullFlavor	📦1.0.1	This IG
entitlement.typeId.nullFlavor	Base	required	CDANullFlavor	📦1.0.1	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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:

cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)

Maturity: 1

Other representations of profile: CSV, Excel