This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Logical Model V3 Data type CE (CodedWithEquivalents)
{ "resourceType": "StructureDefinition", "id": "CE", "extension": [ { "url": "http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace", "valueUri": "urn:hl7-org:v3" } ], "url": "http://hl7.org/fhir/StructureDefinition/CE", "name": "V3 Data type CE (CodedWithEquivalents)", "display": "V3 Data type CE (CodedWithEquivalents)", "status": "active", "experimental": false, "publisher": "HL7", "description": "Coded data that consists of a coded value (CV) and, optionally, coded value(s) from other coding systems that identify the same concept. Used when alternative codes may exist.", "kind": "logical", "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/CD", "snapshot": { "element": [ { "path": "CE", "min": 1, "max": "*", "type": [ { "code": "Element" } ] }, { "path": "CE.nullFlavor", "representation": [ "xmlAttr" ], "label": "Exceptional Value Detail", "definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "strength": "required", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v3-NullFlavor" } } }, { "path": "CE.code", "representation": [ "xmlAttr" ], "label": "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.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "path": "CE.codeSystem", "representation": [ "xmlAttr" ], "label": "Code System", "definition": "Specifies the code system that defines the code.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "path": "CE.codeSystemName", "representation": [ "xmlAttr" ], "label": "Code System Name", "definition": "The common name of the coding system.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "path": "CE.codeSystemVersion", "representation": [ "xmlAttr" ], "label": "Code System Version", "definition": "If applicable, a version descriptor defined specifically for the given code system.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "path": "CE.displayName", "representation": [ "xmlAttr" ], "label": "Display Name", "definition": "A name or title for the code, under which the sending system shows the code value to its users.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "path": "CE.originalText", "label": "Original Text", "definition": "The text or phrase used as the basis for the coding.", "min": 0, "max": "1", "type": [ { "code": "ED" } ] }, { "path": "CE.translation", "label": "Translation", "definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.", "min": 0, "max": "*", "type": [ { "code": "CD" } ] }, { "path": "CE.qualifier", "label": "Qualifier", "definition": "Specifies additional codes that increase the specificity of the the primary code.", "min": 0, "max": "*", "type": [ { "code": "CR" } ] }, { "extension": [ { "url": "http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace", "valueUri": "urn:hl7-org:sdtc" }, { "url": "http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace", "valueUri": "urn:hl7-org:sdtc" } ], "path": "CE.valueSetVersion", "representation": [ "xmlAttr", "xmlAttr" ], "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.", "min": 0, "max": "1", "type": [ { "code": "string" }, { "code": "string" } ] }, { "path": "CE.code", "representation": [ "xmlAttr" ], "label": "Code", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "path": "CE.codeSystem", "representation": [ "xmlAttr" ], "label": "Code System", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "path": "CE.codeSystemName", "representation": [ "xmlAttr" ], "label": "Code System Name", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "path": "CE.codeSystemVersion", "representation": [ "xmlAttr" ], "label": "Code System Version", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "path": "CE.displayName", "representation": [ "xmlAttr" ], "label": "Display Name", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "path": "CE.originalText", "label": "Original Text", "min": 0, "max": "1", "type": [ { "code": "ED" } ] }, { "path": "CE.translation", "label": "Translation", "min": 0, "max": "*", "type": [ { "code": "CD" } ] }, { "extension": [ { "url": "http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace", "valueUri": "urn:hl7-org:sdtc" }, { "url": "http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace", "valueUri": "urn:hl7-org:sdtc" } ], "path": "CE.valueSetVersion", "representation": [ "xmlAttr", "xmlAttr" ], "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.", "min": 0, "max": "1", "type": [ { "code": "string" }, { "code": "string" } ] } ] }, "differential": { "element": [ { "path": "CE", "min": 1, "max": "*", "type": [ { "code": "Element" } ] }, { "path": "CE.code", "representation": [ "xmlAttr" ], "label": "Code", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "path": "CE.codeSystem", "representation": [ "xmlAttr" ], "label": "Code System", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "path": "CE.codeSystemName", "representation": [ "xmlAttr" ], "label": "Code System Name", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "path": "CE.codeSystemVersion", "representation": [ "xmlAttr" ], "label": "Code System Version", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "path": "CE.displayName", "representation": [ "xmlAttr" ], "label": "Display Name", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "path": "CE.originalText", "label": "Original Text", "min": 0, "max": "1", "type": [ { "code": "ED" } ] }, { "path": "CE.translation", "label": "Translation", "min": 0, "max": "*", "type": [ { "code": "CD" } ] }, { "extension": [ { "url": "http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace", "valueUri": "urn:hl7-org:sdtc" }, { "url": "http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace", "valueUri": "urn:hl7-org:sdtc" } ], "path": "CE.valueSetVersion", "representation": [ "xmlAttr", "xmlAttr" ], "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.", "min": 0, "max": "1", "type": [ { "code": "string" }, { "code": "string" } ] } ] } }
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.