Skip to main content

Bundle

Normative Foundation

A container for a collection of resources.

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/Bundle
InteractionMethodPath
ReadGET/fhir/R4/Bundle/[id]
VreadGET/fhir/R4/Bundle/[id]/_history/[vid]
UpdatePUT/fhir/R4/Bundle/[id]
PatchPATCH/fhir/R4/Bundle/[id]
DeleteDELETE/fhir/R4/Bundle/[id]
CreatePOST/fhir/R4/Bundle
SearchGET/fhir/R4/Bundle
HistoryGET/fhir/R4/Bundle/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..1Persistent identifier for the bundle
typecode1..1document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
timestampinstant0..1When the bundle was assembled
totalunsignedInt0..1If search, the total number of matches
linkBackboneElement0..*Links related to this Bundle
entryBackboneElement0..*Entry in the bundle - will have a resource or information
signatureSignature0..1Digital Signature

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
compositionstringhttp://hl7.org/fhir/SearchParameter/Bundle-composition
identifierstringhttp://hl7.org/fhir/SearchParameter/Bundle-identifier
messagestringhttp://hl7.org/fhir/SearchParameter/Bundle-message
timestampstringhttp://hl7.org/fhir/SearchParameter/Bundle-timestamp
typestringhttp://hl7.org/fhir/SearchParameter/Bundle-type

Reference​

  • Official FHIR R4 spec: Bundle
  • Maturity: Normative (FMM 5).