Note: A minor revision has been made to this version of the specification due to issues in some of the guidance.
Full details of changes can be found in the release notes in version 2.0.1-public-beta.
Full details of changes can be found in the release notes in version 2.0.1-public-beta.
Profile: ITK-Attachment-Binary-1
Command 'tree' could not render: File was not found for 'https://fhir.nhs.uk/STU3/StructureDefinition/ITK-Attachment-Binary-1'
Command 'dict' could not render: File was not found for 'https://fhir.nhs.uk/STU3/StructureDefinition/ITK-Attachment-Binary-1'
Elements required for capability
Element | Use | CareConnect | UK Core |
---|---|---|---|
id | |||
meta.profile | |||
meta.versionId | |||
meta.lastUpdated | |||
contentType | |||
content |
id
Usage
Mandatory
Guidance
The id
is the logical identifier for the ITK-Attachment-Binary-1
profile.
Example
<id value="7ea981aa-5ac1-11ed-9b6a-0242ac120002" />
meta.versionId
Usage
Optional
Guidance
The meta.versionId
element does not need to be populated.
Example
<meta> <versionId value="1" /> </meta>
meta.lastUpdated
Usage
Optional
Guidance
The meta.lastUpdated
element does not need to be populated.
Example
<meta> <lastUpdated value="2022-11-02T14:19:00+00:00" /> </meta>
meta.profile
Usage
Mandatory
Guidance
The meta.profile
contains a fixed value of the URL for the ITK-Attachment-Binary-1
profile.
Example
<meta> <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/ITK-Attachment-Binary-1" /> </meta>
meta.security
Usage
Optional
Guidance
The meta.security
element does not need to be populated.
Example
<meta> <security> <coding> <system value="http://hl7.org/fhir/v3/Confidentiality" /> <code value="L" /> <display value="low" /> </coding> </security> </meta>
meta.tag
Usage
Optional
Guidance
The meta.tag
element does not need to be populated for this capability.
Example
<meta> <tag> <coding> <system value="http://hl7.org/fhir/common-tags" /> <code value="actionable" /> <display value="Actionable" /> </coding> </tag> </meta>
contentType
Usage
Mandatory
Guidance
The MIME type of the content being sent. It is expected that application/pdf
will be the most common use case for this capability; however, a list of common health related MIME types has been provided below.
Extension | Kind of document | MIME type |
---|---|---|
.pdf |
Adobe Portable Document Format (PDF) | application/pdf |
.doc |
Microsoft Word | application/msword |
.docx |
Office Open XML Word extension | application/vnd.openxmlformats-officedocument.wordprocessingml.document |
.rtf |
Rich-text format | application/mswrtford |
.html |
Hypertext Markup Language | text/html |
.txt |
Plain text | text/plain |
.xml |
Extensible Markup Language | text/xml |
.jpg / .jpeg |
JPEG images | image/jpg |
.png |
Portable Network Graphics | image/png |
.tiff |
Tag Image File Format | image/png |
Example
<contentType value="application/pdf"/>
content
Usage
Mandatory
Guidance
Example
<content value="[base64 encoded content]" />