CR: ConceptRole (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: CR - Detailed Descriptions

Active as of 2024-12-18

Definitions for the CR 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. CR
Definition	A concept qualifier code with optionally named role. Both qualifier role and value codes must be defined by the coding system. For example, if SNOMED RT defines a concept "leg", a role relation "has-laterality", and another concept "left", the concept role relation allows to add the qualifier "has-laterality: left" to a primary code "leg" to construct the meaning "left leg".
Control	1..*
Logical Container	ADHA ClinicalDocument (CDA Class)
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	value-null-cr: Must contain value or nullFlavor. If nullFlavor is present, name and value must not be present. (`(value.exists() or nullFlavor.exists()) and (nullFlavor.exists() implies (name \| value).empty())`)
2. CR.inverted
Definition	Indicates if the sense of the role name is inverted. This can be used in cases where the underlying code system defines inversion but does not provide reciprocal pairs of role names. By default, inverted is false.
Control	0..1
Type	boolean(bn: BooleanNonNull)
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	Inversion Indicator
4. CR.name
Definition	Specifies the manner in which the concept role value contributes to the meaning of a code phrase. For example, if SNOMED RT defines a concept "leg", a role relation "has-laterality", and another concept "left", the concept role relation allows to add the qualifier "has-laterality: left" to a primary code "leg" to construct the meaning "left leg". In this example "has-laterality" is the CR.name.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/CV
Label	Name
6. CR.value
Definition	The concept that modifies the primary code of a code phrase through the role relation. For example, if SNOMED RT defines a concept "leg", a role relation "has-laterality", and another concept "left", the concept role relation allows adding the qualifier "has-laterality: left" to a primary code "leg" to construct the meaning "left leg". In this example "left" is the CR.value.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
Label	Value

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

0. CR
Definition	A concept qualifier code with optionally named role. Both qualifier role and value codes must be defined by the coding system. For example, if SNOMED RT defines a concept "leg", a role relation "has-laterality", and another concept "left", the concept role relation allows to add the qualifier "has-laterality: left" to a primary code "leg" to construct the meaning "left leg". Base definition for all types defined in FHIR type system.
Short	Base for all types and resources
Control	10..*
Is Modifier	false
Logical Container	ADHA ClinicalDocument (CDA Class)
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	value-null-cr: Must contain value or nullFlavor. If nullFlavor is present, name and value must not be present. (`(value.exists() or nullFlavor.exists()) and (nullFlavor.exists() implies (name \| value).empty())`)
2. CR.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. CR.inverted
Definition	Indicates if the sense of the role name is inverted. This can be used in cases where the underlying code system defines inversion but does not provide reciprocal pairs of role names. By default, inverted is false.
Control	0..1
Type	boolean(bn: BooleanNonNull)
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	Inversion Indicator
6. CR.name
Definition	Specifies the manner in which the concept role value contributes to the meaning of a code phrase. For example, if SNOMED RT defines a concept "leg", a role relation "has-laterality", and another concept "left", the concept role relation allows to add the qualifier "has-laterality: left" to a primary code "leg" to construct the meaning "left leg". In this example "has-laterality" is the CR.name.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/CV
Label	Name
8. CR.value
Definition	The concept that modifies the primary code of a code phrase through the role relation. For example, if SNOMED RT defines a concept "leg", a role relation "has-laterality", and another concept "left", the concept role relation allows adding the qualifier "has-laterality: left" to a primary code "leg" to construct the meaning "left leg". In this example "left" is the CR.value.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
Label	Value

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

0. CR
Definition	A concept qualifier code with optionally named role. Both qualifier role and value codes must be defined by the coding system. For example, if SNOMED RT defines a concept "leg", a role relation "has-laterality", and another concept "left", the concept role relation allows to add the qualifier "has-laterality: left" to a primary code "leg" to construct the meaning "left leg".
Short	Base for all types and resources
Control	1..*
Is Modifier	false
Logical Container	ADHA ClinicalDocument (CDA Class)
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	value-null-cr: Must contain value or nullFlavor. If nullFlavor is present, name and value must not be present. (`(value.exists() or nullFlavor.exists()) and (nullFlavor.exists() implies (name \| value).empty())`)
2. CR.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. CR.inverted
Definition	Indicates if the sense of the role name is inverted. This can be used in cases where the underlying code system defines inversion but does not provide reciprocal pairs of role names. By default, inverted is false.
Control	0..1
Type	boolean(bn: BooleanNonNull)
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	Inversion Indicator
6. CR.name
Definition	Specifies the manner in which the concept role value contributes to the meaning of a code phrase. For example, if SNOMED RT defines a concept "leg", a role relation "has-laterality", and another concept "left", the concept role relation allows to add the qualifier "has-laterality: left" to a primary code "leg" to construct the meaning "left leg". In this example "has-laterality" is the CR.name.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/CV
Label	Name
8. CR.value
Definition	The concept that modifies the primary code of a code phrase through the role relation. For example, if SNOMED RT defines a concept "leg", a role relation "has-laterality", and another concept "left", the concept role relation allows adding the qualifier "has-laterality: left" to a primary code "leg" to construct the meaning "left leg". In this example "left" is the CR.value.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
Label	Value