Clinical Document Architecture with Australian Schema

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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: Order (CDA Class)

This class represents those orders that are fulfilled by this document. For instance, a provider orders an X-Ray. The X-Ray is performed. A radiologist reads the X-Ray and generates a report. The X-Ray order identifier is transmitted in the Order class, the performed X-Ray procedure is transmitted in the ServiceEvent class, and the ClinicalDocument.code would be valued with "Diagnostic Imaging Report".

Usage:

• Use this Logical Model Profile: InFulfillmentOf (CDA Class)

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints
Order		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode		0..1	cs	Binding: CDAActClass (required)
@moodCode		0..1	cs	Binding: CDAActMoodIntent (required) Fixed Value: RQO
id		1..*	II
code		0..1	CE	Binding: v3 Code System ActCode (example)
priorityCode		0..1	CE	Binding: ActPriority (example)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Order.classCode	required	CDAActClass http://hl7.org/cda/stds/core/ValueSet/CDAActClass from this IG
Order.moodCode	required	Fixed Value: RQO http://hl7.org/cda/stds/core/ValueSet/CDAActMoodIntent from this IG
Order.code	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
Order.priorityCode	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority

Name	Flags	Card.	Type	Description & Constraints
Order		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	II-1: An II instance must have either a root or an nullFlavor.
@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
@classCode		0..1	cs	Binding: CDAActClass (required)
@moodCode		0..1	cs	Binding: CDAActMoodIntent (required) Fixed Value: RQO
id		1..*	II
code		0..1	CE	Binding: v3 Code System ActCode (example)
priorityCode		0..1	CE	Binding: ActPriority (example)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Order.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Order.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Order.classCode	required	CDAActClass http://hl7.org/cda/stds/core/ValueSet/CDAActClass from this IG
Order.moodCode	required	Fixed Value: RQO http://hl7.org/cda/stds/core/ValueSet/CDAActMoodIntent from this IG
Order.code	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
Order.priorityCode	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Order.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Name	Flags	Card.	Type	Description & Constraints
Order		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	II-1: An II instance must have either a root or an nullFlavor.
@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
@classCode		0..1	cs	Binding: CDAActClass (required)
@moodCode		0..1	cs	Binding: CDAActMoodIntent (required) Fixed Value: RQO
id		1..*	II
code		0..1	CE	Binding: v3 Code System ActCode (example)
priorityCode		0..1	CE	Binding: ActPriority (example)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Order.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Order.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Order.classCode	required	CDAActClass http://hl7.org/cda/stds/core/ValueSet/CDAActClass from this IG
Order.moodCode	required	Fixed Value: RQO http://hl7.org/cda/stds/core/ValueSet/CDAActMoodIntent from this IG
Order.code	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
Order.priorityCode	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Order.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(1 nested mandatory element)
Fixed: 1 element

Structures

This structure refers to these other structures:

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

Differential View

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints
Order		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode		0..1	cs	Binding: CDAActClass (required)
@moodCode		0..1	cs	Binding: CDAActMoodIntent (required) Fixed Value: RQO
id		1..*	II
code		0..1	CE	Binding: v3 Code System ActCode (example)
priorityCode		0..1	CE	Binding: ActPriority (example)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Order.classCode	required	CDAActClass http://hl7.org/cda/stds/core/ValueSet/CDAActClass from this IG
Order.moodCode	required	Fixed Value: RQO http://hl7.org/cda/stds/core/ValueSet/CDAActMoodIntent from this IG
Order.code	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
Order.priorityCode	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Order		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	II-1: An II instance must have either a root or an nullFlavor.
@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
@classCode		0..1	cs	Binding: CDAActClass (required)
@moodCode		0..1	cs	Binding: CDAActMoodIntent (required) Fixed Value: RQO
id		1..*	II
code		0..1	CE	Binding: v3 Code System ActCode (example)
priorityCode		0..1	CE	Binding: ActPriority (example)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Order.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Order.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Order.classCode	required	CDAActClass http://hl7.org/cda/stds/core/ValueSet/CDAActClass from this IG
Order.moodCode	required	Fixed Value: RQO http://hl7.org/cda/stds/core/ValueSet/CDAActMoodIntent from this IG
Order.code	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
Order.priorityCode	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Order.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Order		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	II-1: An II instance must have either a root or an nullFlavor.
@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
@classCode		0..1	cs	Binding: CDAActClass (required)
@moodCode		0..1	cs	Binding: CDAActMoodIntent (required) Fixed Value: RQO
id		1..*	II
code		0..1	CE	Binding: v3 Code System ActCode (example)
priorityCode		0..1	CE	Binding: ActPriority (example)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Order.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Order.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Order.classCode	required	CDAActClass http://hl7.org/cda/stds/core/ValueSet/CDAActClass from this IG
Order.moodCode	required	Fixed Value: RQO http://hl7.org/cda/stds/core/ValueSet/CDAActMoodIntent from this IG
Order.code	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
Order.priorityCode	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Order.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(1 nested mandatory element)
Fixed: 1 element

Structures

This structure refers to these other structures:

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

Other representations of profile: CSV, Excel