bundles

Create Bundle

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

A container for a collection of resources.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Bundle resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
identifierIdentifierA persistent identifier for the bundle that won't change as a bundle is copied from server to server.
typedocument|message|transaction|transaction-response|batch|batch-response|history|searchset|collectionIndicates the purpose of this bundle - how it is intended to be used.
timestampinstantThe date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.
totalunsignedIntIf a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the 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/4/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*This is a Bundle resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
identifierIdentifierA persistent identifier for the bundle that won't change as a bundle is copied from server to server.
typedocument|message|transaction|transaction-response|batch|batch-response|history|searchset|collectionIndicates the purpose of this bundle - how it is intended to be used.
timestampinstantThe date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.
totalunsignedIntIf a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the 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/4/Bundle/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Bundle

get
/organizations/{organizationId}/fhir/4/Bundle/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/Bundle/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Bundle

delete
/organizations/{organizationId}/fhir/4/Bundle/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Bundle

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

Request

Headers

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

Query params

_idstring
_languagestring
compositionstring
identifierstring
messagestring
timestampstring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Bundle

get
/organizations/{organizationId}/fhir/4/Bundle/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/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
timestampstring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Bundle resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
identifierIdentifierA persistent identifier for the bundle that won't change as a bundle is copied from server to server.
typedocument|message|transaction|transaction-response|batch|batch-response|history|searchset|collectionIndicates the purpose of this bundle - how it is intended to be used.
timestampinstantThe date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.
totalunsignedIntIf a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the 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/4/Bundle/{resourceId}

A container for a collection of resources.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a Bundle resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
identifierIdentifierA persistent identifier for the bundle that won't change as a bundle is copied from server to server.
typedocument|message|transaction|transaction-response|batch|batch-response|history|searchset|collectionIndicates the purpose of this bundle - how it is intended to be used.
timestampinstantThe date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.
totalunsignedIntIf a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the 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