SADIE Developer and Tester Guide

Binary

The Binary resource stores the following types of information:

Attached Document

Attached Document

Attached Document is used to store documents of various types and are linked to a variety of resources.

Requirements

store the mime type of the attachment
the document can be any size
For security it must have a reference to the Requestor Role of the related request. Here are the different profiles that store Attached Documents and which element contains the related Requestor Role
- Client Communication, Communication.partOf = Requestor Role
- Outgoing To Prescriber, Communication.partOf = Requestor Role
- Questionnaire Response, QuestionnaireResponse.author = Requestor Role
- Request PDF, DocumentReference.author = Requestor Role

Profile - Attached Document

AttachedDocument (Binary)

Binary

There are no (further) constraints on this element

Element id

Binary

Short description

Pure binary content defined by a format other than FHIR

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.

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

Data type

Binary

Mappings

rim: Entity. Role, or Act
rim: ED

0..1

There are no (further) constraints on this element

Element id

Binary.id

Short description

Logical id of this artifact

Definition

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

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

uri

There are no (further) constraints on this element

Element id

Binary.implicitRules

Short description

A set of rules under which this content was created

Definition

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.

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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Binary.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

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

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

contentType

1..1

codeBinding

Element id

Binary.contentType

Short description

MimeType of the binary content

Definition

`FOR SADIE USE: This is the document format.`

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The mime type of an attachment. Any valid mime type is allowed.

Mime Types (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ED.mediaType

securityContext

Σ C

0..1

Reference(FlexFormsRole)

Element id

Binary.securityContext

Short description

Identifies another resource to use as proxy when enforcing access control

Definition

`FOR SADIE USE: This is a reference to the Requestor Role for the related request. This is needed to enforce security so that users cannot view each other's attachments.`

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.

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.

Data type

Reference(FlexFormsRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

data

0..1

base64Binary

Element id

Binary.data

Short description

The actual content

Definition

`FOR SADIE USE: This is the document in base64 format.`

The actual content, base64 encoded.

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.

Data type

base64Binary

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ED.data

Example - Attached Document that passed validation

Command 'json' could not render: File not found for 'subject=Example-Binary'

Example - Attached Document that is stored externally

{

"resourceType": "Binary",

"id": "41d28865-8a6b-4a83-858a-75abe920120e",

"meta": {

"versionId": "1",
"lastUpdated": "2021-09-20T18:03:02.057+00:00",
"source": "#CSBsHw2CGuR8DDj7",
"profile": [
"https://health.gov.on.ca/sadie/fhir/StructureDefinition/AttachedDocument"
]

"contentType": "application/pdf",

"securityContext": {

"reference": "PractitionerRole/eeb8a591-c435-4060-9cc4-464da59c0286"

"_data": {

"extension": [

{

"url": "http://hapifhir.io/fhir/StructureDefinition/externalized-binary-id",

"valueString": "8KubzBKbx2CE7nYkBkPc50F7yqlL33DekvYQWZ14X2nPUYKCwGts4XEIwKvYRPRs2wP8m7sKVLAdPT2Hi4YnvWw5J0luU2O8MTy4"

}

]

}