Binary REST Endpoints

Sort by

Task Path Method

Description

Binary

This topic describes information for the Binary resource.

Overview

Terminology Bindings

The Binary resource can contain any clinical content such as text, images, and PDFs. This resource is currently limited to Continuity of Care Documents (CCDs), clinical documents, diagnostic reports, and communication message content.

Examples of supported diagnostic report types include anatomic pathology, cardiology, microbiology, and radiology.

This list is not exhaustive and subject to change as the list of clinical events that may qualify can be customized by customers.

Oracle recommends requesting Binary resources only after obtaining links to the resources through references from DiagnosticReport or DocumentReference. Starting a workflow with Binary resources is not recommended.

The consumer must populate the Accept header with application/fhir+json or the format returned in the attachment.contentType of the referring resource. If the Accept header is application/fhir+json, a FHIR Binary resource is returned with the raw data populated in Binary.data. If the Accept header is anything else, the raw data is returned instead of a FHIR Binary resource. For more information, see the HL7 FHIR Binary documentation.

Note:

To retrieve documents with the application/pdf content type, Clinical Reporting XR must be installed for the customer site that you are loading data from. For additional information about Clinical Reporting XR, see the Clinical Reporting XR Reference Pages.

Note:

The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site. The meta.security field is present only for confidential resources.

The following fields are returned if valued:

• Binary id
• Content type
• Content

Binary.meta.security

• Description: These tags connect specific resources to the overall security policy and infrastructure.
• Details: ValueSet
• System: http://terminology.hl7.org/CodeSystem/v3-ActCode

Binary

The operations from the Binary category.

Get a binary CCD

Method: get

Path: /Binary/$autogen-ccd-if

Get a binary document by ID

Method: get

Path: /Binary/{ID}