Current Build
FHIR Infrastructure Work GroupMaturity Level: N Normative (from v4.0.0)Security Category: Not Classified Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the Binary resource.

Binary
Element IdBinary
Definition

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.

Cardinality0..*
TypeResource
Requirements

There are situations where it is useful or required to handle pure binary content using the same framework as other resources.

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).
Binary.contentType
Element IdBinary.contentType
Definition

MimeType of the binary content represented as a standard MimeType (BCP 13).

Cardinality1..1
Terminology BindingMimeType (Required)
Typecode
Summarytrue
Binary.securityContext
Element IdBinary.securityContext
Definition

This element identifies another resource that can be used as a proxy of the security sensitivity to use when deciding and enforcing access control rules for the Binary resource. Given that the Binary resource contains very few elements that can be used to determine the sensitivity of the data and relationships to individuals, the referenced resource stands in as a proxy equivalent for this purpose. This referenced resource may be related to the Binary (e.g. Media, DocumentReference), or may be some non-related Resource purely as a security proxy. E.g. to identify that the binary resource relates to a patient, and access should only be granted to applications that have access to the patient.

Cardinality0..1
TypeReference(Any)
Summarytrue
Comments

Very often, a server will also know of a resource that references the binary, and can automatically apply the appropriate access rules based on that reference. However, there are some circumstances where this is not appropriate, e.g. the binary is uploaded directly to the server without any linking resource, the binary is referred to from multiple different resources, and/or the binary is content such as an application logo that has less protection than any of the resources that reference it.

Binary.data
Element IdBinary.data
Definition

The actual content, base64 encoded.

Cardinality0..1
Typebase64Binary
Summaryfalse
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.