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

A ManufacturedMaterial used in an activity without being substantially changed through that activity.

This includes durable (reusable) medical equipment as well as disposable equipment. The kind of device is identified by the code attribute inherited from Entity.

Usages:

• Use this Logical Model: ParticipantRole (CDA Class)

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Device		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: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@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: EntityClassDevice (required)
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code		0..1	CE	Binding: CDAEntityCode (example)
manufacturerModelName		0..1	SC	Binding: Manufacturer Model Name Example (example)
softwareName		0..1	SC	Binding: Software Name Example (example)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Device.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
Device.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
Device.classCode	required	EntityClassDevice http://terminology.hl7.org/ValueSet/v3-EntityClassDevice
Device.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Device.code	example	CDAEntityCode http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode From this IG
Device.manufacturerModelName	example	ManufacturerModelNameExample http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample
Device.softwareName	example	SoftwareNameExample http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample

Constraints

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

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Device		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: ClinicalDocument (CDA Class)
@classCode		0..1	cs	Binding: EntityClassDevice (required)
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code		0..1	CE	Binding: CDAEntityCode (example)
manufacturerModelName		0..1	SC	Binding: Manufacturer Model Name Example (example)
softwareName		0..1	SC	Binding: Software Name Example (example)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Device.classCode	required	EntityClassDevice http://terminology.hl7.org/ValueSet/v3-EntityClassDevice
Device.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Device.code	example	CDAEntityCode http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode From this IG
Device.manufacturerModelName	example	ManufacturerModelNameExample http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample
Device.softwareName	example	SoftwareNameExample http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Device		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: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@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: EntityClassDevice (required)
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code		0..1	CE	Binding: CDAEntityCode (example)
manufacturerModelName		0..1	SC	Binding: Manufacturer Model Name Example (example)
softwareName		0..1	SC	Binding: Software Name Example (example)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Device.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
Device.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
Device.classCode	required	EntityClassDevice http://terminology.hl7.org/ValueSet/v3-EntityClassDevice
Device.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Device.code	example	CDAEntityCode http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode From this IG
Device.manufacturerModelName	example	ManufacturerModelNameExample http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample
Device.softwareName	example	SoftwareNameExample http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample

Constraints

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

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)

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Device		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: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@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: EntityClassDevice (required)
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code		0..1	CE	Binding: CDAEntityCode (example)
manufacturerModelName		0..1	SC	Binding: Manufacturer Model Name Example (example)
softwareName		0..1	SC	Binding: Software Name Example (example)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Device.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
Device.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
Device.classCode	required	EntityClassDevice http://terminology.hl7.org/ValueSet/v3-EntityClassDevice
Device.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Device.code	example	CDAEntityCode http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode From this IG
Device.manufacturerModelName	example	ManufacturerModelNameExample http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample
Device.softwareName	example	SoftwareNameExample http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample

Constraints

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

Differential View

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Device		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: ClinicalDocument (CDA Class)
@classCode		0..1	cs	Binding: EntityClassDevice (required)
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code		0..1	CE	Binding: CDAEntityCode (example)
manufacturerModelName		0..1	SC	Binding: Manufacturer Model Name Example (example)
softwareName		0..1	SC	Binding: Software Name Example (example)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Device.classCode	required	EntityClassDevice http://terminology.hl7.org/ValueSet/v3-EntityClassDevice
Device.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Device.code	example	CDAEntityCode http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode From this IG
Device.manufacturerModelName	example	ManufacturerModelNameExample http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample
Device.softwareName	example	SoftwareNameExample http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Device		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: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@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: EntityClassDevice (required)
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code		0..1	CE	Binding: CDAEntityCode (example)
manufacturerModelName		0..1	SC	Binding: Manufacturer Model Name Example (example)
softwareName		0..1	SC	Binding: Software Name Example (example)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Device.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
Device.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
Device.classCode	required	EntityClassDevice http://terminology.hl7.org/ValueSet/v3-EntityClassDevice
Device.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Device.code	example	CDAEntityCode http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode From this IG
Device.manufacturerModelName	example	ManufacturerModelNameExample http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample
Device.softwareName	example	SoftwareNameExample http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample

Constraints

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

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)

Maturity: 1

Other representations of profile: CSV, Excel