Clinical Document Architecture
2.0.0-sd-202406-matchbox-patch - release

Clinical Document Architecture - Local Development build (v2.0.0-sd-202406-matchbox-patch) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: CV - JSON Profile

Active as of 2024-06-19

JSON representation of the CV logical model.

Raw json | Download


{
  "resourceType" : "StructureDefinition",
  "id" : "CV",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>Coded data, consists of a code, display name, code system, and original text. Used when a single code value must be sent.</p>\n    </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
      "_valueBoolean" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
            "valueCode" : "not-applicable"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-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/tools/StructureDefinition/logical-container",
      "valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
    }
  ],
  "url" : "http://hl7.org/cda/stds/core/StructureDefinition/CV",
  "version" : "2.0.0-sd-202406-matchbox-patch",
  "name" : "CV",
  "title" : "CV: CodedValue (V3 Data Type)",
  "status" : "active",
  "experimental" : false,
  "date" : "2024-06-19T17:47:42+02:00",
  "publisher" : "Health Level 7",
  "contact" : [
    {
      "name" : "HL7 International - Structured Documents",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/structure"
        },
        {
          "system" : "email",
          "value" : "structdog@lists.HL7.org"
        }
      ]
    }
  ],
  "description" : "Coded data, specifying only a code, code system, and optionally display name and original text. Used only as the data type for other data types' properties.",
  "fhirVersion" : "5.0.0",
  "mapping" : [
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    }
  ],
  "kind" : "logical",
  "abstract" : false,
  "type" : "http://hl7.org/cda/stds/core/StructureDefinition/CV",
  "baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/CE",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "CV",
        "path" : "CV",
        "short" : "Base for all types and resources",
        "definition" : "Coded data, consists of a code, display name, code system, and original text. Used when a single code value must be sent.",
        "min" : 1,
        "max" : "*",
        "base" : {
          "path" : "Base",
          "min" : 0,
          "max" : "*"
        },
        "isModifier" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          }
        ]
      },
      {
        "id" : "CV.nullFlavor",
        "path" : "CV.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",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
        }
      },
      {
        "id" : "CV.code",
        "path" : "CV.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" : "code",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ]
      },
      {
        "id" : "CV.codeSystem",
        "path" : "CV.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",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/oid"🔗 ,
              "http://hl7.org/cda/stds/core/StructureDefinition/uuid"🔗 ,
              "http://hl7.org/cda/stds/core/StructureDefinition/ruid"
            ]
          }
        ]
      },
      {
        "id" : "CV.codeSystemName",
        "path" : "CV.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",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id" : "CV.codeSystemVersion",
        "path" : "CV.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",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id" : "CV.displayName",
        "path" : "CV.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",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id" : "CV.sdtcValueSet",
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri" : "urn:hl7-org:sdtc"
          },
          {
            "url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
            "valueString" : "valueSet"
          }
        ],
        "path" : "CV.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",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/oid"
            ]
          }
        ]
      },
      {
        "id" : "CV.sdtcValueSetVersion",
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri" : "urn:hl7-org:sdtc"
          },
          {
            "url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
            "valueString" : "valueSetVersion"
          }
        ],
        "path" : "CV.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",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id" : "CV.originalText",
        "path" : "CV.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/cda/stds/core/StructureDefinition/ED"
          }
        ]
      },
      {
        "id" : "CV.qualifier",
        "path" : "CV.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/cda/stds/core/StructureDefinition/CR"
          }
        ]
      },
      {
        "id" : "CV.translation",
        "path" : "CV.translation",
        "representation" : [
          "typeAttr"
        ],
        "label" : "Translation",
        "definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "CD.translation",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CD"
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "CV",
        "path" : "CV",
        "definition" : "Coded data, consists of a code, display name, code system, and original text. Used when a single code value must be sent.",
        "min" : 1,
        "max" : "*"
      },
      {
        "id" : "CV.translation",
        "path" : "CV.translation",
        "label" : "Translation",
        "definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
        "min" : 0,
        "max" : "0"
      }
    ]
  }
}