Binary REST Endpoints
Description
This topic describes information for the Binary resource.
Overview
Note:
The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.The Binary resource returns clinical content such as text, images, PDF files, Continuity of Care Documents (CCDs), clinical documents, diagnostic reports, and communication message content. In the Oracle Health EHR platform, Binary resources are retrieved after a reference is obtained from DocumentReference or DiagnosticReport; starting a workflow directly with Binary resources is not recommended.
When the request Accept header is application/fhir+json, the API returns a FHIR Binary resource with the raw content in Binary.data. For other accepted content types, the API returns the raw content instead of the FHIR Binary resource.
Profile Support
US Core 6.1.0 does not define a standalone Binary profile. Binary content is retrieved from references in the following HL7 FHIR US Core Implementation Guide STU 6.1.0 profiles:
Note:
The examples provided here are nonnormative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.Returned Fields
| Element | Type |
|---|---|
Binary |
Resource |
Binary.contentType |
code |
Binary.data |
base64Binary |
Terminology Bindings
| Element | Description | Details |
|---|---|---|
Binary.contentType |
Identifies the MIME type of the binary content. | Mime Types |
Binary.meta.security |
Connects confidential resources to security policy and infrastructure. |
- Generate a continuity-of-care document
- Method: getPath:
/Binary/$autogen-ccd-if - Generate a continuity-of-care document
- Method: postPath:
/Binary/$autogen-ccd-if - Get a binary by ID
- Method: getPath:
/Binary/{id}