DocumentReference

ITK-Binary-1

ITK-Binary-1

Binary
Definition
Control 0..*
Type Binary
Comments

Typically, Binary resources are used for handling content such as: * ITK 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.id
Definition

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

Control 0..1 ?
Type Id
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. Bundles always have an id, though it is usually a generated UUID.

Binary.meta
Definition

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

Control 0..1 ?
Type Meta
Comments
Binary.implicitRules
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.

Control 0..1 ?
Type Uri
Is Modifier True
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 as much as possible.

Binary.language
Definition

The base language in which the resource is written.

Control 0..1 ?
Binding

A human language.

The codes SHALL be taken from http://tools.ietf.org/html/bcp47

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

Binary.contentType
Definition

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

Control 1..1 ?
Binding

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

The codes SHALL be taken from http://www.rfc-editor.org/bcp/bcp13.txt

Type Code
Comments

Note that FHIR strings may not exceed 1MB in size

Binary.content
Definition

The actual content, base64 encoded.

Control 1..1 ?
Type Base64Binary
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.