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

CDA entries represent the structured computer-processable components within a document section. Each section can contain zero to many entries.

Usage:

• Use this Logical Model Profile: Act (CDA Class), Encounter (CDA Class), Observation (CDA Class), ObservationMedia (CDA Class)... Show 4 more, Procedure (CDA Class), RegionOfInterest (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
EntryRelationship	C	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) entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
@typeCode		1..1	cs	Binding: x_ActRelationshipEntryRelationship (required)
@inversionInd		0..1	bl
@contextConductionInd		0..1	bl
@negationInd		0..1	bl
sequenceNumber		0..1	INT
seperatableInd		0..1	BL
(Choice of one)		1..1
act		0..1	Act
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
EntryRelationship.typeCode	required	XActRelationshipEntryRelationship http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

Id	Grade	Path(s)	Details	Requirements
entry-rel-only-one	error	EntryRelationship	SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1

Name	Flags	Card.	Type	Description & Constraints
EntryRelationship	C	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) entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
@typeCode		1..1	cs	Binding: x_ActRelationshipEntryRelationship (required)
@inversionInd		0..1	bl
@contextConductionInd		0..1	bl
@negationInd		0..1	bl
sequenceNumber		0..1	INT
seperatableInd		0..1	BL
(Choice of one)		1..1
act		0..1	Act
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EntryRelationship.typeCode	required	XActRelationshipEntryRelationship http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

Id	Grade	Path(s)	Details	Requirements
entry-rel-only-one	error	EntryRelationship	SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1

Name	Flags	Card.	Type	Description & Constraints
EntryRelationship	C	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) entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
@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
@typeCode		1..1	cs	Binding: x_ActRelationshipEntryRelationship (required)
@inversionInd		0..1	bl
@contextConductionInd		0..1	bl
@negationInd		0..1	bl
sequenceNumber		0..1	INT
seperatableInd		0..1	BL
(Choice of one)		1..1
act		0..1	Act
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EntryRelationship.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
EntryRelationship.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
EntryRelationship.typeCode	required	XActRelationshipEntryRelationship http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

Id	Grade	Path(s)	Details	Requirements
entry-rel-only-one	error	EntryRelationship	SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).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)
• bl: Boolean (http://hl7.org/cda/stds/core/StructureDefinition/bl-simple)

Differential View

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints
EntryRelationship	C	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) entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
@typeCode		1..1	cs	Binding: x_ActRelationshipEntryRelationship (required)
@inversionInd		0..1	bl
@contextConductionInd		0..1	bl
@negationInd		0..1	bl
sequenceNumber		0..1	INT
seperatableInd		0..1	BL
(Choice of one)		1..1
act		0..1	Act
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
EntryRelationship.typeCode	required	XActRelationshipEntryRelationship http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

Id	Grade	Path(s)	Details	Requirements
entry-rel-only-one	error	EntryRelationship	SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
EntryRelationship	C	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) entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
@typeCode		1..1	cs	Binding: x_ActRelationshipEntryRelationship (required)
@inversionInd		0..1	bl
@contextConductionInd		0..1	bl
@negationInd		0..1	bl
sequenceNumber		0..1	INT
seperatableInd		0..1	BL
(Choice of one)		1..1
act		0..1	Act
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EntryRelationship.typeCode	required	XActRelationshipEntryRelationship http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

Id	Grade	Path(s)	Details	Requirements
entry-rel-only-one	error	EntryRelationship	SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
EntryRelationship	C	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) entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
@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
@typeCode		1..1	cs	Binding: x_ActRelationshipEntryRelationship (required)
@inversionInd		0..1	bl
@contextConductionInd		0..1	bl
@negationInd		0..1	bl
sequenceNumber		0..1	INT
seperatableInd		0..1	BL
(Choice of one)		1..1
act		0..1	Act
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EntryRelationship.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
EntryRelationship.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
EntryRelationship.typeCode	required	XActRelationshipEntryRelationship http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

Id	Grade	Path(s)	Details	Requirements
entry-rel-only-one	error	EntryRelationship	SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).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)
• bl: Boolean (http://hl7.org/cda/stds/core/StructureDefinition/bl-simple)

Other representations of profile: CSV, Excel