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
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
identifier | Identifier | 0..1 | Persistent identifier for the bundle |
type | code | 1..1 | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection |
timestamp | instant | 0..1 | When the bundle was assembled |
total | unsignedInt | 0..1 | If search, the total number of matches |
link | BackboneElement | 0..* | Links related to this Bundle |
entry | BackboneElement | 0..* | Entry in the bundle - will have a resource or information |
signature | Signature | 0..1 | Digital Signature |
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
Official FHIR R4 spec: Bundle.
Maturity: Trial Use 5 (FMM 5).