Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft
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 
| Active as of 2023-01-16 |
JSON representation of the ST logical model.
{
"resourceType" : "StructureDefinition",
"id" : "ST",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>The character string data type stands for text data, primarily intended for machine processing (e.g., sorting, querying, indexing, etc.) Used for names, symbols, and formal expressions.</p>\n </div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:v3"
}
],
"url" : "http://hl7.org/fhir/cda/StructureDefinition/ST",
"version" : "2.1.0-draft1",
"name" : "ST",
"title" : "ST: CharacterString (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" : "The character string data type stands for text data, primarily intended for machine processing (e.g., sorting, querying, indexing, etc.) Used for names, symbols, and formal expressions.",
"fhirVersion" : "5.0.0-snapshot3",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "ED",
"baseDefinition" : "http://hl7.org/fhir/cda/StructureDefinition/ED",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "ED",
"path" : "ED",
"short" : "Base for all types and resources",
"definition" : "The character string data type stands for text data, primarily intended for machine processing (e.g., sorting, querying, indexing, etc.) Used for names, symbols, and formal expressions.",
"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" : "ED.nullFlavor",
"path" : "ED.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" : "ED.charset",
"path" : "ED.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" : "ED.compression",
"path" : "ED.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" : "ED.integrityCheck",
"path" : "ED.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" : "ED.integrityCheckAlgorithm",
"path" : "ED.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" : "ED.language",
"path" : "ED.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" : "ED.mediaType",
"path" : "ED.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" : "ED.representation",
"path" : "ED.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ED.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "TXT"
},
{
"id" : "ED.data[x]",
"path" : "ED.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" : "ED.reference",
"path" : "ED.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" : "ED.thumbnail",
"path" : "ED.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"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "ED",
"path" : "ED",
"definition" : "The character string data type stands for text data, primarily intended for machine processing (e.g., sorting, querying, indexing, etc.) Used for names, symbols, and formal expressions.",
"min" : 1,
"max" : "*"
},
{
"id" : "ED.compression",
"path" : "ED.compression",
"representation" : [
"xmlAttr"
],
"label" : "Compression",
"definition" : "Indicates whether the raw byte data is compressed, and what compression algorithm was used.",
"min" : 0,
"max" : "0"
},
{
"id" : "ED.integrityCheck",
"path" : "ED.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"
},
{
"id" : "ED.integrityCheckAlgorithm",
"path" : "ED.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"
},
{
"id" : "ED.mediaType",
"path" : "ED.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",
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ED.representation",
"path" : "ED.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "TXT"
},
{
"id" : "ED.data[x]",
"path" : "ED.data[x]",
"representation" : [
"xmlText"
],
"definition" : "The string value",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ED.reference",
"path" : "ED.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"
},
{
"id" : "ED.thumbnail",
"path" : "ED.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"
}
]
}
}
IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.1.0-draft1 based on FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change