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

A derivative of the RIM Act class, which can be used to create arbitrary groupings of other CDA entries that share a common context. An Organizer can contain other Organizers and/or other CDA entries, by traversing the component relationship. An Organizer can refer to external acts by traversing the reference relationship. An Organizer cannot be the source of an entryRelationship relationship. NOTE: CDA entries such as Observation can also contain other CDA entries by traversing the entryRelationship class. There is no requirement that the Organizer entry be used in order to group CDA entries.

Usage:

• Use this Logical Model Profile: Entry (CDA Class), EntryRelationship (CDA Class) and OrganizerComponent (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
Organizer		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		1..1	cs	Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
@moodCode		1..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id		0..*	II
code		0..1	CD	Binding: v3 Code System ActCode (example)
sdtcText		0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: text (urn:hl7-org:sdtc)
statusCode		1..1	CS	Binding: ActStatus (required)
effectiveTime		0..1	IVL_TS
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..*	Performer2
author		0..*	Author
informant		0..*	Informant
participant		0..*	Participant2
reference		0..*	Reference
precondition		0..*	Precondition
sdtcPrecondition2		0..*	Precondition2	XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc)
component		0..*	OrganizerComponent
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Organizer.classCode	required	XActClassDocumentEntryOrganizer http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCode	required	Fixed Value: EVN http://hl7.org/cda/stds/core/ValueSet/CDAActMood from this IG
Organizer.code	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.statusCode	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus

Name	Flags	Card.	Type	Description & Constraints
Organizer		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		1..1	cs	Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
@moodCode		1..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id		0..*	II
code		0..1	CD	Binding: v3 Code System ActCode (example)
sdtcText		0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: text (urn:hl7-org:sdtc)
statusCode		1..1	CS	Binding: ActStatus (required)
effectiveTime		0..1	IVL_TS
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..*	Performer2
author		0..*	Author
informant		0..*	Informant
participant		0..*	Participant2
reference		0..*	Reference
precondition		0..*	Precondition
sdtcPrecondition2		0..*	Precondition2	XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc)
component		0..*	OrganizerComponent
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Organizer.classCode	required	XActClassDocumentEntryOrganizer http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCode	required	Fixed Value: EVN http://hl7.org/cda/stds/core/ValueSet/CDAActMood from this IG
Organizer.code	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.statusCode	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus

Name	Flags	Card.	Type	Description & Constraints
Organizer		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		1..1	cs	Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
@moodCode		1..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id		0..*	II
code		0..1	CD	Binding: v3 Code System ActCode (example)
sdtcText		0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: text (urn:hl7-org:sdtc)
statusCode		1..1	CS	Binding: ActStatus (required)
effectiveTime		0..1	IVL_TS
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..*	Performer2
author		0..*	Author
informant		0..*	Informant
participant		0..*	Participant2
reference		0..*	Reference
precondition		0..*	Precondition
sdtcPrecondition2		0..*	Precondition2	XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc)
component		0..*	OrganizerComponent
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Organizer.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Organizer.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Organizer.classCode	required	XActClassDocumentEntryOrganizer http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCode	required	Fixed Value: EVN http://hl7.org/cda/stds/core/ValueSet/CDAActMood from this IG
Organizer.code	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.statusCode	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(3 nested mandatory elements)
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
Organizer		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		1..1	cs	Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
@moodCode		1..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id		0..*	II
code		0..1	CD	Binding: v3 Code System ActCode (example)
sdtcText		0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: text (urn:hl7-org:sdtc)
statusCode		1..1	CS	Binding: ActStatus (required)
effectiveTime		0..1	IVL_TS
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..*	Performer2
author		0..*	Author
informant		0..*	Informant
participant		0..*	Participant2
reference		0..*	Reference
precondition		0..*	Precondition
sdtcPrecondition2		0..*	Precondition2	XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc)
component		0..*	OrganizerComponent
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Organizer.classCode	required	XActClassDocumentEntryOrganizer http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCode	required	Fixed Value: EVN http://hl7.org/cda/stds/core/ValueSet/CDAActMood from this IG
Organizer.code	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.statusCode	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Organizer		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		1..1	cs	Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
@moodCode		1..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id		0..*	II
code		0..1	CD	Binding: v3 Code System ActCode (example)
sdtcText		0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: text (urn:hl7-org:sdtc)
statusCode		1..1	CS	Binding: ActStatus (required)
effectiveTime		0..1	IVL_TS
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..*	Performer2
author		0..*	Author
informant		0..*	Informant
participant		0..*	Participant2
reference		0..*	Reference
precondition		0..*	Precondition
sdtcPrecondition2		0..*	Precondition2	XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc)
component		0..*	OrganizerComponent
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Organizer.classCode	required	XActClassDocumentEntryOrganizer http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCode	required	Fixed Value: EVN http://hl7.org/cda/stds/core/ValueSet/CDAActMood from this IG
Organizer.code	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.statusCode	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Organizer		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		1..1	cs	Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
@moodCode		1..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id		0..*	II
code		0..1	CD	Binding: v3 Code System ActCode (example)
sdtcText		0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: text (urn:hl7-org:sdtc)
statusCode		1..1	CS	Binding: ActStatus (required)
effectiveTime		0..1	IVL_TS
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..*	Performer2
author		0..*	Author
informant		0..*	Informant
participant		0..*	Participant2
reference		0..*	Reference
precondition		0..*	Precondition
sdtcPrecondition2		0..*	Precondition2	XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc)
component		0..*	OrganizerComponent
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Organizer.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Organizer.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Organizer.classCode	required	XActClassDocumentEntryOrganizer http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCode	required	Fixed Value: EVN http://hl7.org/cda/stds/core/ValueSet/CDAActMood from this IG
Organizer.code	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.statusCode	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(3 nested mandatory elements)
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