Binary

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. If the element is present, it must have either a @value, an @id, or extensions

type Binary implements Resource {
  contentType: String
  securityContext: Reference
  data: String
  id: String
  meta: Meta
  implicitRules: Uri
  language: String
  extension: [Extension]
}

Fields

Binary.contentType ● String scalar

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

Binary.securityContext ● Reference object

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.

Binary.data ● String scalar

The actual content, base64 encoded.

Binary.id ● String scalar

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Binary.meta ● Meta object

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Binary.implicitRules ● Uri scalar

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Binary.language ● String scalar

The base language in which the resource is written.

Binary.extension ● [Extension] list object

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Interfaces

Resource interface

This is the base resource type for everything.

Returned By

Binary query ● BinaryCreate mutation ● BinaryList query ● BinaryUpdate mutation