Attachment - IEHR - Definitions - Cross Border Data Exchange IG v1.0.0

Cross Border Data Exchange IG
1.0.0 - CI Build International flag

Cross Border Data Exchange IG, published by IEHR-Workgroup. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/InteropEHRate-project/cross-border-data-exchange/ and changes regularly. See the Directory of published versions

Data Type Profile: AttachmentIEHR - Detailed Descriptions

Draft as of 2024-04-08

Definitions for the Attachment-IEHR data type profile.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. Attachment
Invariants	attIEHR-1: At least one of data and url SHALL be present (`data.exists() or url.exists()`)
2. Attachment.extension
Slicing	This element introduces a set of slices on `Attachment.extension`. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
4. Attachment.contentType
Definition	This attribute contains the MIME type of the attachment. All valid mime types are allowed
Control	1..?
Must Support	true
6. Attachment.language
Definition	This attribute contains the language of the attached document, if applicable
Comments	The exact constrains to this attribute are still under consideration
8. Attachment.data
Definition	This attribute contains the attached document as a base64 stream of bytes,if the attachment is provided in the document
Must Support	true
10. Attachment.url
Definition	This attribute points to the address where the attachment ist stored, if the attachment is not provided in the document
Must Support	true

Guidance on how to interpret the contents of this table can be found here

0. Attachment

Definition

For referring to data content defined in other formats.

Short Content in a format defined elsewhere

Comments

When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".

Control 0..*
This element is affected by the following invariants: ele-1

Is Modifier false

Invariants att-1: If the Attachment has data, it SHALL have a contentType (data.empty() or contentType.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
attIEHR-1: At least one of data and url SHALL be present (data.exists() or url.exists())
att-1: If the Attachment has data, it SHALL have a contentType (data.empty() or contentType.exists())

2. Attachment.extension

Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short ExtensionAdditional content defined by implementations

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control 0..*

Type

Extension

Is Modifier false

Summary false

Alternate Names extensions, user content

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

Slicing

This element introduces a set of slices on Attachment.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:

value @ url

4. Attachment.contentType

Definition

This attribute contains the MIME type of the attachment. All valid mime types are allowed

Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

Short Mime type of the content, with charset etc.

Control 10..1

Binding

The codes SHALL be taken from Mime Typeshttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1
(required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

The mime type of an attachment. Any valid mime type is allowed.

Type

code

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Processors of the data need to be able to know how to interpret the data.

Example General:text/plain; charset=UTF-8, image/png

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

6. Attachment.language

Definition

This attribute contains the language of the attached document, if applicable

The human language of the content. The value can be any valid value according to BCP 47.

Short Human language of the content (BCP-47)

Comments

The exact constrains to this attribute are still under consideration

Control 0..1

Binding

The codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages
(preferred to http://hl7.org/fhir/ValueSet/languages)

A human language.

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Users need to be able to choose between the languages in a set of attachments.

Example General:en-AU

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

8. Attachment.data

Definition

This attribute contains the attached document as a base64 stream of bytes,if the attachment is provided in the document

The actual data of the attachment - a sequence of bytes, base64 encoded.

Short Data inline, base64ed

Comments

The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

Control 0..1

Type

base64Binary

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary false

Requirements

The data needs to able to be transmitted inline.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

10. Attachment.url

Definition

This attribute points to the address where the attachment ist stored, if the attachment is not provided in the document

A location where the data can be accessed.

Short Uri where the data can be found

Comments

If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

Control 0..1

Type

url

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

The data needs to be transmitted by reference.

Example General:http://www.acme.com/logo-small.png

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Attachment

Definition

For referring to data content defined in other formats.

Short Content in a format defined elsewhere

Comments

When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".

Control 0..*
This element is affected by the following invariants: ele-1

Is Modifier false

Invariants att-1: If the Attachment has data, it SHALL have a contentType (data.empty() or contentType.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
attIEHR-1: At least one of data and url SHALL be present (data.exists() or url.exists())

2. Attachment.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Type

string

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

4. Attachment.extension

Definition

An Extension

Short Extension

Control 0..*

Type

Extension

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

Slicing

This element introduces a set of slices on Attachment.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:

value @ url

6. Attachment.contentType

Definition

This attribute contains the MIME type of the attachment. All valid mime types are allowed

Short Mime type of the content, with charset etc.

Control 1..1

Binding

The codes SHALL be taken from Mime Types
(required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

The mime type of an attachment. Any valid mime type is allowed.

Type

code

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Processors of the data need to be able to know how to interpret the data.

Example General:text/plain; charset=UTF-8, image/png

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

8. Attachment.language

Definition

This attribute contains the language of the attached document, if applicable

Short Human language of the content (BCP-47)

Comments

The exact constrains to this attribute are still under consideration

Control 0..1

Binding

The codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages)

A human language.

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Users need to be able to choose between the languages in a set of attachments.

Example General:en-AU

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

10. Attachment.data

Definition

This attribute contains the attached document as a base64 stream of bytes,if the attachment is provided in the document

Short Data inline, base64ed

Comments

The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

Control 0..1

Type

base64Binary

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary false

Requirements

The data needs to able to be transmitted inline.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

12. Attachment.url

Definition

This attribute points to the address where the attachment ist stored, if the attachment is not provided in the document

Short Uri where the data can be found

Comments

If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

Control 0..1

Type

url

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

The data needs to be transmitted by reference.

Example General:http://www.acme.com/logo-small.png

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

14. Attachment.size

Definition

The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

Short Number of bytes of content (if url provided)

Comments

The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

Control 0..1

Type

unsignedInt

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

16. Attachment.hash

Definition

The calculated hash of the data using SHA-1. Represented using base64.

Short Hash of the data (sha-1, base64ed)

Comments

The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

Control 0..1

Type

base64Binary

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

18. Attachment.title

Definition

A label or set of text to display in place of the data.

Short Label to display in place of the data

Control 0..1

Type

string

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

Example General:Official Corporate Logo

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

20. Attachment.creation

Definition

The date that the attachment was first created.

Short Date attachment was first created

Control 0..1

Type

dateTime

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

This is often tracked as an integrity issue for use of the attachment.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

IG © 2019+ IEHR-Workgroup. Package fhir.uv.crossborderdataexchange#1.0.0 based on FHIR 4.0.1. Generated 2024-04-08
Links: Table of Contents | QA Report