binarys

Create Binary

post
/organizations/{organizationId}/fhir/3/Binary

A binary resource can contain any content, whether text, image, pdf, zip archive, etc.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringBinaryThis is a Binary resource
contentTypestringMimeType of the binary content represented as a standard MimeType (BCP 13).
securityContextReferenceTreat this binary as if it was this other resource for access control purposes.
contentstringThe actual content, base64 encoded.

Response

Patch Binary

patch
/organizations/{organizationId}/fhir/3/Binary/{resourceId}

A binary resource can contain any content, whether text, image, pdf, zip archive, etc.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringBinaryThis is a Binary resource
contentTypestringMimeType of the binary content represented as a standard MimeType (BCP 13).
securityContextReferenceTreat this binary as if it was this other resource for access control purposes.
contentstringThe actual content, base64 encoded.

Response

Read Binary

get
/organizations/{organizationId}/fhir/3/Binary/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Binary

get
/organizations/{organizationId}/fhir/3/Binary/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Binary

get
/organizations/{organizationId}/fhir/3/Binary/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Binary

delete
/organizations/{organizationId}/fhir/3/Binary/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Binary

get
/organizations/{organizationId}/fhir/3/Binary

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
contenttypestring

Params

organizationId*string|stringid|slug

Response

Search History Binary

get
/organizations/{organizationId}/fhir/3/Binary/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Binary

post
/organizations/{organizationId}/fhir/3/Binary/_search

A binary resource can contain any content, whether text, image, pdf, zip archive, etc.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
contenttypestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringBinaryThis is a Binary resource
contentTypestringMimeType of the binary content represented as a standard MimeType (BCP 13).
securityContextReferenceTreat this binary as if it was this other resource for access control purposes.
contentstringThe actual content, base64 encoded.

Response

Update Binary

put
/organizations/{organizationId}/fhir/3/Binary/{resourceId}

A binary resource can contain any content, whether text, image, pdf, zip archive, etc.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringBinaryThis is a Binary resource
contentTypestringMimeType of the binary content represented as a standard MimeType (BCP 13).
securityContextReferenceTreat this binary as if it was this other resource for access control purposes.
contentstringThe actual content, base64 encoded.

Response