# Bundle

Canonical page: https://docs.ovok.com/api/fhir/r4/bundle

A container for a collection of resources.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/Bundle/[id]` |
| Vread | `GET` | `/fhir/R4/Bundle/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Bundle/[id]` |
| Patch | `PATCH` | `/fhir/R4/Bundle/[id]` |
| Delete | `DELETE` | `/fhir/R4/Bundle/[id]` |
| Create | `POST` | `/fhir/R4/Bundle` |
| Search | `GET` | `/fhir/R4/Bundle` |
| History | `GET` | `/fhir/R4/Bundle/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..1` | Persistent identifier for the bundle |
| <span id="element-type"></span>`type` | [code](/fhir-elements/primitive/code) | `1..1` | document \| message \| transaction \| transaction-response \| batch \| batch-response \| history \| searchset \| collection |
| <span id="element-timestamp"></span>`timestamp` | [instant](/fhir-elements/primitive/instant) | `0..1` | When the bundle was assembled |
| <span id="element-total"></span>`total` | [unsignedInt](/fhir-elements/primitive/unsigned-int) | `0..1` | If search, the total number of matches |
| <span id="element-link"></span>`link` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Links related to this Bundle |
| <span id="element-entry"></span>`entry` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Entry in the bundle - will have a resource or information |
| <span id="element-signature"></span>`signature` | [Signature](/fhir-elements/complex/signature) | `0..1` | Digital Signature |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `composition` | reference | The first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to search its contents |
| `identifier` | token | Persistent identifier for the bundle |
| `message` | reference | The first resource in the bundle, if the bundle type is "message" - this is a message header, and this parameter provides access to search its contents |
| `timestamp` | date | When the bundle was assembled |
| `type` | token | document \| message \| transaction \| transaction-response \| batch \| batch-response \| history \| searchset \| collection |

## Reference [#reference]

Official FHIR R4 spec: [Bundle](https://hl7.org/fhir/R4/bundle.html).  
Maturity: Trial Use 5 (FMM 5).
