bundles
Batch Transaction Bundle
post
/organizations/{organizationId}/fhir/4
A container for a collection of resources.
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a Bundle resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The 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. | |
implicitRules | uri | A 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. | |
language | code | The base language in which the resource is written. | |
identifier | Identifier | A persistent identifier for the bundle that won't change as a bundle is copied from server to server. | |
type* | document|message|transaction|transaction-response|batch|batch-response|history|searchset|collection | Indicates the purpose of this bundle - how it is intended to be used. | |
timestamp | instant | The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. | |
total | unsignedInt | If 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. | |
link | array(Bundle_Link) | A series of links that provide context to this bundle. | |
entry | array(Bundle_Entry) | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). | |
signature | Signature | Digital Signature - base64 encoded. XML-DSig or a JWT. |
Response
keyboard_arrow_down
Create Bundle
post
/organizations/{organizationId}/fhir/4/Bundle
A container for a collection of resources.
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a Bundle resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The 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. | |
implicitRules | uri | A 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. | |
language | code | The base language in which the resource is written. | |
identifier | Identifier | A persistent identifier for the bundle that won't change as a bundle is copied from server to server. | |
type* | document|message|transaction|transaction-response|batch|batch-response|history|searchset|collection | Indicates the purpose of this bundle - how it is intended to be used. | |
timestamp | instant | The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. | |
total | unsignedInt | If 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. | |
link | array(Bundle_Link) | A series of links that provide context to this bundle. | |
entry | array(Bundle_Entry) | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). | |
signature | Signature | Digital Signature - base64 encoded. XML-DSig or a JWT. |
Response
keyboard_arrow_down
Patch Bundle
patch
/organizations/{organizationId}/fhir/4/Bundle/{resourceId}
A container for a collection of resources.
Request
Headers
content-type* | string | application/json-patch+json | application/json-patch+json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Body
resourceType* | This is a Bundle resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The 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. | |
implicitRules | uri | A 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. | |
language | code | The base language in which the resource is written. | |
identifier | Identifier | A persistent identifier for the bundle that won't change as a bundle is copied from server to server. | |
type* | document|message|transaction|transaction-response|batch|batch-response|history|searchset|collection | Indicates the purpose of this bundle - how it is intended to be used. | |
timestamp | instant | The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. | |
total | unsignedInt | If 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. | |
link | array(Bundle_Link) | A series of links that provide context to this bundle. | |
entry | array(Bundle_Entry) | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). | |
signature | Signature | Digital Signature - base64 encoded. XML-DSig or a JWT. |
Response
keyboard_arrow_down
Read Bundle
get
/organizations/{organizationId}/fhir/4/Bundle/{resourceId}
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Read History Bundle
get
/organizations/{organizationId}/fhir/4/Bundle/{resourceId}/_history
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_count | string | ||
_since | string |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Read Version Bundle
get
/organizations/{organizationId}/fhir/4/Bundle/{resourceId}/_history/{versionId}
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* | |||
versionId* |
Response
keyboard_arrow_down
Remove Bundle
delete
/organizations/{organizationId}/fhir/4/Bundle/{resourceId}
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Search Get Bundle
get
/organizations/{organizationId}/fhir/4/Bundle
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_id | string | ||
_language | string | ||
composition | string | ||
identifier | string | ||
message | string | ||
timestamp | string | ||
type | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Bundle
get
/organizations/{organizationId}/fhir/4/Bundle/_history
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_count | string | ||
_since | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search Post Bundle
post
/organizations/{organizationId}/fhir/4/Bundle/_search
A container for a collection of resources.
Request
Headers
content-type* | string | application/json|application/x-www-form-urlencoded | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_id | string | ||
_language | string | ||
composition | string | ||
identifier | string | ||
message | string | ||
timestamp | string | ||
type | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a Bundle resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The 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. | |
implicitRules | uri | A 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. | |
language | code | The base language in which the resource is written. | |
identifier | Identifier | A persistent identifier for the bundle that won't change as a bundle is copied from server to server. | |
type* | document|message|transaction|transaction-response|batch|batch-response|history|searchset|collection | Indicates the purpose of this bundle - how it is intended to be used. | |
timestamp | instant | The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. | |
total | unsignedInt | If 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. | |
link | array(Bundle_Link) | A series of links that provide context to this bundle. | |
entry | array(Bundle_Entry) | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). | |
signature | Signature | Digital Signature - base64 encoded. XML-DSig or a JWT. |
Response
keyboard_arrow_down
Update Bundle
put
/organizations/{organizationId}/fhir/4/Bundle/{resourceId}
A container for a collection of resources.
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Body
resourceType* | This is a Bundle resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The 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. | |
implicitRules | uri | A 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. | |
language | code | The base language in which the resource is written. | |
identifier | Identifier | A persistent identifier for the bundle that won't change as a bundle is copied from server to server. | |
type* | document|message|transaction|transaction-response|batch|batch-response|history|searchset|collection | Indicates the purpose of this bundle - how it is intended to be used. | |
timestamp | instant | The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. | |
total | unsignedInt | If 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. | |
link | array(Bundle_Link) | A series of links that provide context to this bundle. | |
entry | array(Bundle_Entry) | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). | |
signature | Signature | Digital Signature - base64 encoded. XML-DSig or a JWT. |
Response
keyboard_arrow_down