Binary

Overview

The Binary resource represents any type of binary content that can be stored or referenced within a FHIR system. This includes documents, images, and other media files that support clinical care.

Resource Schema

Key fields in the Binary resource:

{
  "resourceType": "Binary",
  "id": "example-binary-123",
  "contentType": "application/pdf",
  "securityContext": {
    "reference": "Patient/123456"
  },
  "data": "base64-encoded-content"
}

Operations

The Binary resource supports Read operations only.

CareRecord / Solution	Read	Search
GEHRIMED	✅	❌
myAvatar	✅	❌
myEvolv	✅	❌
myUnity	✅	❌
TheraOffice	✅	❌

Read

Retrieves a specific Binary resource by ID.

HTTP Method: GET
URL: /Binary/{id}

Examples

Production

curl -X GET https://fhir.netsmartcloud.com/uscore/v1/Binary/123456 \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Preview

curl -X GET https://fhirtest.netsmartcloud.com/uscore/v1/Binary/123456 \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Integration Patterns

Common Workflows

1. Document Retrieval - Access binary documents referenced by other resources
2. Media Access - Retrieve images or other media files
3. Attachment Processing - Handle binary attachments in clinical documents

Relationships to Other Resources

The Binary resource is typically referenced by:

• DocumentReference - Documents that contain binary content
• DiagnosticReport - Reports with attached binary files
• Patient - Patient photos or documents

Error Handling

For common errors and troubleshooting guidance, see Common Errors.

Supported Profiles

Profiles supported by this resource (as defined in the CapabilityStatement):

• HL7 FHIR R4 Binary