bundles

Create Bundle

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

A container for a collection of resources.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringBundleThis is a Bundle resource
identifierIdentifierA persistent identifier for the batch that won't change as a batch is copied from server to server.
typestringdocument|message|transaction|transaction-response|batch|batch-response|history|searchset|collectionIndicates the purpose of this bundle - how it was intended to be used.
totalnumberIf a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle).
linkarray(Bundle_Link)A series of links that provide context to this bundle.
entryarray(Bundle_Entry)An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).
signatureSignatureDigital Signature - base64 encoded. XML-DSIg or a JWT.

Response

Patch Bundle

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

A container for a collection of resources.

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*stringBundleThis is a Bundle resource
identifierIdentifierA persistent identifier for the batch that won't change as a batch is copied from server to server.
typestringdocument|message|transaction|transaction-response|batch|batch-response|history|searchset|collectionIndicates the purpose of this bundle - how it was intended to be used.
totalnumberIf a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle).
linkarray(Bundle_Link)A series of links that provide context to this bundle.
entryarray(Bundle_Entry)An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).
signatureSignatureDigital Signature - base64 encoded. XML-DSIg or a JWT.

Response

Read Bundle

get
/organizations/{organizationId}/fhir/3/Bundle/{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 Bundle

get
/organizations/{organizationId}/fhir/3/Bundle/{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 Bundle

get
/organizations/{organizationId}/fhir/3/Bundle/{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 Bundle

delete
/organizations/{organizationId}/fhir/3/Bundle/{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 Bundle

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

Request

Headers

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

Query params

_idstring
_languagestring
compositionstring
identifierstring
messagestring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Bundle

get
/organizations/{organizationId}/fhir/3/Bundle/_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 Bundle

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

A container for a collection of resources.

Request

Headers

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

Query params

_idstring
_languagestring
compositionstring
identifierstring
messagestring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringBundleThis is a Bundle resource
identifierIdentifierA persistent identifier for the batch that won't change as a batch is copied from server to server.
typestringdocument|message|transaction|transaction-response|batch|batch-response|history|searchset|collectionIndicates the purpose of this bundle - how it was intended to be used.
totalnumberIf a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle).
linkarray(Bundle_Link)A series of links that provide context to this bundle.
entryarray(Bundle_Entry)An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).
signatureSignatureDigital Signature - base64 encoded. XML-DSIg or a JWT.

Response

Update Bundle

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

A container for a collection of resources.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringBundleThis is a Bundle resource
identifierIdentifierA persistent identifier for the batch that won't change as a batch is copied from server to server.
typestringdocument|message|transaction|transaction-response|batch|batch-response|history|searchset|collectionIndicates the purpose of this bundle - how it was intended to be used.
totalnumberIf a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle).
linkarray(Bundle_Link)A series of links that provide context to this bundle.
entryarray(Bundle_Entry)An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).
signatureSignatureDigital Signature - base64 encoded. XML-DSIg or a JWT.

Response