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 CD logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="CD"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<p>A concept descriptor represents any kind of concept usually by giving a code defined in a code system. A concept descriptor can contain the original text or phrase that served as the basis of the coding and one or more translations into different coding systems. A concept descriptor can also contain qualifiers to describe, e.g., the concept of a "left foot" as a postcoordinated term built from the primary code "FOOT" and the qualifier "LEFT". In exceptional cases, the concept descriptor need not contain a code but only the original text describing that concept.</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/StructureDefinition/structuredefinition-type-characteristics">
<valueCode value="can-bind"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-binding-style">
<valueCode value="CDA"/>
</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/CD"/>
<version value="1.0.0"/>
<name value="CD"/>
<title value="CD: ConceptDescriptor (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 descriptor represents any kind of concept usually by giving a code defined in a code system. A concept descriptor can contain the original text or phrase that served as the basis of the coding and one or more translations into different coding systems. A concept descriptor can also contain qualifiers to describe, e.g., the concept of a "left foot" as a postcoordinated term built from the primary code "FOOT" and the qualifier "LEFT". In cases of an exceptional value, the concept descriptor need not contain a code but only the original text describing that concept."/>
<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/CD"/>
<baseDefinition
value="http://hl7.org/cda/stds/core/StructureDefinition/ANY"/>
<derivation value="specialization"/>
<snapshot>
<element id="CD">
<path value="CD"/>
<short value="Base for all types and resources"/>
<definition
value="A concept descriptor represents any kind of concept usually by giving a code defined in a code system. A concept descriptor can contain the original text or phrase that served as the basis of the coding and one or more translations into different coding systems. A concept descriptor can also contain qualifiers to describe, e.g., the concept of a "left foot" as a postcoordinated term built from the primary code "FOOT" and the qualifier "LEFT". In exceptional cases, the concept descriptor need not contain a code but only the original text describing that concept."/>
<min value="1"/>
<max value="*"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="CD.nullFlavor">
<path value="CD.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="CD.code">
<path value="CD.code"/>
<representation value="xmlAttr"/>
<label value="Code"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CD.code"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
</element>
<element id="CD.codeSystem">
<path value="CD.codeSystem"/>
<representation value="xmlAttr"/>
<label value="Code System"/>
<definition value="Specifies the code system that defines the code."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CD.codeSystem"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/oid"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/uuid"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/ruid"/>
</type>
</element>
<element id="CD.codeSystemName">
<path value="CD.codeSystemName"/>
<representation value="xmlAttr"/>
<label value="Code System Name"/>
<definition value="The common name of the coding system."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CD.codeSystemName"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="CD.codeSystemVersion">
<path value="CD.codeSystemVersion"/>
<representation value="xmlAttr"/>
<label value="Code System Version"/>
<definition
value="If applicable, a version descriptor defined specifically for the given code system."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CD.codeSystemVersion"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="CD.displayName">
<path value="CD.displayName"/>
<representation value="xmlAttr"/>
<label value="Display Name"/>
<definition
value="A name or title for the code, under which the sending system shows the code value to its users."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CD.displayName"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="CD.sdtcValueSet">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
<valueUri value="urn:hl7-org:sdtc"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/xml-name">
<valueString value="valueSet"/>
</extension>
<path value="CD.sdtcValueSet"/>
<representation value="xmlAttr"/>
<definition
value="The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CD.valueSet"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/oid"/>
</type>
</element>
<element id="CD.sdtcValueSetVersion">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
<valueUri value="urn:hl7-org:sdtc"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/xml-name">
<valueString value="valueSetVersion"/>
</extension>
<path value="CD.sdtcValueSetVersion"/>
<representation value="xmlAttr"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CD.sdtcValueSetVersion"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="CD.originalText">
<path value="CD.originalText"/>
<label value="Original Text"/>
<definition
value="The text or phrase used as the basis for the coding."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CD.originalText"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ED"/>
</type>
</element>
<element id="CD.qualifier">
<path value="CD.qualifier"/>
<label value="Qualifier"/>
<definition
value="Specifies additional codes that increase the specificity of the the primary code."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="CD.qualifier"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CR"/>
</type>
</element>
<element id="CD.translation">
<path value="CD.translation"/>
<representation value="typeAttr"/>
<label value="Translation"/>
<definition
value="A set of other concept descriptors that translate this concept descriptor into other code systems."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="CD.translation"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CD"/>
</type>
</element>
</snapshot>
<differential>
<element id="CD">
<path value="CD"/>
<definition
value="A concept descriptor represents any kind of concept usually by giving a code defined in a code system. A concept descriptor can contain the original text or phrase that served as the basis of the coding and one or more translations into different coding systems. A concept descriptor can also contain qualifiers to describe, e.g., the concept of a "left foot" as a postcoordinated term built from the primary code "FOOT" and the qualifier "LEFT". In exceptional cases, the concept descriptor need not contain a code but only the original text describing that concept."/>
<min value="1"/>
<max value="*"/>
</element>
<element id="CD.code">
<path value="CD.code"/>
<representation value="xmlAttr"/>
<label value="Code"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
</element>
<element id="CD.codeSystem">
<path value="CD.codeSystem"/>
<representation value="xmlAttr"/>
<label value="Code System"/>
<definition value="Specifies the code system that defines the code."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/oid"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/uuid"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/ruid"/>
</type>
</element>
<element id="CD.codeSystemName">
<path value="CD.codeSystemName"/>
<representation value="xmlAttr"/>
<label value="Code System Name"/>
<definition value="The common name of the coding system."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="CD.codeSystemVersion">
<path value="CD.codeSystemVersion"/>
<representation value="xmlAttr"/>
<label value="Code System Version"/>
<definition
value="If applicable, a version descriptor defined specifically for the given code system."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="CD.displayName">
<path value="CD.displayName"/>
<representation value="xmlAttr"/>
<label value="Display Name"/>
<definition
value="A name or title for the code, under which the sending system shows the code value to its users."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="CD.sdtcValueSet">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
<valueUri value="urn:hl7-org:sdtc"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/xml-name">
<valueString value="valueSet"/>
</extension>
<path value="CD.sdtcValueSet"/>
<representation value="xmlAttr"/>
<definition
value="The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CD.valueSet"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/oid"/>
</type>
</element>
<element id="CD.sdtcValueSetVersion">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
<valueUri value="urn:hl7-org:sdtc"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/xml-name">
<valueString value="valueSetVersion"/>
</extension>
<path value="CD.sdtcValueSetVersion"/>
<representation value="xmlAttr"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="CD.originalText">
<path value="CD.originalText"/>
<label value="Original Text"/>
<definition
value="The text or phrase used as the basis for the coding."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ED"/>
</type>
</element>
<element id="CD.qualifier">
<path value="CD.qualifier"/>
<label value="Qualifier"/>
<definition
value="Specifies additional codes that increase the specificity of the the primary code."/>
<min value="0"/>
<max value="*"/>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CR"/>
</type>
</element>
<element id="CD.translation">
<path value="CD.translation"/>
<representation value="typeAttr"/>
<label value="Translation"/>
<definition
value="A set of other concept descriptors that translate this concept descriptor into other code systems."/>
<min value="0"/>
<max value="*"/>
<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
