Jump to

• Request
• Response

Get a binary by ID

get

/Binary/{id}

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Retrieves an individual binary by the associated ID.

Headers

Use an Accept header of application/fhir+json to retrieve the JSON Binary resource.

Request

Path Parameters

• id(required): string
  The logical resource ID.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful retrieve response.

Body ()

Root Schema : Binary

Type: object

Show Source

• contentType(required): string
  The type of data in the Binary resource.
• data: string
  The base64-encoded content of the Binary resource.
• id(required): string
• meta: object meta
• resourceType(required): string
  Allowed Values: [ "Binary" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "contentType"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Binary"
            ]
        },
        "id":{
            "type":"string"
        },
        "meta":{
            "type":"object",
            "properties":{
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                }
            }
        },
        "contentType":{
            "type":"string",
            "description":"The type of data in the Binary resource."
        },
        "data":{
            "type":"string",
            "description":"The base64-encoded content of the Binary resource."
        }
    }
}

Nested Schema : meta

Type: object

Show Source

• lastUpdated: string (date-time)

{
    "type":"object",
    "properties":{
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

Show Source

• issue(required): array issue
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top