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

The ParentDocument represents the source of a document revision, addenda, or transformation. ParentDocument.text is modeled as an ED data type - allowing for the expression of the MIME type of the parent document. It is not to be used to embed the related document, and thus ParentDocument.text.BIN is precluded from use.

Usage:

• Use this Logical Model Profile: RelatedDocument (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
ParentDocument		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: ActClassClinicalDocument (required) Fixed Value: DOCCLIN
@moodCode		0..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id		1..*	II
code		0..1	CD	Binding: FHIRDocumentTypeCodes (example)
text		0..1	ED
setId		0..1	II
versionNumber		0..1	INT
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
ParentDocument.classCode	required	Fixed Value: DOCCLIN http://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument
ParentDocument.moodCode	required	Fixed Value: EVN http://hl7.org/cda/stds/core/ValueSet/CDAActMood from this IG
ParentDocument.code	example	FHIRDocumentTypeCodes http://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
ParentDocument		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: ActClassClinicalDocument (required) Fixed Value: DOCCLIN
@moodCode		0..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id		1..*	II
code		0..1	CD	Binding: FHIRDocumentTypeCodes (example)
text		0..1	ED
setId		0..1	II
versionNumber		0..1	INT
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ParentDocument.classCode	required	Fixed Value: DOCCLIN http://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument
ParentDocument.moodCode	required	Fixed Value: EVN http://hl7.org/cda/stds/core/ValueSet/CDAActMood from this IG
ParentDocument.code	example	FHIRDocumentTypeCodes http://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
ParentDocument		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		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
@classCode		0..1	cs	Binding: ActClassClinicalDocument (required) Fixed Value: DOCCLIN
@moodCode		0..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id		1..*	II
code		0..1	CD	Binding: FHIRDocumentTypeCodes (example)
text		0..1	ED
setId		0..1	II
versionNumber		0..1	INT
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ParentDocument.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
ParentDocument.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
ParentDocument.classCode	required	Fixed Value: DOCCLIN http://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument
ParentDocument.moodCode	required	Fixed Value: EVN http://hl7.org/cda/stds/core/ValueSet/CDAActMood from this IG
ParentDocument.code	example	FHIRDocumentTypeCodes http://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(1 nested mandatory element)
Fixed: 2 elements

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
ParentDocument		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: ActClassClinicalDocument (required) Fixed Value: DOCCLIN
@moodCode		0..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id		1..*	II
code		0..1	CD	Binding: FHIRDocumentTypeCodes (example)
text		0..1	ED
setId		0..1	II
versionNumber		0..1	INT
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
ParentDocument.classCode	required	Fixed Value: DOCCLIN http://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument
ParentDocument.moodCode	required	Fixed Value: EVN http://hl7.org/cda/stds/core/ValueSet/CDAActMood from this IG
ParentDocument.code	example	FHIRDocumentTypeCodes http://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
ParentDocument		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: ActClassClinicalDocument (required) Fixed Value: DOCCLIN
@moodCode		0..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id		1..*	II
code		0..1	CD	Binding: FHIRDocumentTypeCodes (example)
text		0..1	ED
setId		0..1	II
versionNumber		0..1	INT
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ParentDocument.classCode	required	Fixed Value: DOCCLIN http://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument
ParentDocument.moodCode	required	Fixed Value: EVN http://hl7.org/cda/stds/core/ValueSet/CDAActMood from this IG
ParentDocument.code	example	FHIRDocumentTypeCodes http://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ParentDocument		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		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
@classCode		0..1	cs	Binding: ActClassClinicalDocument (required) Fixed Value: DOCCLIN
@moodCode		0..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id		1..*	II
code		0..1	CD	Binding: FHIRDocumentTypeCodes (example)
text		0..1	ED
setId		0..1	II
versionNumber		0..1	INT
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ParentDocument.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
ParentDocument.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
ParentDocument.classCode	required	Fixed Value: DOCCLIN http://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument
ParentDocument.moodCode	required	Fixed Value: EVN http://hl7.org/cda/stds/core/ValueSet/CDAActMood from this IG
ParentDocument.code	example	FHIRDocumentTypeCodes http://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(1 nested mandatory element)
Fixed: 2 elements

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