3.45 StructureDefinition: Shared Health Attachment
The official URL for this profile is:
http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-attachment
3.45.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
>
This structure is derived from Attachment
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Attachment | 0..* | Attachment | att-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..1 | code | Binding: 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..1 | uri | 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 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..1 | unsignedInt | Definition: 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..1 | string | Example' General': Official Corporate Logo Definition: A label or set of text to display in place of the data. |
This structure is derived from Attachment
This structure is derived from Attachment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Attachment | 0..* | Attachment | Content in a format defined elsewhere | |
| contentType | S | 1..1 | code | Mime type of the content, with charset etc. |
| url | S | 1..1 | uri | Uri 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 | S | 1..1 | unsignedInt | Number of bytes of content (if url provided) |
| title | S | 0..1 | string | Label to display in place of the data |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Attachment | I | 0..* | Attachment | Content in a format defined elsewhere |
 id | 0..1 | id | xml:id (or equivalent in JSON) | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
| contentType | SΣ | 1..1 | code | Mime 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..1 | code | Human language of the content (BCP-47) Binding: http://tools.ietf.org/html/bcp47 (required): A human language. Example General: en-AU |
| data | 0..1 | base64Binary | Data inline, base64ed | |
| url | SΣ | 1..1 | uri | Uri 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..1 | unsignedInt | Number of bytes of content (if url provided) |
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
| title | SΣ | 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 | ||||
Grid View
This structure is derived from Attachment
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Attachment | 0..* | Attachment | att-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..1 | code | Binding: 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..1 | uri | 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 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..1 | unsignedInt | Definition: 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..1 | string | Example' General': Official Corporate Logo Definition: A label or set of text to display in place of the data. |
This structure is derived from Attachment
Differential View
This structure is derived from Attachment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Attachment | 0..* | Attachment | Content in a format defined elsewhere | |
| contentType | S | 1..1 | code | Mime type of the content, with charset etc. |
| url | S | 1..1 | uri | Uri 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 | S | 1..1 | unsignedInt | Number of bytes of content (if url provided) |
| title | S | 0..1 | string | Label to display in place of the data |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Attachment | I | 0..* | Attachment | Content in a format defined elsewhere |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| contentType | SΣ | 1..1 | code | Mime 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..1 | code | Human language of the content (BCP-47) Binding: http://tools.ietf.org/html/bcp47 (required): A human language. Example General: en-AU |
| data | 0..1 | base64Binary | Data inline, base64ed | |
| url | SΣ | 1..1 | uri | Uri 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..1 | unsignedInt | Number of bytes of content (if url provided) |
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
| title | SΣ | 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 | ||||
Other representations of profile: Schematron
3.45.3 Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| Attachment.contentType | required | MimeTypes |
| Attachment.language | required | http://tools.ietf.org/html/bcp47 |
3.45.4 Constraints
Constraints
| Id | Path | Details | Requirements |
| att-1 | Attachment | It the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() |