Shared Health Specification and Guide Version 5.0


v5.0 of this specification has been superseded by v5.3. v5.3 is compatible but adds additional features for Quebec.

The version (Bundle.meta.tag:version) that is sent in the message will remain PrescribeIT5.0

 

Definitions for the dtprofile-attachment Profile.

1. Attachment
Definition

For referring to data content defined in other formats.

Control0..*
Comments

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

Max Length0
InvariantsDefined on this element
att-1: It the Attachment has data, it SHALL have a contentType (: data.empty() or contentType.exists())
2. Attachment.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
3. Attachment.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

Max Length0
4. Attachment.contentType
Definition

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.

Control1..1
BindingThe codes SHALL be taken from MimeTypes The mime type of an attachment. Any valid mime type is allowed.
Typecode
Must Supporttrue
Requirements

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

Comments

Identifies the mime type the binary content is expressed in

Max Length0
Example
General:text/plain; charset=UTF-8, image/png
5. Attachment.language
Definition

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

Control0..1
BindingThe codes SHALL be taken from http://tools.ietf.org/html/bcp47 A human language.
Typecode
Requirements

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

Max Length0
Example
General:en-AU
6. Attachment.data
Definition

The actual data of the attachment - a sequence of bytes. In XML, represented using base64.

Control0..1
Typebase64Binary
Requirements

The data needs to able to be transmitted inline.

Comments

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

Max Length0
7. Attachment.url
Definition

An alternative location where the data can be accessed.

Control1..1
Typeuri
Must Supporttrue
Requirements

The data needs to be transmitted by reference.

Comments

Conformance Rule: This will be expressed as a URL on the server - https://EnvironmentSpecificHost/EnvironmentSpecificPathInbox/Binary/[guid]. The attachment content SHALL be PUT to the same URL either immediately before or after posting the message containing this attachment

Max Length0
Example
General:http://www.acme.com/logo-small.png
8. Attachment.size
Definition

The number of bytes of data that make up this attachment.

Control1..1
TypeunsignedInt
Must Supporttrue
Requirements

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

Comments

Conformance Rule: The combined size of all attachments cannot exceed 50 MB.

Max Length0
9. Attachment.hash
Definition

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

Control0..1
Typebase64Binary
Requirements

Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature.

Max Length0
10. Attachment.title
Definition

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

Control0..1
Typestring
Must Supporttrue
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.

Max Length0
Example
General:Official Corporate Logo
11. Attachment.creation
Definition

The date that the attachment was first created.

Control0..1
TypedateTime
Requirements

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

Max Length0