Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft
Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft
This page is part of the CDA: Clinical Document Architecture (v2.1.0-draft1: CDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions 
| Active as of 2023-01-16 |
XML representation of the CS logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="CS"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<p>Coded data, consists of a code, display name, code system, and original text. Used when a single code value must be sent.</p>
</div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-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/StructureDefinition/elementdefinition-binding-style">
<valueCode value="CDA"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-binding-style">
<valueCode value="CDA"/>
</extension>
<url value="http://hl7.org/fhir/cda/StructureDefinition/CS"/>
<version value="2.1.0-draft1"/>
<name value="CS"/>
<title value="CS: CodedSimpleValue (V3 Data Type)"/>
<status value="active"/>
<experimental value="false"/>
<date value="2023-01-16T16:39:50+11:00"/>
<publisher value="Health Level 7"/>
<contact>
<name value="HL7 International - Cross-Group Projects"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/cgp"/>
</telecom>
<telecom>
<system value="email"/>
<value value="cgp@lists.HL7.org"/>
</telecom>
</contact>
<description
value="XCoded data in its simplest form, where only the code is not predetermined. The code system and code system version are fixed by the context in which the CS value occurs. CS is used for coded attributes that have a single HL7-defined value set."/>
<fhirVersion value="5.0.0-snapshot3"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="logical"/>
<abstract value="false"/>
<type value="CS"/>
<baseDefinition value="http://hl7.org/fhir/cda/StructureDefinition/CV"/>
<derivation value="specialization"/>
<snapshot>
<element id="CS">
<path value="CS"/>
<short value="Base for all types and resources"/>
<definition
value="Coded data, consists of a code, display name, code system, and original text. Used when a single code value must be sent."/>
<min value="1"/>
<max value="*"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="CS.nullFlavor">
<path value="CS.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"/>
</type>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-NullFlavor"/>
</binding>
</element>
<element id="CS.code">
<path value="CS.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="string"/>
</type>
</element>
<element id="CS.codeSystem">
<path value="CS.codeSystem"/>
<representation value="xmlAttr"/>
<label value="Code System"/>
<definition value="Specifies the code system that defines the code."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="CD.codeSystem"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="CS.codeSystemName">
<path value="CS.codeSystemName"/>
<representation value="xmlAttr"/>
<label value="Code System Name"/>
<definition value="The common name of the coding system."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="CD.codeSystemName"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="CS.codeSystemVersion">
<path value="CS.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="0"/>
<base>
<path value="CD.codeSystemVersion"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="CS.displayName">
<path value="CS.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="0"/>
<base>
<path value="CD.displayName"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="CS.sdtcValueSet">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
<valueUri value="urn:hl7-org:sdtc"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name">
<valueString value="valueSet"/>
</extension>
<path value="CS.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"/>
</type>
</element>
<element id="CS.sdtcValueSetVersion">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
<valueUri value="urn:hl7-org:sdtc"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name">
<valueString value="valueSetVersion"/>
</extension>
<path value="CS.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"/>
</type>
</element>
<element id="CS.originalText">
<path value="CS.originalText"/>
<label value="Original Text"/>
<definition
value="The text or phrase used as the basis for the coding."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="CD.originalText"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/ED"/>
</type>
</element>
<element id="CS.qualifier">
<path value="CS.qualifier"/>
<label value="Qualifier"/>
<definition
value="Specifies additional codes that increase the specificity of the the primary code."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="CD.qualifier"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/CR"/>
</type>
</element>
<element id="CS.translation">
<path value="CS.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="0"/>
<base>
<path value="CD.translation"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/CD"/>
</type>
</element>
</snapshot>
<differential>
<element id="CS">
<path value="CS"/>
<definition
value="Coded data, consists of a code, display name, code system, and original text. Used when a single code value must be sent."/>
<min value="1"/>
<max value="*"/>
</element>
<element id="CS.codeSystem">
<path value="CS.codeSystem"/>
<representation value="xmlAttr"/>
<label value="Code System"/>
<min value="0"/>
<max value="0"/>
<type>
<code value="string"/>
</type>
</element>
<element id="CS.codeSystemName">
<path value="CS.codeSystemName"/>
<representation value="xmlAttr"/>
<label value="Code System Name"/>
<min value="0"/>
<max value="0"/>
<type>
<code value="string"/>
</type>
</element>
<element id="CS.codeSystemVersion">
<path value="CS.codeSystemVersion"/>
<representation value="xmlAttr"/>
<label value="Code System Version"/>
<min value="0"/>
<max value="0"/>
<type>
<code value="string"/>
</type>
</element>
<element id="CS.displayName">
<path value="CS.displayName"/>
<representation value="xmlAttr"/>
<label value="Display Name"/>
<min value="0"/>
<max value="0"/>
<type>
<code value="string"/>
</type>
</element>
<element id="CS.sdtcValueSet">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
<valueUri value="urn:hl7-org:sdtc"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name">
<valueString value="valueSet"/>
</extension>
<path value="CS.sdtcValueSet"/>
<representation value="xmlAttr"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="CS.sdtcValueSetVersion">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
<valueUri value="urn:hl7-org:sdtc"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name">
<valueString value="valueSetVersion"/>
</extension>
<path value="CS.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"/>
</type>
</element>
<element id="CS.originalText">
<path value="CS.originalText"/>
<label value="Original Text"/>
<min value="0"/>
<max value="0"/>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/ED"/>
</type>
</element>
</differential>
</StructureDefinition>
IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.1.0-draft1 based on FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change