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: Attachment - IEHR

Official URL: http://interopehrate.eu/fhir/StructureDefinition/Attachment-IEHR Version: 1.0.0
Draft as of 2024-04-08 Computable Name: AttachmentIEHR

Usage:

Formal Views of Profile Content

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

This structure is derived from Attachment

NameFlagsCard.TypeDescription & Constraintsdoco
.. Attachment C 0..* Attachment Content in a format defined elsewhere
attIEHR-1: At least one of data and url SHALL be present
... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... contentType S 1..1 code Mime type of the content, with charset etc.
... language 0..1 code Human language of the content (BCP-47)
... url S 0..1 url Uri where the data can be found

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
attIEHR-1errorAttachmentAt least one of data and url SHALL be present
: data.exists() or url.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Attachment C 0..* Attachment Content in a format defined elsewhere
att-1: If the Attachment has data, it SHALL have a contentType
attIEHR-1: At least one of data and url SHALL be present
... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
... url SΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
Attachment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
att-1errorAttachmentIf the Attachment has data, it SHALL have a contentType
: data.empty() or contentType.exists()
attIEHR-1errorAttachmentAt least one of data and url SHALL be present
: data.exists() or url.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Attachment C 0..* Attachment Content in a format defined elsewhere
att-1: If the Attachment has data, it SHALL have a contentType
attIEHR-1: At least one of data and url SHALL be present
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
... data S 0..1 base64Binary Data inline, base64ed
... url SΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
... creation Σ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
Attachment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
att-1errorAttachmentIf the Attachment has data, it SHALL have a contentType
: data.empty() or contentType.exists()
attIEHR-1errorAttachmentAt least one of data and url SHALL be present
: data.exists() or url.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Attachment

Summary

Mandatory: 1 element
Must-Support: 3 elements

Differential View

This structure is derived from Attachment

NameFlagsCard.TypeDescription & Constraintsdoco
.. Attachment C 0..* Attachment Content in a format defined elsewhere
attIEHR-1: At least one of data and url SHALL be present
... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... contentType S 1..1 code Mime type of the content, with charset etc.
... language 0..1 code Human language of the content (BCP-47)
... url S 0..1 url Uri where the data can be found

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
attIEHR-1errorAttachmentAt least one of data and url SHALL be present
: data.exists() or url.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Attachment C 0..* Attachment Content in a format defined elsewhere
att-1: If the Attachment has data, it SHALL have a contentType
attIEHR-1: At least one of data and url SHALL be present
... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
... url SΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
Attachment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
att-1errorAttachmentIf the Attachment has data, it SHALL have a contentType
: data.empty() or contentType.exists()
attIEHR-1errorAttachmentAt least one of data and url SHALL be present
: data.exists() or url.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Attachment C 0..* Attachment Content in a format defined elsewhere
att-1: If the Attachment has data, it SHALL have a contentType
attIEHR-1: At least one of data and url SHALL be present
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
... data S 0..1 base64Binary Data inline, base64ed
... url SΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
... creation Σ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
Attachment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
att-1errorAttachmentIf the Attachment has data, it SHALL have a contentType
: data.empty() or contentType.exists()
attIEHR-1errorAttachmentAt least one of data and url SHALL be present
: data.exists() or url.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Attachment

Summary

Mandatory: 1 element
Must-Support: 3 elements

 

Other representations of profile: CSV, Excel, Schematron