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

A physical thing, group of physical things or an organization capable of participating in Acts while in a role.

An entity is a physical object that has, had or will have existence. The only exception to this is Organization, which while not having a physical presence, fulfills the other characteristics of an Entity. Entity stipulates the thing itself, not the Roles it may play: the Role of Patient, e.g., is played by the Person Entity.

Living subjects (including human beings), organizations, materials, places and their specializations.

Usage:

• Use this Logical Model Profile: ParticipantRole (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
Entity		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: EntityClassRoot (required)
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id		0..*	II
code		0..1	CE	Binding: CDAEntityCode (example)
desc		0..1	ED
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Entity.classCode	required	EntityClassRoot http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Entity.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Entity.code	example	CDAEntityCode http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode from this IG

Name	Flags	Card.	Type	Description & Constraints
Entity		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: EntityClassRoot (required)
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id		0..*	II
code		0..1	CE	Binding: CDAEntityCode (example)
desc		0..1	ED
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Entity.classCode	required	EntityClassRoot http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Entity.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Entity.code	example	CDAEntityCode http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode from this IG

Name	Flags	Card.	Type	Description & Constraints
Entity		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: EntityClassRoot (required)
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id		0..*	II
code		0..1	CE	Binding: CDAEntityCode (example)
desc		0..1	ED
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Entity.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Entity.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Entity.classCode	required	EntityClassRoot http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Entity.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Entity.code	example	CDAEntityCode http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode from this IG

This structure is derived from InfrastructureRoot

Summary

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
Entity		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: EntityClassRoot (required)
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id		0..*	II
code		0..1	CE	Binding: CDAEntityCode (example)
desc		0..1	ED
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Entity.classCode	required	EntityClassRoot http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Entity.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Entity.code	example	CDAEntityCode http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Entity		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: EntityClassRoot (required)
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id		0..*	II
code		0..1	CE	Binding: CDAEntityCode (example)
desc		0..1	ED
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Entity.classCode	required	EntityClassRoot http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Entity.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Entity.code	example	CDAEntityCode http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Entity		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: EntityClassRoot (required)
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id		0..*	II
code		0..1	CE	Binding: CDAEntityCode (example)
desc		0..1	ED
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Entity.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Entity.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Entity.classCode	required	EntityClassRoot http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Entity.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Entity.code	example	CDAEntityCode http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode from this IG

This structure is derived from InfrastructureRoot

Summary

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