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

Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Device				Version: 1.0.0
Active as of 2024-12-18				Computable Name: au-Device
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 Device 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 ParticipantRole ADHA (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
Device	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Device class Instance of this type are validated by templateId Logical Container: ADHA 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: EntityCode (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	EntityCode `http://terminology.hl7.org/ValueSet/v3-EntityCode`
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
Device		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Device 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		0..1	cs	Binding: EntityClassDevice (required)
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code		0..1	CE	Binding: EntityCode (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	EntityCode `http://terminology.hl7.org/ValueSet/v3-EntityCode`
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()

Name	Flags	Card.	Type	Description & Constraints
Device		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Device 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		0..1	cs	Binding: EntityClassDevice (required)
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code		0..1	CE	Binding: EntityCode (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	EntityCode `http://terminology.hl7.org/ValueSet/v3-EntityCode`
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)

Differential View

This structure is derived from InfrastructureRoot

Name	Card.	Type	Description & Constraints
Device	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Device class Instance of this type are validated by templateId Logical Container: ADHA 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: EntityCode (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	EntityCode `http://terminology.hl7.org/ValueSet/v3-EntityCode`
Device.manufacturerModelName	example	ManufacturerModelNameExample `http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample`
Device.softwareName	example	SoftwareNameExample `http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample`

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Device		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Device 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		0..1	cs	Binding: EntityClassDevice (required)
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code		0..1	CE	Binding: EntityCode (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	EntityCode `http://terminology.hl7.org/ValueSet/v3-EntityCode`
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Device		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Device 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		0..1	cs	Binding: EntityClassDevice (required)
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
code		0..1	CE	Binding: EntityCode (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	EntityCode `http://terminology.hl7.org/ValueSet/v3-EntityCode`
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)

Other representations of profile: CSV, Excel