Cross Border Data Exchange IG
1.0.0 - CI Build
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
Official URL: http://interopehrate.eu/fhir/StructureDefinition/Attachment-IEHR | Version: 1.0.0 | |||
Draft as of 2024-04-08 | Computable Name: AttachmentIEHR |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Attachment
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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) | |
data | S | 0..1 | base64Binary | Data inline, base64ed |
url | S | 0..1 | url | Uri where the data can be found |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
attIEHR-1 | error | Attachment | At least one of data and url SHALL be present : data.exists() or url.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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.
Example General: en-AU | ||||
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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Attachment.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard | ||||
Attachment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
att-1 | error | Attachment | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
attIEHR-1 | error | Attachment | At least one of data and url SHALL be present : data.exists() or url.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | ||||
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Attachment.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard | ||||
Attachment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
att-1 | error | Attachment | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
attIEHR-1 | error | Attachment | At least one of data and url SHALL be present : data.exists() or url.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Attachment
Differential View
This structure is derived from Attachment
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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) | |
data | S | 0..1 | base64Binary | Data inline, base64ed |
url | S | 0..1 | url | Uri where the data can be found |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
attIEHR-1 | error | Attachment | At least one of data and url SHALL be present : data.exists() or url.exists() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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.
Example General: en-AU | ||||
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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Attachment.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard | ||||
Attachment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
att-1 | error | Attachment | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
attIEHR-1 | error | Attachment | At least one of data and url SHALL be present : data.exists() or url.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | ||||
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Attachment.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard | ||||
Attachment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
att-1 | error | Attachment | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
attIEHR-1 | error | Attachment | At least one of data and url SHALL be present : data.exists() or url.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Attachment
Other representations of profile: CSV, Excel, Schematron