Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.0-sd built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-core-sd/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/cda/stds/core/StructureDefinition/ED | Version: 2.0.0-sd | |||
Active as of 2024-10-25 | 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.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
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 |
Path | Conformance | ValueSet | URI |
ED.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm from this IG | |
ED.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
ED.mediaType | example | MediaTypehttp://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 |
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 |
Path | Conformance | ValueSet | URI |
ED.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm from this IG | |
ED.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
ED.mediaType | example | MediaTypehttp://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 |
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 |
Path | Conformance | ValueSet | URI |
ED.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
ED.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm from this IG | |
ED.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
ED.mediaType | example | MediaTypehttp://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 |
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
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 |
Path | Conformance | ValueSet | URI |
ED.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm from this IG | |
ED.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
ED.mediaType | example | MediaTypehttp://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 |
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 |
Path | Conformance | ValueSet | URI |
ED.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm from this IG | |
ED.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
ED.mediaType | example | MediaTypehttp://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 |
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 |
Path | Conformance | ValueSet | URI |
ED.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
ED.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm from this IG | |
ED.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
ED.mediaType | example | MediaTypehttp://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 |
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