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

Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organizer				Version: 1.0.0
Active as of 2024-12-18				Computable Name: au-Organizer
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 Organizer 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 Entry (CDA Class) and ADHA EntryRelationship (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	Card.	Type	Description & Constraints
Organizer	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Organizer class 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)
statusCode	1..1	CS	Binding: ActStatus (required)
effectiveTime	0..1	IVL_TS
subject	0..1	Subject
specimen	0..*	Specimen	Australian-adapted Specimen class
performer	0..*	Performer2	Australian-adapted Performer class
author	0..*	Author	Australian-adapted Author class
informant	0..*	Informant	Australian-adapted Informant class
participant	0..*	Participant2	Australian-adapted Participant2 class
reference	0..*	Reference	Australian-adapted Reference class
precondition	0..*	Precondition	Australian-adapted Precondition class
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 Australian adaptation of the HL7 International CDA Organizer class 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		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)
statusCode		1..1	CS	Binding: ActStatus (required)
effectiveTime		0..1	IVL_TS
subject		0..1	Subject
specimen		0..*	Specimen	Australian-adapted Specimen class
performer		0..*	Performer2	Australian-adapted Performer class
author		0..*	Author	Australian-adapted Author class
informant		0..*	Informant	Australian-adapted Informant class
participant		0..*	Participant2	Australian-adapted Participant2 class
reference		0..*	Reference	Australian-adapted Reference class
precondition		0..*	Precondition	Australian-adapted Precondition class
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`

Constraints

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

Name	Flags	Card.	Type	Description & Constraints
Organizer		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Organizer class 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		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)
statusCode		1..1	CS	Binding: ActStatus (required)
effectiveTime		0..1	IVL_TS
subject		0..1	Subject
specimen		0..*	Specimen	Australian-adapted Specimen class
performer		0..*	Performer2	Australian-adapted Performer class
author		0..*	Author	Australian-adapted Author class
informant		0..*	Informant	Australian-adapted Informant class
participant		0..*	Participant2	Australian-adapted Participant2 class
reference		0..*	Reference	Australian-adapted Reference class
precondition		0..*	Precondition	Australian-adapted Precondition class
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`

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Organizer.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(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	Card.	Type	Description & Constraints
Organizer	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Organizer class 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)
statusCode	1..1	CS	Binding: ActStatus (required)
effectiveTime	0..1	IVL_TS
subject	0..1	Subject
specimen	0..*	Specimen	Australian-adapted Specimen class
performer	0..*	Performer2	Australian-adapted Performer class
author	0..*	Author	Australian-adapted Author class
informant	0..*	Informant	Australian-adapted Informant class
participant	0..*	Participant2	Australian-adapted Participant2 class
reference	0..*	Reference	Australian-adapted Reference class
precondition	0..*	Precondition	Australian-adapted Precondition class
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 Australian adaptation of the HL7 International CDA Organizer class 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		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)
statusCode		1..1	CS	Binding: ActStatus (required)
effectiveTime		0..1	IVL_TS
subject		0..1	Subject
specimen		0..*	Specimen	Australian-adapted Specimen class
performer		0..*	Performer2	Australian-adapted Performer class
author		0..*	Author	Australian-adapted Author class
informant		0..*	Informant	Australian-adapted Informant class
participant		0..*	Participant2	Australian-adapted Participant2 class
reference		0..*	Reference	Australian-adapted Reference class
precondition		0..*	Precondition	Australian-adapted Precondition class
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`

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Organizer.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
Organizer		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Organizer class 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		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)
statusCode		1..1	CS	Binding: ActStatus (required)
effectiveTime		0..1	IVL_TS
subject		0..1	Subject
specimen		0..*	Specimen	Australian-adapted Specimen class
performer		0..*	Performer2	Australian-adapted Performer class
author		0..*	Author	Australian-adapted Author class
informant		0..*	Informant	Australian-adapted Informant class
participant		0..*	Participant2	Australian-adapted Participant2 class
reference		0..*	Reference	Australian-adapted Reference class
precondition		0..*	Precondition	Australian-adapted Precondition class
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`

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Organizer.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(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