Binary

Overview

The Binary resource provides information "that represents the data of a single raw artifact as digital content accessible in its native format." This resource is used to store and retrieve binary data such as documents, images, or other files in their native format within the FHIR ecosystem.

Resource Schema

Key fields in the Binary resource:

{
  "resourceType": "Binary",
  "id": "example-binary",
  "contentType": "application/pdf",
  "data": "JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwo+PgplbmRvYmoKMiAwIG9iago8PAovVHlwZSAvUGFnZXMKL0tpZHMgWzMgMCBSXQovQ291bnQgMQo+PgplbmRvYmoK"
}

Operations

The Binary resource supports the following operations:

CareRecord / Solution	Create	Read	Update	Search
GEHRIMED	-	Yes	-	-
myAvatar	-	Yes	-	-
myEvolv	-	Yes	-	-
myUnity	-	Yes	-	-
TheraOffice	-	Yes	-	-

Read

Retrieve a specific binary resource by ID.

Production

GET /Binary/{id}

Example Request

curl -X GET https://fhir.netsmartcloud.com/provider/patient-access/v2/{tenant-id}/Binary/binary-123 \
    -H "Accept: application/fhir+json"

Preview

GET /Binary/{id}

Example Request

curl -X GET https://fhirtest.netsmartcloud.com/provider/patient-access/v2/{tenant-id}/Binary/binary-123 \
    -H "Accept: application/fhir+json"

Examples

Read Binary Resource

Production

curl -X GET https://fhir.netsmartcloud.com/provider/patient-access/v2/{tenant-id}/Binary/12345 \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json"

Preview

curl -X GET https://fhirtest.netsmartcloud.com/provider/patient-access/v2/Binary/12345 \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json"

Integration Patterns

Common workflows involving Binary:

• Document Storage: Store clinical documents, images, and reports in binary format
• File Retrieval: Access binary content referenced by other FHIR resources
• Content Management: Handle various file types and formats within the FHIR ecosystem

Related resources: DocumentReference, Media, DiagnosticReport

Error Handling

For error responses and troubleshooting, see the Error Handling Guide.

Supported Profiles

This API supports the following FHIR profiles:

• HL7 FHIR R4 Binary