Ccda/CD.json

Logical Model V3 Data type CD (ConceptDescriptor)

{
  "resourceType": "StructureDefinition",
  "id": "CD",
  "extension": [
    {
      "url": "http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace",
      "valueUri": "urn:hl7-org:v3"
    }
  ],
  "url": "http://hl7.org/fhir/StructureDefinition/CD",
  "name": "V3 Data type CD (ConceptDescriptor)",
  "display": "V3 Data type CD (ConceptDescriptor)",
  "status": "active",
  "experimental": false,
  "publisher": "HL7",
  "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.",
  "kind": "logical",
  "abstract": false,
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ANY",
  "snapshot": {
    "element": [
      {
        "path": "CD",
        "min": 1,
        "max": "*",
        "type": [
          {
            "code": "Element"
          }
        ]
      },
      {
        "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",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/ValueSet/v3-NullFlavor"
          }
        }
      },
      {
        "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"
          }
        ]
      },
      {
        "path": "CD.codeSystem",
        "representation": [
          "xmlAttr"
        ],
        "label": "Code System",
        "definition": "Specifies the code system that defines the code.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "path": "CD.codeSystemName",
        "representation": [
          "xmlAttr"
        ],
        "label": "Code System Name",
        "definition": "The common name of the coding system.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "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"
          }
        ]
      },
      {
        "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"
          }
        ]
      },
      {
        "path": "CD.originalText",
        "label": "Original Text",
        "definition": "The text or phrase used as the basis for the coding.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "ED"
          }
        ]
      },
      {
        "path": "CD.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": "CD.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": "CD.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": "CD",
        "min": 1,
        "max": "*",
        "type": [
          {
            "code": "Element"
          }
        ]
      },
      {
        "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"
          }
        ]
      },
      {
        "path": "CD.codeSystem",
        "representation": [
          "xmlAttr"
        ],
        "label": "Code System",
        "definition": "Specifies the code system that defines the code.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "path": "CD.codeSystemName",
        "representation": [
          "xmlAttr"
        ],
        "label": "Code System Name",
        "definition": "The common name of the coding system.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "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"
          }
        ]
      },
      {
        "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"
          }
        ]
      },
      {
        "path": "CD.originalText",
        "label": "Original Text",
        "definition": "The text or phrase used as the basis for the coding.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "ED"
          }
        ]
      },
      {
        "path": "CD.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": "CD.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": "CD.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"
          }
        ]
      }
    ]
  }
}