Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

2.3 Resource Binary - Content

FHIR Infrastructure icon

Work Group

Maturity Level: N

Normative (from v4.0.0)

Security Category: Not Classified

Compartments: No defined compartments

A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.

2.3.1 Scope and Usage

There are situations where it is useful or required to handle pure binary content using the same framework as other resources. Typically, this is when the binary content is referred to from other FHIR Resources. Using the same framework means that the existing servers, security arrangements, code libraries, etc. can handle additional related content. Typically, Binary resources are used for handling content such as:

CDA Documents (i.e. with XDS)
PDF Documents
Images

A binary resource can contain any content, whether text, image, pdf, zip archive, etc. These resources are served in their native form on the rest interface, but can also be represented in XML, JSON, or other formats, such as when including these resources in a Bundle (used when it is convenient to include these in the response directly rather than leaving them by reference).

2.3.2 Boundaries and Relationships

When a FHIR server finds it convenient to manage the content within the same overall REST framework as the other resources, the Binary resource is generally used as the target in the Attachment data type to reference content via the .url element, such as in the DocumentReference resources. Consequently, the Binary resource can be a target wherever the Attachment data type is used such as in the DocumentReference resource.

The DocumentReference resource allows conveying binary content (via attachment) or pointing to one (as a Binary or non-FHIR URI) along with the metadata around that resource, and as such are searchable. Binary resources do not support 'search'.

While CDA and PDF documents are conveyed as Binary (because they cannot be expressed natively in FHIR), FHIR Documents do not need to be similarly encoded and can be sent natively in FHIR using Bundle. However, in some situations FHIR Documents may be sent as a Binary if there is a need to treat them the same as other types of documents or binary files.

The Binary resource does not convey context of the file. If the context (information such as author, procedure, technique, etc.) is needed it should be conveyed in a DocumentReference resource. The Binary resource may be used to convey actual binary file content conveyed by the DocumentReference resource.

See some uses of Binary and DocumentReferece in the IHE XDS icon Implementation Guide.

2.3.3 References to this Resource

Resource References: AdministrableProductDefinition, Appointment and ManufacturedItemDefinition

Structure

Name	Flags	Card.	Type	Description & Constraints
Binary	N		Resource	Pure binary content defined by a format other than FHIR Elements defined in Ancestors: id, meta, implicitRules, language
contentType	Σ	1..1	code	MimeType of the binary content Binding: Mime Types (Required)
securityContext	Σ	0..1	Reference(Any)	Identifies another resource to use as proxy when enforcing access control
data		0..1	base64Binary	The actual content
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<Binary xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <contentType value="[code]"/><!-- 1..1 MimeType of the binary content -->
 <securityContext><!-- 0..1 Reference(Any) Identifies another resource to use as proxy when enforcing access control --></securityContext>
 <data value="[base64Binary]"/><!-- 0..1 The actual content -->
</Binary>

JSON Template

{
  "resourceType" : "Binary",
  // from Resource: id, meta, implicitRules, and language
  "contentType" : "<code>", // R!  MimeType of the binary content
  "securityContext" : { Reference(Any) }, // Identifies another resource to use as proxy when enforcing access control
  "data" : "<base64Binary>" // The actual content
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:Binary;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  fhir:contentType [ code ] ; # 1..1 MimeType of the binary content
  fhir:securityContext [ Reference(Any) ] ; # 0..1 Identifies another resource to use as proxy when enforcing access control
  fhir:data [ base64Binary ] ; # 0..1 The actual content
]

Changes from both R4 and R4B

Binary

No Changes

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)

Structure

Name	Flags	Card.	Type	Description & Constraints
Binary	N		Resource	Pure binary content defined by a format other than FHIR Elements defined in Ancestors: id, meta, implicitRules, language
contentType	Σ	1..1	code	MimeType of the binary content Binding: Mime Types (Required)
securityContext	Σ	0..1	Reference(Any)	Identifies another resource to use as proxy when enforcing access control
data		0..1	base64Binary	The actual content
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<Binary xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <contentType value="[code]"/><!-- 1..1 MimeType of the binary content -->
 <securityContext><!-- 0..1 Reference(Any) Identifies another resource to use as proxy when enforcing access control --></securityContext>
 <data value="[base64Binary]"/><!-- 0..1 The actual content -->
</Binary>

JSON Template

