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: ADHA Component (CDA Class)

Australian adaptation of the HL7 International CDA Component class.

This is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA

Usage:

• Use this Logical Model Profile: ADHA ClinicalDocument (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
Component	C	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Component class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) body-choice: Choice of the body required.
@typeCode		0..1	cs	Binding: ActRelationshipHasComponent (required) Fixed Value: COMP
@contextConductionInd		0..1	bl	Fixed Value: true
(Choice of one)		1..1
nonXMLBody		0..1	NonXMLBody
structuredBody		0..1	au-StructuredBody	Australian-adapted StructuredBody class
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Component.typeCode	required	Fixed Value: COMP http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent

Constraints

Id	Grade	Path(s)	Details	Requirements
body-choice	error	Component	Choice of the body required. : (nonXMLBody | structuredBody).count() = 1

Name	Flags	Card.	Type	Description & Constraints
Component	C	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Component class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) body-choice: Choice of the body required.
@typeCode		0..1	cs	Binding: ActRelationshipHasComponent (required) Fixed Value: COMP
@contextConductionInd		0..1	bl	Fixed Value: true
(Choice of one)		1..1
nonXMLBody		0..1	NonXMLBody
structuredBody		0..1	au-StructuredBody	Australian-adapted StructuredBody class
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Component.typeCode	required	Fixed Value: COMP http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent

Constraints

Id	Grade	Path(s)	Details	Requirements
body-choice	error	Component	Choice of the body required. : (nonXMLBody | structuredBody).count() = 1

Name	Flags	Card.	Type	Description & Constraints
Component	C	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Component class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) body-choice: Choice of the body required.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		0..1	II
@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
@typeCode		0..1	cs	Binding: ActRelationshipHasComponent (required) Fixed Value: COMP
@contextConductionInd		0..1	bl	Fixed Value: true
(Choice of one)		1..1
nonXMLBody		0..1	NonXMLBody
structuredBody		0..1	au-StructuredBody	Australian-adapted StructuredBody class
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Component.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Component.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Component.typeCode	required	Fixed Value: COMP http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent

Constraints

Id	Grade	Path(s)	Details	Requirements
body-choice	error	Component	Choice of the body required. : (nonXMLBody | structuredBody).count() = 1

This structure is derived from InfrastructureRoot

Summary

Fixed: 2 elements

Structures

This structure refers to these other structures:

• cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)
• bl: Boolean (http://hl7.org/cda/stds/core/StructureDefinition/bl-simple)
• ADHA StructuredBody (CDA Class) (http://ns.electronichealth.net.au/cda/StructureDefinition/au-StructuredBody)

Differential View

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints
Component	C	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Component class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) body-choice: Choice of the body required.
@typeCode		0..1	cs	Binding: ActRelationshipHasComponent (required) Fixed Value: COMP
@contextConductionInd		0..1	bl	Fixed Value: true
(Choice of one)		1..1
nonXMLBody		0..1	NonXMLBody
structuredBody		0..1	au-StructuredBody	Australian-adapted StructuredBody class
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Component.typeCode	required	Fixed Value: COMP http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent

Constraints

Id	Grade	Path(s)	Details	Requirements
body-choice	error	Component	Choice of the body required. : (nonXMLBody | structuredBody).count() = 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Component	C	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Component class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) body-choice: Choice of the body required.
@typeCode		0..1	cs	Binding: ActRelationshipHasComponent (required) Fixed Value: COMP
@contextConductionInd		0..1	bl	Fixed Value: true
(Choice of one)		1..1
nonXMLBody		0..1	NonXMLBody
structuredBody		0..1	au-StructuredBody	Australian-adapted StructuredBody class
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Component.typeCode	required	Fixed Value: COMP http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent

Constraints

Id	Grade	Path(s)	Details	Requirements
body-choice	error	Component	Choice of the body required. : (nonXMLBody | structuredBody).count() = 1

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Component	C	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Component class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) body-choice: Choice of the body required.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		0..1	II
@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
@typeCode		0..1	cs	Binding: ActRelationshipHasComponent (required) Fixed Value: COMP
@contextConductionInd		0..1	bl	Fixed Value: true
(Choice of one)		1..1
nonXMLBody		0..1	NonXMLBody
structuredBody		0..1	au-StructuredBody	Australian-adapted StructuredBody class
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Component.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Component.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Component.typeCode	required	Fixed Value: COMP http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent

Constraints

Id	Grade	Path(s)	Details	Requirements
body-choice	error	Component	Choice of the body required. : (nonXMLBody | structuredBody).count() = 1

This structure is derived from InfrastructureRoot

Summary

Fixed: 2 elements

Structures

This structure refers to these other structures:

• cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)
• bl: Boolean (http://hl7.org/cda/stds/core/StructureDefinition/bl-simple)
• ADHA StructuredBody (CDA Class) (http://ns.electronichealth.net.au/cda/StructureDefinition/au-StructuredBody)

Other representations of profile: CSV, Excel