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

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice				Version: 1.0.0
Active as of 2024-12-18			Responsible: HL7	Computable Name: AuthoringDevice

AuthoringDevice (CDA Class)

Usage:

Use this Logical Model Profile: AssignedAuthor (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
AuthoringDevice	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: EntityClassDevice (required) Fixed Value: DEV
@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)
asMaintainedEntity	0..*	MaintainedEntity
Documentation for this format

Terminology Bindings (Differential)

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

Name	Flags	Card.	Type	Description & Constraints
AuthoringDevice		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	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) Fixed Value: DEV
@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)
asMaintainedEntity		0..*	MaintainedEntity
Documentation for this format

Terminology Bindings

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

Constraints

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

Name	Flags	Card.	Type	Description & Constraints
AuthoringDevice		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	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) Fixed Value: DEV
@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)
asMaintainedEntity		0..*	MaintainedEntity
Documentation for this format

Terminology Bindings

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

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	AuthoringDevice.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: 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	Card.	Type	Description & Constraints
AuthoringDevice	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: EntityClassDevice (required) Fixed Value: DEV
@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)
asMaintainedEntity	0..*	MaintainedEntity
Documentation for this format

Terminology Bindings (Differential)

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
AuthoringDevice		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	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) Fixed Value: DEV
@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)
asMaintainedEntity		0..*	MaintainedEntity
Documentation for this format

Terminology Bindings

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

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	AuthoringDevice.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
AuthoringDevice		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	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) Fixed Value: DEV
@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)
asMaintainedEntity		0..*	MaintainedEntity
Documentation for this format

Terminology Bindings

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

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	AuthoringDevice.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: 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