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 |
Definitions for the CS logical model.
Guidance on how to interpret the contents of this table can be found here.
1. CS | |
Definition | Coded data, consists of a code, display name, code system, and original text. Used when a single code value must be sent. |
Control | 1..* |
XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. CS.codeSystem | |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
3. CS.codeSystemName | |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
4. CS.codeSystemVersion | |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
5. CS.displayName | |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
6. CS.sdtcValueSet | |
Control | 0..1 |
Type | string |
XML Representation | 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 . |
7. CS.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 |
XML Representation | 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 . |
8. CS.originalText | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
Guidance on how to interpret the contents of this table can be found here.
1. CS | |
Definition | Coded data, consists of a code, display name, code system, and original text. Used when a single code value must be sent. Base definition for all types defined in FHIR type system. |
Control | 10..* |
XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3 . |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
2. CS.codeSystem | |
Definition | Specifies the code system that defines the code. |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
3. CS.codeSystemName | |
Definition | The common name of the coding system. |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
4. CS.codeSystemVersion | |
Definition | If applicable, a version descriptor defined specifically for the given code system. |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
5. CS.displayName | |
Definition | A name or title for the code, under which the sending system shows the code value to its users. |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
6. CS.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 |
XML Representation | 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 . |
7. CS.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 |
XML Representation | 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 . |
8. CS.originalText | |
Definition | The text or phrase used as the basis for the coding. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
9. CS.qualifier | |
Definition | Specifies additional codes that increase the specificity of the the primary code. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
10. CS.translation | |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
XML Representation | The type of this property is determined using the xsi:type attribute. |
Guidance on how to interpret the contents of this table can be found here.
1. CS | |
Definition | Coded data, consists of a code, display name, code system, and original text. Used when a single code value must be sent. |
Control | 1..* |
XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. CS.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 NullFlavor |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
3. CS.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 | string |
XML Representation | In the XML format, this property is represented as an attribute. |
4. CS.codeSystem | |
Definition | Specifies the code system that defines the code. |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
5. CS.codeSystemName | |
Definition | The common name of the coding system. |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
6. CS.codeSystemVersion | |
Definition | If applicable, a version descriptor defined specifically for the given code system. |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
7. CS.displayName | |
Definition | A name or title for the code, under which the sending system shows the code value to its users. |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
8. CS.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 |
XML Representation | 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 . |
9. CS.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 |
XML Representation | 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 . |
10. CS.originalText | |
Definition | The text or phrase used as the basis for the coding. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
11. CS.qualifier | |
Definition | Specifies additional codes that increase the specificity of the the primary code. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
12. CS.translation | |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
XML Representation | The type of this property is determined using the xsi:type attribute. |