Belgian MyCareNet Profiles
2.0.0 - STU Belgium flag

This page is part of the HL7 Belgium FHIR Implementation Guide - MyCareNet profiles (v2.0.0: Trial Use) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: BeMyCareNetEagreementServiceRequestBinary - Detailed Descriptions

Active as of 2023-04-27

Definitions for the be-eagreementservicerequest-binary resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. Binary
2. Binary.id
Control10..1
Must Supporttrue
3. Binary.contentType
Must Supporttrue
Fixed Valueapplication/pdf
4. Binary.data
Control10..1
Must Supporttrue

Guidance on how to interpret the contents of this table can be found here.

1. Binary
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.

Control0..*
Summaryfalse
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).
2. Binary.id
Definition

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

Control10..1
Typeidstring
Must Supporttrue
Summarytrue
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.

3. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. Binary.contentType
Definition

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

Control1..1
BindingThe codes SHALL be taken from Mime Types

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

Typecode
Must Supporttrue
Summarytrue
Fixed Valueapplication/pdf
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Binary.data
Definition

The actual content, base64 encoded.

Control10..1
Typebase64Binary
Must Supporttrue
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.

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

Guidance on how to interpret the contents of this table can be found here.

1. Binary
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.

Control0..*
Summaryfalse
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).
2. Binary.id
Definition

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

Control1..1
Typeid
Must Supporttrue
Summarytrue
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.

3. Binary.meta
Definition

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.

Control0..1
TypeMeta
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Binary.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages A human language
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Summaryfalse
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Binary.contentType
Definition

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

Control1..1
BindingThe codes SHALL be taken from Mime Types The mime type of an attachment. Any valid mime type is allowed
Typecode
Must Supporttrue
Summarytrue
Fixed Valueapplication/pdf
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Binary.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.

Control0..1
TypeReference(Resource)
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. Binary.data
Definition

The actual content, base64 encoded.

Control1..1
Typebase64Binary
Must Supporttrue
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.

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