Clinical Document Architecture V2.1
2.1.0 - CI Build

Clinical Document Architecture V2.1, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/HL7/cda-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: CE - JSON Profile

JSON representation of the CE logical model.

Raw json | Download

{
  "resourceType" : "StructureDefinition",
  "id" : "CE",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>Coded data, 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.</p>\n    </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
      "valueUri" : "urn:hl7-org:v3"
    }
  ],
  "url" : "http://hl7.org/fhir/cda/StructureDefinition/CE",
  "version" : "2.1.0",
  "name" : "CE",
  "title" : "CE: CodedWithEquivalents (V3 Data Type)",
  "status" : "active",
  "experimental" : false,
  "date" : "2020-07-14T20:15:37+00:00",
  "publisher" : "Health Level 7",
  "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.",
  "fhirVersion" : "4.0.1",
  "kind" : "logical",
  "abstract" : false,
  "type" : "CE",
  "baseDefinition" : "http://hl7.org/fhir/cda/StructureDefinition/CD",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "CE",
        "path" : "CE",
        "definition" : "Coded data, 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.",
        "min" : 1,
        "max" : "*",
        "base" : {
          "path" : "Base",
          "min" : 0,
          "max" : "*"
        },
        "isModifier" : false
      },
      {
        "id" : "CE.nullFlavor",
        "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",
        "base" : {
          "path" : "ANY.nullFlavor",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
        }
      },
      {
        "id" : "CE.code",
        "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",
        "base" : {
          "path" : "CD.code",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "CE.codeSystem",
        "path" : "CE.codeSystem",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Code System",
        "definition" : "Specifies the code system that defines the code.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "CD.codeSystem",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "CE.codeSystemName",
        "path" : "CE.codeSystemName",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Code System Name",
        "definition" : "The common name of the coding system.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "CD.codeSystemName",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "CE.codeSystemVersion",
        "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",
        "base" : {
          "path" : "CD.codeSystemVersion",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "CE.displayName",
        "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",
        "base" : {
          "path" : "CD.displayName",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "CE.valueSet",
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
            "valueUri" : "urn:hl7-org:sdtc"
          }
        ],
        "path" : "CE.valueSet",
        "representation" : [
          "xmlAttr"
        ],
        "definition" : "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "CD.valueSet",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "CE.valueSetVersion",
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
            "valueUri" : "urn:hl7-org:sdtc"
          }
        ],
        "path" : "CE.valueSetVersion",
        "representation" : [
          "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",
        "base" : {
          "path" : "CD.valueSetVersion",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "CE.originalText",
        "path" : "CE.originalText",
        "label" : "Original Text",
        "definition" : "The text or phrase used as the basis for the coding.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "CD.originalText",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/ED"
          }
        ]
      },
      {
        "id" : "CE.qualifier",
        "path" : "CE.qualifier",
        "label" : "Qualifier",
        "definition" : "Specifies additional codes that increase the specificity of the the primary code.",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "CD.qualifier",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CR"
          }
        ]
      },
      {
        "id" : "CE.translation",
        "path" : "CE.translation",
        "representation" : [
          "typeAttr"
        ],
        "label" : "Translation",
        "definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "CD.translation",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CD"
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "CE",
        "path" : "CE",
        "definition" : "Coded data, 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.",
        "min" : 1,
        "max" : "*"
      },
      {
        "id" : "CE.qualifier",
        "path" : "CE.qualifier",
        "label" : "Qualifier",
        "definition" : "Specifies additional codes that increase the specificity of the the primary code.",
        "min" : 0,
        "max" : "0",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CR"
          }
        ]
      }
    ]
  }
}