Clinical Document Architecture - Local Development build (v2.0.0-sd-202406-matchbox-patch) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Logical Model: ED: EncapsulatedData (V3 Data Type)

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.

Usage:

• Use this Logical Model Profile: Act (CDA Class), Authenticator (CDA Class), CD: ConceptDescriptor (V3 Data Type), Criterion (CDA Class)... Show 22 more, ED: EncapsulatedData (V3 Data Type), Encounter (CDA Class), Entity (CDA Class), ExternalAct (CDA Class), ExternalDocument (CDA Class), ExternalObservation (CDA Class), ExternalProcedure (CDA Class), LabCriterion (CDA Class), LegalAuthenticator (CDA Class), NonXMLBody (CDA Class), Observation (CDA Class), ObservationMedia (CDA Class), ObservationRange (CDA Class), Organizer (CDA Class), ParentDocument (CDA Class), Patient (CDA Class), Person (CDA Class), PlayingEntity (CDA Class), Procedure (CDA Class), SubjectPerson (CDA Class), SubstanceAdministration (CDA Class) and Supply (CDA Class)

Formal Views of Template Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from ANY

Name	Flags	Card.	Type	Description & Constraints
ED	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) ed-base64: If @representation='B64', then xmlText SHALL be a base64binary string.
@compression		0..1	cs	Binding: CDACompressionAlgorithm (required)
@integrityCheck		0..1	bin
@integrityCheckAlgorithm		0..1	cs	Binding: IntegrityCheckAlgorithm (2.0.0) (required)
@language		0..1	cs
@mediaType		0..1	cs	Binding: MediaType (example)
@representation		0..1	cs	Binding: CDABinaryDataEncoding (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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
ED.compression	required	CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm from this IG
ED.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
ED.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
ED.representation	required	BinaryDataEncoding (a valid code from Binary Data Encoding Code System) http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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}=)?$')

Name	Flags	Card.	Type	Description & Constraints
ED	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) ed-base64: If @representation='B64', then xmlText SHALL be a base64binary string.
@compression		0..1	cs	Binding: CDACompressionAlgorithm (required)
@integrityCheck		0..1	bin
@integrityCheckAlgorithm		0..1	cs	Binding: IntegrityCheckAlgorithm (2.0.0) (required)
@language		0..1	cs
@mediaType		0..1	cs	Binding: MediaType (example)
@representation		0..1	cs	Binding: CDABinaryDataEncoding (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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ED.compression	required	CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm from this IG
ED.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
ED.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
ED.representation	required	BinaryDataEncoding (a valid code from Binary Data Encoding Code System) http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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}=)?$')

Name	Flags	Card.	Type	Description & Constraints
ED	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) ed-base64: If @representation='B64', then xmlText SHALL be a base64binary string.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@compression		0..1	cs	Binding: CDACompressionAlgorithm (required)
@integrityCheck		0..1	bin
@integrityCheckAlgorithm		0..1	cs	Binding: IntegrityCheckAlgorithm (2.0.0) (required)
@language		0..1	cs
@mediaType		0..1	cs	Binding: MediaType (example)
@representation		0..1	cs	Binding: CDABinaryDataEncoding (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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ED.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
ED.compression	required	CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm from this IG
ED.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
ED.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
ED.representation	required	BinaryDataEncoding (a valid code from Binary Data Encoding Code System) http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Summary

Structures

This structure refers to these other structures:

• cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)
• bin: Binary Data (http://hl7.org/cda/stds/core/StructureDefinition/bin)
• st: Character String (http://hl7.org/cda/stds/core/StructureDefinition/st-simple)

Differential View

This structure is derived from ANY

Name	Flags	Card.	Type	Description & Constraints
ED	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) ed-base64: If @representation='B64', then xmlText SHALL be a base64binary string.
@compression		0..1	cs	Binding: CDACompressionAlgorithm (required)
@integrityCheck		0..1	bin
@integrityCheckAlgorithm		0..1	cs	Binding: IntegrityCheckAlgorithm (2.0.0) (required)
@language		0..1	cs
@mediaType		0..1	cs	Binding: MediaType (example)
@representation		0..1	cs	Binding: CDABinaryDataEncoding (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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
ED.compression	required	CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm from this IG
ED.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
ED.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
ED.representation	required	BinaryDataEncoding (a valid code from Binary Data Encoding Code System) http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Name	Flags	Card.	Type	Description & Constraints
ED	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) ed-base64: If @representation='B64', then xmlText SHALL be a base64binary string.
@compression		0..1	cs	Binding: CDACompressionAlgorithm (required)
@integrityCheck		0..1	bin
@integrityCheckAlgorithm		0..1	cs	Binding: IntegrityCheckAlgorithm (2.0.0) (required)
@language		0..1	cs
@mediaType		0..1	cs	Binding: MediaType (example)
@representation		0..1	cs	Binding: CDABinaryDataEncoding (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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ED.compression	required	CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm from this IG
ED.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
ED.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
ED.representation	required	BinaryDataEncoding (a valid code from Binary Data Encoding Code System) http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Name	Flags	Card.	Type	Description & Constraints
ED	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) ed-base64: If @representation='B64', then xmlText SHALL be a base64binary string.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@compression		0..1	cs	Binding: CDACompressionAlgorithm (required)
@integrityCheck		0..1	bin
@integrityCheckAlgorithm		0..1	cs	Binding: IntegrityCheckAlgorithm (2.0.0) (required)
@language		0..1	cs
@mediaType		0..1	cs	Binding: MediaType (example)
@representation		0..1	cs	Binding: CDABinaryDataEncoding (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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ED.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
ED.compression	required	CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm from this IG
ED.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
ED.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
ED.representation	required	BinaryDataEncoding (a valid code from Binary Data Encoding Code System) http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Summary

Structures

This structure refers to these other structures:

• cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)
• bin: Binary Data (http://hl7.org/cda/stds/core/StructureDefinition/bin)
• st: Character String (http://hl7.org/cda/stds/core/StructureDefinition/st-simple)

Other representations of profile: CSV, Excel