{
  "resourceType" : "Binary",
  // from Resource: id, meta, implicitRules, and language
  "contentType" : "<code>", // R!  MimeType of the binary content
  "securityContext" : { Reference(Any) }, // Identifies another resource to use as proxy when enforcing access control
  "data" : "<base64Binary>" // The actual content
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:Binary;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  fhir:contentType [ code ] ; # 1..1 MimeType of the binary content
  fhir:securityContext [ Reference(Any) ] ; # 0..1 Identifies another resource to use as proxy when enforcing access control
  fhir:data [ base64Binary ] ; # 0..1 The actual content
]

Changes from both R4 and R4B

Binary

No Changes

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis

2.3.4.1 Terminology Bindings

Path ValueSet Type Documentation

Binary.contentType

Path	ValueSet	Type	Documentation
Binary.contentType	MimeTypes (a valid code from `urn:ietf:bcp:13`)	Required	This value set includes all possible codes from BCP-13 (see http://tools.ietf.org/html/bcp13)

MimeTypes (a valid code from urn:ietf:bcp:13)

Required

This value set includes all possible codes from BCP-13 (see http://tools.ietf.org/html/bcp13)

2.3.4.2 Content Optionality

Binary.data is optional because it is excluded when a summary view of the Binary resource is requested (this can be useful when the binary resource is part of a wider request e.g. a search _include).

Otherwise, the data is not optional; a binary resource without any specified content is not useful.

2.3.4.3 Serving Binary Resources using the RESTful API

Binary resources behave slightly differently from all other resources on the RESTful API:

When a read request is made with a FHIR type in the Accept header (e.g. "application/fhir+xml" or "application/fhir+json") the Binary resource is returned in the requested FHIR format. This applies even when the binary data itself has a FHIR mime type
The Binary resource is always represented in the native FHIR format when wrapped in a Bundle
The _format overrides the accept header and SHALL be interpreted as using the standard FHIR mime types, even if the more generic mime types are given as a value.
When the read request has some other type in the Accept header, then the content should be returned with the content type stated in the resource in the Content-Type header. E.g. if the content type in the resource is "application/pdf", then the content should be returned as a PDF directly. The _summary parameter does not apply in this case.
due to the way the web infrastructure works, it is not possible to make blanket rules about the relationship between the "Accept" field in the HTTP request, and the return type, which is why there is no hard rule about this. However, the intent is that unless specifically requested, the FHIR XML/JSON representation is not returned
When binary data is written to the server (create/update - POST or PUT), the data is accepted as is and treated as the content of a Binary, including when the content type is "application/fhir+xml" or "application/fhir+json", except for the special case where the content is actually a Binary resource.
Note that when client requests a Binary resource using a generic mime type (application/xml, text/xml, or application/json), the server SHOULD return the content directly if the content-type format matches the requested mime type (e.g. if the Accept header is application/json, and the contentType is vnd.xacml+json). However, servers might not always be able to interpret mime types correctly, and clients SHOULD be prepared to receive either format.

Note that in the native binary representation, the normal resource metadata is not available directly, though some of it is replicated in the HTTP response headers. Specifically, the following elements of the resource have matching HTTP Headers:

Binary.meta.lastUpdated: Last-Modified
Binary.meta.versionId: ETag header
Binary.contentType: Content-Type
Binary.securityContext: X-Security-Context - this is a FHIR specific extension, primarily intended to allow the security context for a Binary resource to be specified when it is posted in native form. The content of the header is Binary.securityContext.reference

2.3.4.4 Image source for Narrative

Binary resources may be the target of img.src references in XHTML narrative, and also in markdown. See Image References for further details.

2.3.4.5 Security Considerations

Binary resources are not constrained to any list of safe content types (content types without active elements such as scripting or executable code), and therefore can be of any content type and encoding. Therefore, extra care needs to be taken to validate the content of the Binary resource against malicious or malformed content. For more details see Security of Narrative, since the security issues are similar.

Very often, the content of a Binary resource is sensitive, and the server should apply appropriate access control to the content. When the server itself generates the content, it implicitly knows what access control to apply. When the client provides the binary to the server itself, it uses the securityContext element (or the matching X-Security-Context HTTP header) to inform the server that the Binary resource should be treated as if it was the other resource. Typically, the other resource is a DocumentReference or similar resource that refers directly to the Binary resource, but that is not mandatory.

2.3.4.6 Read

This specification makes no rules concerning advanced read functionality for the Binary resource, such as:

retrieving byte ranges
Finding the size of the content before retrieving it (though this can be achieved using a HEAD request)
Stream content from Binary?
generating content dynamically on the fly

Servers are free to support these features, but they are not required.

2.3.4.7 Search

This specification does not support searching on Binary resources.

2.3.4.8 Patch

The semantics of a PATCH operation on a Binary resource are not currently specified.

2.3.5 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

(No search parameters for this resource)