Clinical Document Architecture V2.0.1
2.1.0 - CI Build

Clinical Document Architecture V2.0.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: SC - JSON Profile

JSON representation of the SC logical model.

Raw json | Download


{
  "resourceType" : "StructureDefinition",
  "id" : "SC",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>A ST that optionally may have a code attached. The text must always be present if a code is present. The code is often a local code.</p>\n    </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
      "valueUri" : "urn:hl7-org:v3"
    }
  ],
  "url" : "http://hl7.org/fhir/cda/StructureDefinition/SC",
  "version" : "2.1.0",
  "name" : "SC",
  "title" : "SC: CharacterStringWithCode (V3 Data Type)",
  "status" : "active",
  "experimental" : false,
  "date" : "2021-04-15T20:51:17+00:00",
  "publisher" : "Health Level 7",
  "description" : "A character string that optionally may have a code attached. The text must always be present if a code is present. The code is often a local code.",
  "fhirVersion" : "4.0.1",
  "kind" : "logical",
  "abstract" : false,
  "type" : "SC",
  "baseDefinition" : "http://hl7.org/fhir/cda/StructureDefinition/ST",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "SC",
        "path" : "SC",
        "definition" : "An ST that optionally may have a code attached. The text must always be present if a code is present. The code is often a local code.",
        "min" : 1,
        "max" : "*",
        "base" : {
          "path" : "Base",
          "min" : 0,
          "max" : "*"
        },
        "isModifier" : false
      },
      {
        "id" : "SC.nullFlavor",
        "path" : "SC.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" : "SC.charset",
        "path" : "SC.charset",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Charset",
        "definition" : "For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 [].",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "ED.charset",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ]
      },
      {
        "id" : "SC.compression",
        "path" : "SC.compression",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Compression",
        "definition" : "Indicates whether the raw byte data is compressed, and what compression algorithm was used.",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "ED.compression",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-CompressionAlgorithm"
        }
      },
      {
        "id" : "SC.integrityCheck",
        "path" : "SC.integrityCheck",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Integrity Check",
        "definition" : "The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "ED.integrityCheck",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "base64Binary"
          }
        ]
      },
      {
        "id" : "SC.integrityCheckAlgorithm",
        "path" : "SC.integrityCheckAlgorithm",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Integrity Check Algorithm",
        "definition" : "Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "ED.integrityCheckAlgorithm",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm"
        }
      },
      {
        "id" : "SC.language",
        "path" : "SC.language",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Language",
        "definition" : "For character based information the language property specifies the human language of the text.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "ED.language",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ]
      },
      {
        "id" : "SC.mediaType",
        "path" : "SC.mediaType",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Media Type",
        "definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "ED.mediaType",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "fixedCode" : "text/plain"
      },
      {
        "id" : "SC.representation",
        "path" : "SC.representation",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "ED.representation",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "fixedCode" : "TXT"
      },
      {
        "id" : "SC.data[x]",
        "path" : "SC.data[x]",
        "representation" : [
          "xmlText"
        ],
        "definition" : "The string value",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "ED.data[x]",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "SC.reference",
        "path" : "SC.reference",
        "label" : "Reference",
        "definition" : "A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "ED.reference",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/TEL"
          }
        ]
      },
      {
        "id" : "SC.thumbnail",
        "path" : "SC.thumbnail",
        "label" : "Thumbnail",
        "definition" : "An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "ED.thumbnail",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/ED"
          }
        ]
      },
      {
        "id" : "SC.code",
        "path" : "SC.code",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Code",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "SC.code",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "SC.codeSystem",
        "path" : "SC.codeSystem",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Code System",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "SC.codeSystem",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "SC.codeSystemName",
        "path" : "SC.codeSystemName",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Code System Name",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "SC.codeSystemName",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "SC.codeSystemVersion",
        "path" : "SC.codeSystemVersion",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Code System Version",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "SC.codeSystemVersion",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "SC.displayName",
        "path" : "SC.displayName",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Display Name",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "SC.displayName",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "SC",
        "path" : "SC",
        "definition" : "An ST that optionally may have a code attached. The text must always be present if a code is present. The code is often a local code.",
        "min" : 1,
        "max" : "*"
      },
      {
        "id" : "SC.code",
        "path" : "SC.code",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Code",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "SC.codeSystem",
        "path" : "SC.codeSystem",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Code System",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "SC.codeSystemName",
        "path" : "SC.codeSystemName",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Code System Name",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "SC.codeSystemVersion",
        "path" : "SC.codeSystemVersion",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Code System Version",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "SC.displayName",
        "path" : "SC.displayName",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Display Name",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      }
    ]
  }
}