Shared Health Specification and Guide Version 5.0

 

The official URL for this profile is:

http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-attachment

Download Excel representation

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

>

This structure is derived from Attachment

NameCard.TypeConstraints and Usage
.  Attachment 0..*Attachmentatt-1: It the Attachment has data, it SHALL have a contentType
Definition:
For referring to data content defined in other formats.


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

..  contentType 1..1codeBinding: MimeTypes (required): The mime type of an attachment. Any valid mime type is allowed.


Example' General': text/plain; charset=UTF-8, image/png
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.


Comments:
Identifies the mime type the binary content is expressed in.



Conformance Rule: The charset will be UTF-8 only.

..  url 1..1uriExample' General': http://www.acme.com/logo-small.png
Example' PrescribeIT': https://api.sharedhealth.exchange/rest/v1/preconf/THP/mailbox_vs1/Binary/$cab990c8-c266-4fee-bd1a-4b440dd919c2
Definition:
Location where the attachment is uploaded too or downloaded from, using the unique identifier of the attachment.


Comments:
Conformance Rule: This will be expressed as a URL on the server - https://EnvironmentSpecificHost/EnvironmentSpecificPathInbox/Binary/[guid or uuid or unique identifier]. The attachment content SHALL be PUT to the same URL immediately after posting the 305 message containing this attachment. It cannot be PUT prior to the 305 message otherwise an error will be returned.

..  size 1..1unsignedIntDefinition:
The number of bytes of data that make up this attachment.


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

..  title 0..1stringExample' General': Official Corporate Logo
Definition:
A label or set of text to display in place of the data.

This structure is derived from Attachment

Summary

Mandatory: 3 elements
Must-Support: 4 elements

This structure is derived from Attachment

NameFlagsCard.TypeDescription & Constraintsdoco
.. Attachment 0..*AttachmentContent in a format defined elsewhere
... contentType S1..1codeMime type of the content, with charset etc.
... url S1..1uriUri where the data can be found
Example PrescribeIT: https://api.sharedhealth.exchange/rest/v1/preconf/THP/mailbox_vs1/Binary/$cab990c8-c266-4fee-bd1a-4b440dd919c2
... size S1..1unsignedIntNumber of bytes of content (if url provided)
... title S0..1stringLabel to display in place of the data

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Attachment I0..*AttachmentContent in a format defined elsewhere
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: MimeTypes (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
... language Σ0..1codeHuman language of the content (BCP-47)
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


Example General: en-AU
... data 0..1base64BinaryData inline, base64ed
... url SΣ1..1uriUri where the data can be found
Example General: http://www.acme.com/logo-small.png
Example PrescribeIT: https://api.sharedhealth.exchange/rest/v1/preconf/THP/mailbox_vs1/Binary/$cab990c8-c266-4fee-bd1a-4b440dd919c2
... size SΣ1..1unsignedIntNumber of bytes of content (if url provided)
... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
... title SΣ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
... creation Σ0..1dateTimeDate attachment was first created

doco Documentation for this format

Grid View

This structure is derived from Attachment

NameCard.TypeConstraints and Usage
.  Attachment 0..*Attachmentatt-1: It the Attachment has data, it SHALL have a contentType
Definition:
For referring to data content defined in other formats.


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

..  contentType 1..1codeBinding: MimeTypes (required): The mime type of an attachment. Any valid mime type is allowed.


Example' General': text/plain; charset=UTF-8, image/png
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.


Comments:
Identifies the mime type the binary content is expressed in.



Conformance Rule: The charset will be UTF-8 only.

..  url 1..1uriExample' General': http://www.acme.com/logo-small.png
Example' PrescribeIT': https://api.sharedhealth.exchange/rest/v1/preconf/THP/mailbox_vs1/Binary/$cab990c8-c266-4fee-bd1a-4b440dd919c2
Definition:
Location where the attachment is uploaded too or downloaded from, using the unique identifier of the attachment.


Comments:
Conformance Rule: This will be expressed as a URL on the server - https://EnvironmentSpecificHost/EnvironmentSpecificPathInbox/Binary/[guid or uuid or unique identifier]. The attachment content SHALL be PUT to the same URL immediately after posting the 305 message containing this attachment. It cannot be PUT prior to the 305 message otherwise an error will be returned.

..  size 1..1unsignedIntDefinition:
The number of bytes of data that make up this attachment.


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

..  title 0..1stringExample' General': Official Corporate Logo
Definition:
A label or set of text to display in place of the data.

This structure is derived from Attachment

Summary

Mandatory: 3 elements
Must-Support: 4 elements

Differential View

This structure is derived from Attachment

NameFlagsCard.TypeDescription & Constraintsdoco
.. Attachment 0..*AttachmentContent in a format defined elsewhere
... contentType S1..1codeMime type of the content, with charset etc.
... url S1..1uriUri where the data can be found
Example PrescribeIT: https://api.sharedhealth.exchange/rest/v1/preconf/THP/mailbox_vs1/Binary/$cab990c8-c266-4fee-bd1a-4b440dd919c2
... size S1..1unsignedIntNumber of bytes of content (if url provided)
... title S0..1stringLabel to display in place of the data

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Attachment I0..*AttachmentContent in a format defined elsewhere
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: MimeTypes (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
... language Σ0..1codeHuman language of the content (BCP-47)
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


Example General: en-AU
... data 0..1base64BinaryData inline, base64ed
... url SΣ1..1uriUri where the data can be found
Example General: http://www.acme.com/logo-small.png
Example PrescribeIT: https://api.sharedhealth.exchange/rest/v1/preconf/THP/mailbox_vs1/Binary/$cab990c8-c266-4fee-bd1a-4b440dd919c2
... size SΣ1..1unsignedIntNumber of bytes of content (if url provided)
... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
... title SΣ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
... creation Σ0..1dateTimeDate attachment was first created

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Attachment.contentTyperequiredMimeTypes
Attachment.languagerequiredhttp://tools.ietf.org/html/bcp47

Constraints

IdPathDetailsRequirements
att-1AttachmentIt the Attachment has data, it SHALL have a contentType
: data.empty() or contentType.exists()