ED
type: StructureDefinition
node role: treeRoot
id:
  v: ED
text:
  status:
    v: generated
  div: Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.) Instead of the data itself, an ED may contain only a reference (see TEL.) Note that the ST data type is a specialization of the ED data type when the ED media type is text/plain.
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-target
  value: boolean
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/data-absent-reason
      value: code
        v: not-applicable
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
  value: uri
    v: urn:hl7-org:v3
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-container
  value: uri
    v: http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument
url:
  v: http://hl7.org/cda/stds/core/StructureDefinition/ED
version:
  v: 1.0.1
name:
  v: ED
title:
  v: ED: EncapsulatedData (V3 Data Type)
status:
  v: active
experimental:
  v: false
date:
  v: 2025-10-10T09:58:30+10:00
publisher:
  v: HL7
description:
  v: Data that is primarily intended for human interpretation or for further machine processing outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information in as defined by a different standard (e.g., XML-signatures.) Instead of the data itself, an may contain only a reference (see .) Note that the data type is a specialization of the data type when the media type is text/plain.
fhir version:
  v: 5.0.0
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
kind:
  v: logical
abstract:
  v: false
type:
  v: http://hl7.org/cda/stds/core/StructureDefinition/ED
base definition:
  v: http://hl7.org/cda/stds/core/StructureDefinition/ANY
  link: http://hl7.org/cda/stds/core/StructureDefinition/ANY
derivation:
  v: specialization
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
    value: string
      v: 1.0.1
  element:
    id:
      v: ED
    path:
      v: ED
    short:
      v: Base for all types and resources
    definition:
      v: Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.) Instead of the data itself, an ED may contain only a reference (see TEL.) Note that the ST data type is a specialization of when the is text/plain.
    min:
      v: 1
    max:
      v: *
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: ed-base64
      severity:
        v: error
      human:
        v: If @representation='B64', then xmlText SHALL be a base64binary string.
      expression:
        v: (representation.empty() or representation != 'B64') or xmlText.empty() or xmlText.matches('^(?:[A-Za-z0-9+//]{4})*(?:[A-Za-z0-9+//]{2}==|[A-Za-z0-9+//]{3}=)?$')
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: ED.nullFlavor
    path:
      v: ED.nullFlavor
    representation:
      v: xmlAttr
    label:
      v: Exceptional Value Detail
    definition:
      v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: ANY.nullFlavor
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: code
      profile:
        v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
        link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    binding:
      strength:
        v: required
      value set:
        v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
        link: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
  element:
    id:
      v: ED.compression
    path:
      v: ED.compression
    representation:
      v: xmlAttr
    label:
      v: Compression
    definition:
      v: Indicates whether the raw byte data is compressed, and what compression algorithm was used.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: ED.compression
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: code
      profile:
        v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
        link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    binding:
      strength:
        v: required
      value set:
        v: http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
        link: http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
  element:
    id:
      v: ED.integrityCheck
    path:
      v: ED.integrityCheck
    representation:
      v: xmlAttr
    label:
      v: Integrity Check
    definition:
      v: 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:
      v: 0
    max:
      v: 1
    base:
      path:
        v: ED.integrityCheck
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: base64Binary
      profile:
        v: http://hl7.org/cda/stds/core/StructureDefinition/bin
        link: http://hl7.org/cda/stds/core/StructureDefinition/bin

id:
  v: ED.integrityCheckAlgorithm
path:
  v: ED.integrityCheckAlgorithm
representation:
  v: xmlAttr
label:
  v: Integrity Check Algorithm
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: ED.integrityCheckAlgorithm
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
    link: 2.0
    link: .0

id:
  v: ED.language
path:
  v: ED.language
representation:
  v: xmlAttr
label:
  v: Language
definition:
  v: For character based information the language property specifies the human language of the text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ED.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple

id:
  v: ED.mediaType
