Bundle
A container for a collection of resources.
Endpoints
alpha
https://api.dev.ovok.com/fhir/R4/Bundle| 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(s) | Cardinality | Description |
|---|---|---|---|
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 |
|---|---|---|
_compartment | string | |
_count | string | https://www.hl7.org/fhir/search.html#_count |
_elements | string | https://www.hl7.org/fhir/search.html#_elements |
_id | string | |
_lastUpdated | string | |
_profile | string | |
_security | string | |
_sort | string | https://www.hl7.org/fhir/search.html#_sort |
_source | string | |
_summary | string | https://www.hl7.org/fhir/search.html#_summary |
_tag | string | |
_total | string | https://www.hl7.org/fhir/search.html#_total |
composition | string | http://hl7.org/fhir/SearchParameter/Bundle-composition |
identifier | string | http://hl7.org/fhir/SearchParameter/Bundle-identifier |
message | string | http://hl7.org/fhir/SearchParameter/Bundle-message |
timestamp | string | http://hl7.org/fhir/SearchParameter/Bundle-timestamp |
type | string | http://hl7.org/fhir/SearchParameter/Bundle-type |
Reference
- Official FHIR R4 spec:
Bundle - Maturity: Normative (FMM 5).