Clinical Document Architecture with Australian Schema
1.0.0 - current
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
| Active as of 2024-12-18 |
XML representation of the CR logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="CR"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<p>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".</p>
</div>
</text>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/logical-target">
<valueBoolean>
<extension
url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
<valueCode value="not-applicable"/>
</extension>
</valueBoolean>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
<valueUri value="urn:hl7-org:v3"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/logical-container">
<valueUri
value="http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"/>
</extension>
<url value="http://hl7.org/cda/stds/core/StructureDefinition/CR"/>
<version value="1.0.0"/>
<name value="CR"/>
<title value="CR: ConceptRole (V3 Data Type)"/>
<status value="active"/>
<experimental value="false"/>
<date value="2024-12-18T05:40:48+00:00"/>
<publisher value="HL7"/>
<description
value="A concept qualifier code with optionally named role. Both qualifier role and value codes must be defined by the coding system of the CD containing the concept qualifier. 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"."/>
<fhirVersion value="5.0.0"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="logical"/>
<abstract value="false"/>
<type value="http://hl7.org/cda/stds/core/StructureDefinition/CR"/>
<baseDefinition
value="http://hl7.org/cda/stds/core/StructureDefinition/ANY"/>
<derivation value="specialization"/>
<snapshot>
<element id="CR">
<path value="CR"/>
<short value="Base for all types and resources"/>
<definition
value="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"."/>
<min value="1"/>
<max value="*"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="value-null-cr"/>
<severity value="error"/>
<human
value="Must contain value or nullFlavor. If nullFlavor is present, name and value must not be present."/>
<expression
value="(value.exists() or nullFlavor.exists()) and (nullFlavor.exists() implies (name | value).empty())"/>
</constraint>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="CR.nullFlavor">
<path value="CR.nullFlavor"/>
<representation value="xmlAttr"/>
<label value="Exceptional Value Detail"/>
<definition
value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ANY.nullFlavor"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"/>
</binding>
</element>
<element id="CR.inverted">
<path value="CR.inverted"/>
<representation value="xmlAttr"/>
<label value="Inversion Indicator"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CR.inverted"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
<profile value="http://hl7.org/cda/stds/core/StructureDefinition/bn"/>
</type>
</element>
<element id="CR.name">
<path value="CR.name"/>
<label value="Name"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CR.name"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CV"/>
</type>
</element>
<element id="CR.value">
<path value="CR.value"/>
<label value="Value"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CR.value"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CD"/>
</type>
</element>
</snapshot>
<differential>
<element id="CR">
<path value="CR"/>
<definition
value="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"."/>
<min value="1"/>
<max value="*"/>
<constraint>
<key value="value-null-cr"/>
<severity value="error"/>
<human
value="Must contain value or nullFlavor. If nullFlavor is present, name and value must not be present."/>
<expression
value="(value.exists() or nullFlavor.exists()) and (nullFlavor.exists() implies (name | value).empty())"/>
</constraint>
</element>
<element id="CR.inverted">
<path value="CR.inverted"/>
<representation value="xmlAttr"/>
<label value="Inversion Indicator"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="boolean"/>
<profile value="http://hl7.org/cda/stds/core/StructureDefinition/bn"/>
</type>
</element>
<element id="CR.name">
<path value="CR.name"/>
<label value="Name"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CV"/>
</type>
</element>
<element id="CR.value">
<path value="CR.value"/>
<label value="Value"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CD"/>
</type>
</element>
</differential>
</StructureDefinition>IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-12-18
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
