bundles
Create Bundle
post
/organizations/{organizationId}/fhir/3/Bundle
A container for a collection of resources.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Bundle | This is a Bundle resource |
| identifier | Identifier | A persistent identifier for the batch that won't change as a batch is copied from server to server. | |
| type | string | document|message|transaction|transaction-response|batch|batch-response|history|searchset|collection | Indicates the purpose of this bundle - how it was intended to be used. |
| total | number | If 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). | |
| 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/3/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* | string | Bundle | This is a Bundle resource |
| identifier | Identifier | A persistent identifier for the batch that won't change as a batch is copied from server to server. | |
| type | string | document|message|transaction|transaction-response|batch|batch-response|history|searchset|collection | Indicates the purpose of this bundle - how it was intended to be used. |
| total | number | If 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). | |
| 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/3/Bundle/{resourceId}
Request
Headers
| content-type* | string | application/json | 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/3/Bundle/{resourceId}/_history
Request
Headers
| content-type* | string | application/json | 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/3/Bundle/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json | 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/3/Bundle/{resourceId}
Request
Headers
| content-type* | string | application/json | 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/3/Bundle
Request
Headers
| content-type* | string | application/json | 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 | ||
| type | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Bundle
get
/organizations/{organizationId}/fhir/3/Bundle/_history
Request
Headers
| content-type* | string | application/json | 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/3/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 | ||
| type | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Bundle | This is a Bundle resource |
| identifier | Identifier | A persistent identifier for the batch that won't change as a batch is copied from server to server. | |
| type | string | document|message|transaction|transaction-response|batch|batch-response|history|searchset|collection | Indicates the purpose of this bundle - how it was intended to be used. |
| total | number | If 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). | |
| 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/3/Bundle/{resourceId}
A container for a collection of resources.
Request
Headers
| content-type* | string | application/json | 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* | string | Bundle | This is a Bundle resource |
| identifier | Identifier | A persistent identifier for the batch that won't change as a batch is copied from server to server. | |
| type | string | document|message|transaction|transaction-response|batch|batch-response|history|searchset|collection | Indicates the purpose of this bundle - how it was intended to be used. |
| total | number | If 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). | |
| 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