path:
  v: ED.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ED.mediaType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
binding:
  strength:
    v: example
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-MediaType
    link: http://terminology.hl7.org/ValueSet/v3-MediaType

id:
  v: ED.representation
path:
  v: ED.representation
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ED.representation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
    link: http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding

id:
  v: ED.xmlText
path:
  v: ED.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
definition:
  v: Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ED.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    link: http://hl7.org/cda/stds/core/StructureDefinition/st-simple

id:
  v: ED.reference
path:
  v: ED.reference
label:
  v: Reference
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: ED.reference
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/TEL

id:
  v: ED.thumbnail
path:
  v: ED.thumbnail
label:
  v: Thumbnail
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: ED.thumbnail
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ED

element:
  id:
    v: ED
  path:
    v: ED
  definition:
    v: Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.) Instead of the data itself, an ED may contain only a reference (see TEL.) Note that the ST data type is a specialization of when the is text/plain.
  min:
    v: 1
  max:
    v: *
  constraint:
    key:
      v: ed-base64
    severity:
      v: error
    human:
      v: If @representation='B64', then xmlText SHALL be a base64binary string.
    expression:
      v: (representation.empty() or representation != 'B64') or xmlText.empty() or xmlText.matches('^(?:[A-Za-z0-9+//]{4})*(?:[A-Za-z0-9+//]{2}==|[A-Za-z0-9+//]{3}=)?$')
element:
  id:
    v: ED.compression
  path:
    v: ED.compression
  representation:
    v: xmlAttr
  label:
    v: Compression
  definition:
    v: Indicates whether the raw byte data is compressed, and what compression algorithm was used.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: code
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
      link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
  binding:
    strength:
      v: required
    value set:
      v: http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
      link: http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
element:
  id:
    v: ED.integrityCheck
  path:
    v: ED.integrityCheck
  representation:
    v: xmlAttr
  label:
    v: Integrity Check
  definition:
    v: 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:
    v: 0
  max:
    v: 1
  type:
    code:
      v: base64Binary
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/bin
      link: http://hl7.org/cda/stds/core/StructureDefinition/bin
element:
  id:
    v: ED.integrityCheckAlgorithm
  path:
    v: ED.integrityCheckAlgorithm
  representation:
    v: xmlAttr
  label:
    v: Integrity Check Algorithm
  definition:
    v: 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:
    v: 0
  max:
    v: 1
  type:
    code:
      v: code
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
      link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
  binding:
    strength:
      v: required
    value set:
      v: http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
      link: 2.0
      link: .0
element:
  id:
    v: ED.language
  path:
    v: ED.language
  representation:
    v: xmlAttr
  label:
    v: Language
  definition:
    v: For character based information the language property specifies the human language of the text.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: code
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
      link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
element:
  id:
    v: ED.mediaType
  path:
    v: ED.mediaType
  representation:
    v: xmlAttr
  label:
    v: Media Type
  definition:
    v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: code
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
      link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
  binding:
    strength:
      v: example
    value set:
      v: http://terminology.hl7.org/ValueSet/v3-MediaType
      link: http://terminology.hl7.org/ValueSet/v3-MediaType
element:
  id:
    v: ED.representation
  path:
    v: ED.representation
  representation:
    v: xmlAttr
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: code
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
      link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
  binding:
    strength:
      v: required
    value set:
      v: http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
      link: http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
element:
  id:
    v: ED.xmlText
  path:
    v: ED.xmlText
  representation:
    v: xmlText
  short:
    v: Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
  definition:
    v: Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)
  comment:
    v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
      link: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
element:
  id:
    v: ED.reference
  path:
    v: ED.reference
  label:
    v: Reference
  definition:
    v: 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:
    v: 0

v: 1

id:
  v: ED.thumbnail
path:
  v: ED.thumbnail
label:
  v: Thumbnail
definition:
  v: 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:
  v: 0
max:
  v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ED