GP Connect - Send Document

Part of the GP Connect product family

Profile: ITK-Attachment-Binary-1

Note: The international (base) resource is shown below.
idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
contentTypeΣ1..1codeBinding
securityContextΣ I0..1Reference(Resource)
content1..1base64Binary
Binary
DefinitionA binary resource can contain any content, whether text, image, pdf, zip archive, etc.
Cardinality0...*
Comments

Typically, Binary resources are used for handling content such as: * CDA Documents (i.e. with XDS) * PDF Documents * Images (the Media resource is preferred for handling images, but not possible when the content is already binary - e.g. XDS).

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
  • w5: infrastructure.structure
Binary.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typeid
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim: n/a
Binary.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Binary.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim: n/a
Binary.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding
A human language.
Common Languages (extensible)
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim: n/a
Binary.contentType
DefinitionMimeType of the binary content represented as a standard MimeType (BCP 13).
Cardinality1...1
Typecode
Binding
The mime type of an attachment. Any valid mime type is allowed.
?? (required)
SummaryTrue
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim: n/a
Binary.securityContext
DefinitionTreat this binary as if it was this other resource for access control purposes.
Cardinality0...1
TypeReference(Resource)
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
Binary.content
DefinitionThe actual content, base64 encoded.
Cardinality1...1
Typebase64Binary
Comments

If the content type is itself base64 encoding, then this will be base64 encoded twice - what is created by un-base64ing the content must be the specified content type.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim: n/a

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.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>

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]" />
back to top