ADHA Reference (CDA Class) - Clinical Document Architecture with Australian Schema v1.0.0

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

Logical Model: ADHA Reference (CDA Class)

Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Reference				Version: 1.0.0
Active as of 2024-12-18				Computable Name: au-Reference
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/.

Australian adaptation of the HL7 International CDA Reference 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 Act (CDA Class), ADHA Encounter (CDA Class), ADHA Observation (CDA Class), ADHA ObservationMedia (CDA Class)... Show 6 more

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
Reference	C	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Reference class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) reference-external: Must contain one (and only one) external reference
@typeCode		1..1	cs	Binding: x_ActRelationshipExternalReference (required)
seperatableInd		0..1	BL
(Choice of one)		1..1
externalAct		0..1	ExternalAct	Australian-adapted ExternalAct class
externalObservation		0..1	ExternalObservation
externalProcedure		0..1	ExternalProcedure
externalDocument		0..1	ExternalDocument	Australian-adapted ExternalDocument class
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Reference.typeCode	required	XActRelationshipExternalReference `http://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference`

Constraints

Id	Grade	Path(s)	Details	Requirements
reference-external	error	Reference	Must contain one (and only one) external reference : (externalAct \| externalObservation \| externalProcedure \| externalDocument).count() = 1

Name	Flags	Card.	Type	Description & Constraints
Reference	C	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Reference class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) reference-external: Must contain one (and only one) external reference
@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
@typeCode		1..1	cs	Binding: x_ActRelationshipExternalReference (required)
seperatableInd		0..1	BL
(Choice of one)		1..1
externalAct		0..1	ExternalAct	Australian-adapted ExternalAct class
externalObservation		0..1	ExternalObservation
externalProcedure		0..1	ExternalProcedure
externalDocument		0..1	ExternalDocument	Australian-adapted ExternalDocument class
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Reference.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Reference.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Reference.typeCode	required	XActRelationshipExternalReference `http://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference`

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Reference.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
reference-external	error	Reference	Must contain one (and only one) external reference : (externalAct \| externalObservation \| externalProcedure \| externalDocument).count() = 1

Name	Flags	Card.	Type	Description & Constraints
Reference	C	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Reference class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) reference-external: Must contain one (and only one) external reference
@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
@typeCode		1..1	cs	Binding: x_ActRelationshipExternalReference (required)
seperatableInd		0..1	BL
(Choice of one)		1..1
externalAct		0..1	ExternalAct	Australian-adapted ExternalAct class
externalObservation		0..1	ExternalObservation
externalProcedure		0..1	ExternalProcedure
externalDocument		0..1	ExternalDocument	Australian-adapted ExternalDocument class
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Reference.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Reference.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Reference.typeCode	required	XActRelationshipExternalReference `http://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference`

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Reference.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
reference-external	error	Reference	Must contain one (and only one) external reference : (externalAct \| externalObservation \| externalProcedure \| externalDocument).count() = 1

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(1 nested mandatory 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
Reference	C	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Reference class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) reference-external: Must contain one (and only one) external reference
@typeCode		1..1	cs	Binding: x_ActRelationshipExternalReference (required)
seperatableInd		0..1	BL
(Choice of one)		1..1
externalAct		0..1	ExternalAct	Australian-adapted ExternalAct class
externalObservation		0..1	ExternalObservation
externalProcedure		0..1	ExternalProcedure
externalDocument		0..1	ExternalDocument	Australian-adapted ExternalDocument class
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Reference.typeCode	required	XActRelationshipExternalReference `http://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference`

Constraints

Id	Grade	Path(s)	Details	Requirements
reference-external	error	Reference	Must contain one (and only one) external reference : (externalAct \| externalObservation \| externalProcedure \| externalDocument).count() = 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Reference	C	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Reference class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) reference-external: Must contain one (and only one) external reference
@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
@typeCode		1..1	cs	Binding: x_ActRelationshipExternalReference (required)
seperatableInd		0..1	BL
(Choice of one)		1..1
externalAct		0..1	ExternalAct	Australian-adapted ExternalAct class
externalObservation		0..1	ExternalObservation
externalProcedure		0..1	ExternalProcedure
externalDocument		0..1	ExternalDocument	Australian-adapted ExternalDocument class
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Reference.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Reference.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Reference.typeCode	required	XActRelationshipExternalReference `http://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference`

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Reference.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
reference-external	error	Reference	Must contain one (and only one) external reference : (externalAct \| externalObservation \| externalProcedure \| externalDocument).count() = 1

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Reference	C	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Reference class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) reference-external: Must contain one (and only one) external reference
@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
@typeCode		1..1	cs	Binding: x_ActRelationshipExternalReference (required)
seperatableInd		0..1	BL
(Choice of one)		1..1
externalAct		0..1	ExternalAct	Australian-adapted ExternalAct class
externalObservation		0..1	ExternalObservation
externalProcedure		0..1	ExternalProcedure
externalDocument		0..1	ExternalDocument	Australian-adapted ExternalDocument class
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Reference.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Reference.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Reference.typeCode	required	XActRelationshipExternalReference `http://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference`

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Reference.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
reference-external	error	Reference	Must contain one (and only one) external reference : (externalAct \| externalObservation \| externalProcedure \| externalDocument).count() = 1

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(1 nested mandatory 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