Skip to main content

Bundle

Normative Foundation

A container for a collection of resources.

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/Bundle
InteractionMethodPath
ReadGET/fhir/R5/Bundle/[id]
VreadGET/fhir/R5/Bundle/[id]/_history/[vid]
UpdatePUT/fhir/R5/Bundle/[id]
PatchPATCH/fhir/R5/Bundle/[id]
DeleteDELETE/fhir/R5/Bundle/[id]
CreatePOST/fhir/R5/Bundle
SearchGET/fhir/R5/Bundle?...
HistoryGET/fhir/R5/Bundle/[id]/_history
Type-historyGET/fhir/R5/Bundle/_history

Top-level elements

ElementType(s)CardinalityDescription
identifierIdentifier0..1Persistent identifier for the bundle
typecode1..1document
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
issuesResource0..1Issues with the Bundle

Resource-specific search parameters

ParameterTypeDescription
compositionreferenceThe first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to search its contents
example-constraintreferenceSearch Composition Bundle
identifiertokenPersistent identifier for the bundle
messagereferenceThe 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
timestampdateWhen the bundle was assembled
typetokendocument

Reference

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