Binary resources are used to store and retrieve unstructured documents or raw content such as PDFs, images, or CDA files. These are often referenced via the Attachment.url
field in other FHIR resources such as DocumentReference
.
Use Cases
- Retrieve original document content (e.g., scanned reports, CCDA PDFs)
- Access files attached to
DocumentReference
orDiagnosticReport
Access Pattern
To download a binary file: GET /fhir/R4/Binary/{id}
Example: GET /fhir/R4/Binary/4c4c925d60847d72f652c7f7
A valid Bearer token must be included in the request. Binary download URLs are protected and may expire.
Required Scope
The scope varies depending on the resource referencing the Binary. For more information, go to: OAuth 2.0 Authentication