ADHA extension code: CodedWithEquivalents (V3 Data Type) - Definitions - 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: code - Detailed Descriptions

Active as of 2024-11-22

Definitions for the code logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. code
Definition	Coded data, consists of a coded value (CV) and, optionally, coded value(s) from other coding systems that identify the same concept. Used when alternative codes may exist.
Short	ADHA CDA extension to represent code
Control	1..*
Logical Container	ADHA ClinicalDocument (CDA Class)
binding style	This type can be bound to a value set using the CDA binding style
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. code.qualifier
Definition	Specifies additional codes that increase the specificity of the the primary code.
Control	0..0
Type	http://hl7.org/cda/stds/core/StructureDefinition/CR
Label	Qualifier

Guidance on how to interpret the contents of this table can be found here

0. code
Definition	Coded data, consists of a coded value (CV) and, optionally, coded value(s) from other coding systems that identify the same concept. Used when alternative codes may exist. Base definition for all types defined in FHIR type system.
Short	ADHA CDA extension to represent codeBase for all types and resources
Control	10..*
Is Modifier	false
Logical Container	ADHA ClinicalDocument (CDA Class)
binding style	This type can be bound to a value set using the CDA binding style
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. code.qualifier
Definition	Specifies additional codes that increase the specificity of the the primary code.
Control	0..0
Type	http://hl7.org/cda/stds/core/StructureDefinition/CR
Label	Qualifier

Guidance on how to interpret the contents of this table can be found here

0. code
Definition	Coded data, consists of a coded value (CV) and, optionally, coded value(s) from other coding systems that identify the same concept. Used when alternative codes may exist.
Short	ADHA CDA extension to represent code
Control	1..*
Is Modifier	false
Logical Container	ADHA ClinicalDocument (CDA Class)
binding style	This type can be bound to a value set using the CDA binding style
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. code.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
4. code.code
Definition	The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
Control	0..1
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code
6. code.codeSystem
Definition	Specifies the code system that defines the code.
Control	0..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code System
8. code.codeSystemName
Definition	The common name of the coding system.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code System Name
10. code.codeSystemVersion
Definition	If applicable, a version descriptor defined specifically for the given code system.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code System Version
12. code.displayName
Definition	A name or title for the code, under which the sending system shows the code value to its users.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Display Name
14. code.sdtcValueSet
Definition	The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
Control	0..1
Type	string(oid: ISO Object Identifier)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
16. code.sdtcValueSetVersion
Definition	The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
18. code.originalText
Definition	The text or phrase used as the basis for the coding.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
Label	Original Text
20. code.qualifier
Definition	Specifies additional codes that increase the specificity of the the primary code.
Control	0..0
Type	http://hl7.org/cda/stds/core/StructureDefinition/CR
Label	Qualifier
22. code.translation
Definition	A set of other concept descriptors that translate this concept descriptor into other code systems.
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format	The type of this property is determined using the `xsi:type`attribute.
Label	Translation