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

Logical Model: CD - JSON Profile

Active as of 2023-01-16

JSON representation of the CD logical model.

Raw json | Download


{
  "resourceType" : "StructureDefinition",
  "id" : "CD",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <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 &quot;left foot&quot; as a postcoordinated term built from the primary code &quot;FOOT&quot; and the qualifier &quot;LEFT&quot;. In exceptional cases, the concept descriptor need not contain a code but only the original text describing that concept.</p>\n    </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
      "valueUri" : "urn:hl7-org:v3"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode" : "can-bind"
    },
    {
      "url" : "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-binding-style",
      "valueCode" : "CDA"
    }
  ],
  "url" : "http://hl7.org/fhir/cda/StructureDefinition/CD",
  "version" : "2.1.0-draft1",
  "name" : "CD",
  "title" : "CD: ConceptDescriptor (V3 Data Type)",
  "status" : "active",
  "experimental" : false,
  "date" : "2023-01-16T16:39:50+11:00",
  "publisher" : "Health Level 7",
  "contact" : [
    {
      "name" : "HL7 International - Cross-Group Projects",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cgp"
        },
        {
          "system" : "email",
          "value" : "cgp@lists.HL7.org"
        }
      ]
    }
  ],
  "description" : "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" : "5.0.0-snapshot3",
  "mapping" : [
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    }
  ],
  "kind" : "logical",
  "abstract" : false,
  "type" : "CD",
  "baseDefinition" : "http://hl7.org/fhir/cda/StructureDefinition/ANY",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "CD",
        "path" : "CD",
        "short" : "Base for all types and resources",
        "definition" : "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" : 1,
        "max" : "*",
        "base" : {
          "path" : "Base",
          "min" : 0,
          "max" : "*"
        },
        "constraint" : [
          {
            "key" : "ele-1",
            "severity" : "error",
            "human" : "All FHIR elements must have a @value or children",
            "expression" : "hasValue() or (children().count() > id.count())",
            "source" : "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          }
        ]
      },
      {
        "id" : "CD.nullFlavor",
        "path" : "CD.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" : "CD.code",
        "path" : "CD.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" : "CD.codeSystem",
        "path" : "CD.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" : "CD.codeSystemName",
        "path" : "CD.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" : "CD.codeSystemVersion",
        "path" : "CD.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" : "CD.displayName",
        "path" : "CD.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" : "CD.sdtcValueSet",
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
            "valueUri" : "urn:hl7-org:sdtc"
          },
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
            "valueString" : "valueSet"
          }
        ],
        "path" : "CD.sdtcValueSet",
        "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" : "CD.sdtcValueSetVersion",
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
            "valueUri" : "urn:hl7-org:sdtc"
          },
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
            "valueString" : "valueSetVersion"
          }
        ],
        "path" : "CD.sdtcValueSetVersion",
        "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.sdtcValueSetVersion",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "CD.originalText",
        "path" : "CD.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" : "CD.qualifier",
        "path" : "CD.qualifier",
        "label" : "Qualifier",
        "definition" : "Specifies additional codes that increase the specificity of the the primary code.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "CD.qualifier",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CR"
          }
        ]
      },
      {
        "id" : "CD.translation",
        "path" : "CD.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" : "CD",
        "path" : "CD",
        "definition" : "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" : 1,
        "max" : "*"
      },
      {
        "id" : "CD.code",
        "path" : "CD.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"
          }
        ]
      },
      {
        "id" : "CD.codeSystem",
        "path" : "CD.codeSystem",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Code System",
        "definition" : "Specifies the code system that defines the code.",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "CD.codeSystemName",
        "path" : "CD.codeSystemName",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Code System Name",
        "definition" : "The common name of the coding system.",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "CD.codeSystemVersion",
        "path" : "CD.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"
          }
        ]
      },
      {
        "id" : "CD.displayName",
        "path" : "CD.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"
          }
        ]
      },
      {
        "id" : "CD.sdtcValueSet",
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
            "valueUri" : "urn:hl7-org:sdtc"
          },
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
            "valueString" : "valueSet"
          }
        ],
        "path" : "CD.sdtcValueSet",
        "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" : "CD.sdtcValueSetVersion",
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
            "valueUri" : "urn:hl7-org:sdtc"
          },
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
            "valueString" : "valueSetVersion"
          }
        ],
        "path" : "CD.sdtcValueSetVersion",
        "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",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "CD.originalText",
        "path" : "CD.originalText",
        "label" : "Original Text",
        "definition" : "The text or phrase used as the basis for the coding.",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/ED"
          }
        ]
      },
      {
        "id" : "CD.qualifier",
        "path" : "CD.qualifier",
        "label" : "Qualifier",
        "definition" : "Specifies additional codes that increase the specificity of the the primary code.",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CR"
          }
        ]
      },
      {
        "id" : "CD.translation",
        "path" : "CD.translation",
        "representation" : [
          "typeAttr"
        ],
        "label" : "Translation",
        "definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CD"
          }
        ]
      }
    ]
  }
}