Jump to

• Request
• Response

Get a binary document by ID

get

/fhir/r4/{query_endpoint_alias}/Binary/{id}

This path retrieves an individual document by the associated document ID.

This document is usually linked from the DocumentReference and should be accessed using the exact link provided by the referring resource. The Binary.read scope is required in addition to the DocumentReference.read.

The binary document is cached for 24 hours, after which time you would be unable to retrieve the document. You would need to generate the document again from the DocumentReference Search resource.

Request

Path Parameters

• id(required): string

  The logical resource ID.

Header Parameters

• authorization(required): string
  This string contains the credentials to authenticate a consumer to the service. This value should be the OAuth 2.0 bearer token.

Back to Top

Response

Supported Media Types

• application/fhir+json

200 Response

Success

Headers

• X-Request-Id: string
  Oracle troubleshooting identifier
• opc-request-id: string
  Oracle troubleshooting identifier

Body ()

Root Schema : Binary

Type: object

The Binary FHIR resource.

Show Source

• contentType: string
  The MimeType of the binary content.
• data: string
  The actual content in the base64encoded string.
• id: string
  The logical ID of this artifact.
• resourceType: string
  The resource type is Binary.

{
    "description":"The Binary FHIR resource.",
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"The resource type is Binary."
        },
        "id":{
            "type":"string",
            "description":"The logical ID of this artifact."
        },
        "contentType":{
            "type":"string",
            "description":"The MimeType of the binary content."
        },
        "data":{
            "type":"string",
            "description":"The actual content in the base64encoded string."
        }
    },
    "example":"{\n    \"resourceType\": \"Binary\",\n    \"id\": \"urn:uuid:49b9eaa9-a53e-4229-80e7-0a9f976eef9d\",\n    \"contentType\": \"text/xml\",\n    \"data\": \"<base64Binary>\"\n}\n"
}

Example:

{
    "resourceType": "Binary",
    "id": "urn:uuid:49b9eaa9-a53e-4229-80e7-0a9f976eef9d",
    "contentType": "text/xml",
    "data": "<base64Binary>"
}

401 Response

Authorization information is missing or invalid.

403 Response

The user does not have sufficient access to perform this action.

404 Response

The requested resource was not found. This occurs when the resource is tried to retrieve after cached time (24 hours).

500 Response

Internal Server error

Back to Top