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

An informant (or source of information) is a person that provides relevant information, such as the parent of a comatose patient who describes the patient's behavior prior to the onset of coma.

Usage:

• Use this Logical Model Profile: Act (CDA Class), Encounter (CDA Class), Observation (CDA Class), ObservationMedia (CDA Class)... Show 6 more, Organizer (CDA Class), Procedure (CDA Class), RegionOfInterest (CDA Class), Section (CDA Class), SubstanceAdministration (CDA Class) and Supply (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
Informant	C	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) informant-entity: AssignedEntity and RelatedEntity are mutually exclusive (one must be present)
@typeCode		0..1	cs	Binding: CDAParticipationType (required) Fixed Value: INF
@contextControlCode		0..1	cs	Binding: CDAContextControl (required) Fixed Value: OP
(Choice of one)		1..1
assignedEntity		0..1	AssignedEntity
relatedEntity		0..1	RelatedEntity
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Informant.typeCode	required	Fixed Value: INF http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType from this IG
Informant.contextControlCode	required	Fixed Value: OP http://hl7.org/cda/stds/core/ValueSet/CDAContextControl from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
informant-entity	error	Informant	AssignedEntity and RelatedEntity are mutually exclusive (one must be present) : (assignedEntity | relatedEntity).count() = 1

Name	Flags	Card.	Type	Description & Constraints
Informant	C	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) informant-entity: AssignedEntity and RelatedEntity are mutually exclusive (one must be present)
@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		0..1	cs	Binding: CDAParticipationType (required) Fixed Value: INF
@contextControlCode		0..1	cs	Binding: CDAContextControl (required) Fixed Value: OP
(Choice of one)		1..1
assignedEntity		0..1	AssignedEntity
relatedEntity		0..1	RelatedEntity
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Informant.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Informant.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Informant.typeCode	required	Fixed Value: INF http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType from this IG
Informant.contextControlCode	required	Fixed Value: OP http://hl7.org/cda/stds/core/ValueSet/CDAContextControl from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Informant.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
informant-entity	error	Informant	AssignedEntity and RelatedEntity are mutually exclusive (one must be present) : (assignedEntity | relatedEntity).count() = 1

Name	Flags	Card.	Type	Description & Constraints
Informant	C	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) informant-entity: AssignedEntity and RelatedEntity are mutually exclusive (one must be present)
@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		0..1	cs	Binding: CDAParticipationType (required) Fixed Value: INF
@contextControlCode		0..1	cs	Binding: CDAContextControl (required) Fixed Value: OP
(Choice of one)		1..1
assignedEntity		0..1	AssignedEntity
relatedEntity		0..1	RelatedEntity
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Informant.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Informant.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Informant.typeCode	required	Fixed Value: INF http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType from this IG
Informant.contextControlCode	required	Fixed Value: OP http://hl7.org/cda/stds/core/ValueSet/CDAContextControl from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Informant.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
informant-entity	error	Informant	AssignedEntity and RelatedEntity are mutually exclusive (one must be present) : (assignedEntity | relatedEntity).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)

Differential View

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints
Informant	C	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) informant-entity: AssignedEntity and RelatedEntity are mutually exclusive (one must be present)
@typeCode		0..1	cs	Binding: CDAParticipationType (required) Fixed Value: INF
@contextControlCode		0..1	cs	Binding: CDAContextControl (required) Fixed Value: OP
(Choice of one)		1..1
assignedEntity		0..1	AssignedEntity
relatedEntity		0..1	RelatedEntity
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Informant.typeCode	required	Fixed Value: INF http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType from this IG
Informant.contextControlCode	required	Fixed Value: OP http://hl7.org/cda/stds/core/ValueSet/CDAContextControl from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
informant-entity	error	Informant	AssignedEntity and RelatedEntity are mutually exclusive (one must be present) : (assignedEntity | relatedEntity).count() = 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Informant	C	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) informant-entity: AssignedEntity and RelatedEntity are mutually exclusive (one must be present)
@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		0..1	cs	Binding: CDAParticipationType (required) Fixed Value: INF
@contextControlCode		0..1	cs	Binding: CDAContextControl (required) Fixed Value: OP
(Choice of one)		1..1
assignedEntity		0..1	AssignedEntity
relatedEntity		0..1	RelatedEntity
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Informant.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Informant.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Informant.typeCode	required	Fixed Value: INF http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType from this IG
Informant.contextControlCode	required	Fixed Value: OP http://hl7.org/cda/stds/core/ValueSet/CDAContextControl from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Informant.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
informant-entity	error	Informant	AssignedEntity and RelatedEntity are mutually exclusive (one must be present) : (assignedEntity | relatedEntity).count() = 1

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Informant	C	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) informant-entity: AssignedEntity and RelatedEntity are mutually exclusive (one must be present)
@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		0..1	cs	Binding: CDAParticipationType (required) Fixed Value: INF
@contextControlCode		0..1	cs	Binding: CDAContextControl (required) Fixed Value: OP
(Choice of one)		1..1
assignedEntity		0..1	AssignedEntity
relatedEntity		0..1	RelatedEntity
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Informant.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Informant.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Informant.typeCode	required	Fixed Value: INF http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType from this IG
Informant.contextControlCode	required	Fixed Value: OP http://hl7.org/cda/stds/core/ValueSet/CDAContextControl from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Informant.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
informant-entity	error	Informant	AssignedEntity and RelatedEntity are mutually exclusive (one must be present) : (assignedEntity | relatedEntity).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)

Other representations of profile: CSV, Excel