Clinical Document Architecture with Australian Schema - Local Development build (v1.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: ED: EncapsulatedData (V3 Data Type)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/ED Version: 1.0.1
Active as of 2025-10-10 Maturity Level: 1 Responsible: HL7 Computable Name: ED

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.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ED C 1..* ANY XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor
Logical Container: ClinicalDocument (CDA Class)
Constraints: ed-base64
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... @compression 0..1 cs Binding: CompressionAlgorithm (required)
... @integrityCheck 0..1 bin
... @language 0..1 cs
... @mediaType 0..1 cs Binding: MediaType (example)
... @representation 0..1 cs Binding: Binary Data Encoding Value Set (required)
... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
... reference 0..1 TEL
... thumbnail 0..1 ED

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ED.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ED.compression Base required CompressionAlgorithm 📦1.0.1 This IG
ED.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
ED.mediaType Base example MediaType 📦2.0.0 THO v5.2
ED.representation Base required Binary Data Encoding Value Set 📦1.0.1 This IG

Constraints

Id Grade Path(s) Description Expression
ed-base64 error ED If @representation='B64', then xmlText SHALL be a base64binary string. (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}=)?$')

This structure is derived from ANY

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ED C 1..* ANY XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor
Logical Container: ClinicalDocument (CDA Class)
Constraints: ed-base64
... @compression 0..1 cs Binding: CompressionAlgorithm (required)
... @integrityCheck 0..1 bin
... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
... @mediaType 0..1 cs Binding: MediaType (example)
... @representation 0..1 cs Binding: Binary Data Encoding Value Set (required)
... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
... reference 0..1 TEL
... thumbnail 0..1 ED

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ED.compression Base required CompressionAlgorithm 📦1.0.1 This IG
ED.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
ED.mediaType Base example MediaType 📦2.0.0 THO v5.2
ED.representation Base required Binary Data Encoding Value Set 📦1.0.1 This IG

Constraints

Id Grade Path(s) Description Expression
ed-base64 error ED If @representation='B64', then xmlText SHALL be a base64binary string. (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}=)?$')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ED C 1..* ANY XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor
Logical Container: ClinicalDocument (CDA Class)
Constraints: ed-base64
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... @compression 0..1 cs Binding: CompressionAlgorithm (required)
... @integrityCheck 0..1 bin
... @language 0..1 cs
... @mediaType 0..1 cs Binding: MediaType (example)
... @representation 0..1 cs Binding: Binary Data Encoding Value Set (required)
... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
... reference 0..1 TEL
... thumbnail 0..1 ED

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ED.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ED.compression Base required CompressionAlgorithm 📦1.0.1 This IG
ED.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
ED.mediaType Base example MediaType 📦2.0.0 THO v5.2
ED.representation Base required Binary Data Encoding Value Set 📦1.0.1 This IG

Constraints

Id Grade Path(s) Description Expression
ed-base64 error ED If @representation='B64', then xmlText SHALL be a base64binary string. (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}=)?$')

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ED C 1..* ANY XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor
Logical Container: ClinicalDocument (CDA Class)
Constraints: ed-base64
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... @compression 0..1 cs Binding: CompressionAlgorithm (required)
... @integrityCheck 0..1 bin
... @language 0..1 cs
... @mediaType 0..1 cs Binding: MediaType (example)
... @representation 0..1 cs Binding: Binary Data Encoding Value Set (required)
... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
... reference 0..1 TEL
... thumbnail 0..1 ED

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ED.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ED.compression Base required CompressionAlgorithm 📦1.0.1 This IG
ED.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
ED.mediaType Base example MediaType 📦2.0.0 THO v5.2
ED.representation Base required Binary Data Encoding Value Set 📦1.0.1 This IG

Constraints

Id Grade Path(s) Description Expression
ed-base64 error ED If @representation='B64', then xmlText SHALL be a base64binary string. (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}=)?$')

Differential View

This structure is derived from ANY

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ED C 1..* ANY XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor
Logical Container: ClinicalDocument (CDA Class)
Constraints: ed-base64
... @compression 0..1 cs Binding: CompressionAlgorithm (required)
... @integrityCheck 0..1 bin
... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
... @mediaType 0..1 cs Binding: MediaType (example)
... @representation 0..1 cs Binding: Binary Data Encoding Value Set (required)
... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
... reference 0..1 TEL
... thumbnail 0..1 ED

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ED.compression Base required CompressionAlgorithm 📦1.0.1 This IG
ED.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
ED.mediaType Base example MediaType 📦2.0.0 THO v5.2
ED.representation Base required Binary Data Encoding Value Set 📦1.0.1 This IG

Constraints

Id Grade Path(s) Description Expression
ed-base64 error ED If @representation='B64', then xmlText SHALL be a base64binary string. (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}=)?$')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ED C 1..* ANY XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor
Logical Container: ClinicalDocument (CDA Class)
Constraints: ed-base64
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... @compression 0..1 cs Binding: CompressionAlgorithm (required)
... @integrityCheck 0..1 bin
... @language 0..1 cs
... @mediaType 0..1 cs Binding: MediaType (example)
... @representation 0..1 cs Binding: Binary Data Encoding Value Set (required)
... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
... reference 0..1 TEL
... thumbnail 0..1 ED

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ED.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ED.compression Base required CompressionAlgorithm 📦1.0.1 This IG
ED.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
ED.mediaType Base example MediaType 📦2.0.0 THO v5.2
ED.representation Base required Binary Data Encoding Value Set 📦1.0.1 This IG

Constraints

Id Grade Path(s) Description Expression
ed-base64 error ED If @representation='B64', then xmlText SHALL be a base64binary string. (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}=)?$')

 

Other representations of profile: CSV, Excel