Skip to main content

Bundle

PropertyValue
Publisher
NameBundle
URLhttp://hl7.org/fhir/StructureDefinition/Bundle
Statusactive
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
Bundle0..*BundleA container for a collection of resources.
Bundle.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Bundle.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Bundle.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Bundle.language0..1codeThe base language in which the resource is written.
Bundle.identifier0..1IdentifierA persistent identifier for the bundle that won't change as a bundle is copied from server to server.
Bundle.type1..1codeIndicates the purpose of this bundle - how it is intended to be used.
Bundle.timestamp0..1instantThe date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.
Bundle.total0..1unsignedIntIf a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.
Bundle.link0..*BackboneElementA series of links that provide context to this bundle.
Bundle.link.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Bundle.link.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Bundle.link.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Bundle.link.relation1..1stringA name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1.
Bundle.link.url1..1uriThe reference details for the link.
Bundle.entry0..*BackboneElementAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Bundle.entry.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Bundle.entry.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Bundle.entry.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Bundle.entry.link0..*BundleA series of links that provide context to this entry.
Bundle.entry.fullUrl0..1uriThe Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: * fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)* Results from operations might involve resources that are not identified.
Bundle.entry.resource0..1ResourceThe Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.
Bundle.entry.search0..1BackboneElementInformation about the search process that lead to the creation of this entry.
Bundle.entry.search.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Bundle.entry.search.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Bundle.entry.search.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Bundle.entry.search.mode0..1codeWhy this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
Bundle.entry.search.score0..1decimalWhen searching, the server's search ranking score for the entry.
Bundle.entry.request0..1BackboneElementAdditional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.
Bundle.entry.request.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Bundle.entry.request.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Bundle.entry.request.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Bundle.entry.request.method1..1codeIn a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.
Bundle.entry.request.url1..1uriThe URL for this entry, relative to the root (the address to which the request is posted).
Bundle.entry.request.ifNoneMatch0..1stringIf the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".
Bundle.entry.request.ifModifiedSince0..1instantOnly perform the operation if the last updated date matches. See the API documentation for "Conditional Read".
Bundle.entry.request.ifMatch0..1stringOnly perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".
Bundle.entry.request.ifNoneExist0..1stringInstruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?").
Bundle.entry.response0..1BackboneElementIndicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.
Bundle.entry.response.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Bundle.entry.response.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Bundle.entry.response.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Bundle.entry.response.status1..1stringThe status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.
Bundle.entry.response.location0..1uriThe location header created by processing this operation, populated if the operation returns a location.
Bundle.entry.response.etag0..1stringThe Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention).
Bundle.entry.response.lastModified0..1instantThe date/time that the resource was modified on the server.
Bundle.entry.response.outcome0..1ResourceAn OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.
Bundle.signature0..1SignatureDigital Signature - base64 encoded. XML-DSig or a JWT.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
compositionreferenceThe first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to search its contentsBundle.entry[0].resource
identifiertokenPersistent identifier for the bundleBundle.identifier
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 contentsBundle.entry[0].resource
timestampdateWhen the bundle was assembledBundle.timestamp
typetokendocument / message / transaction / transaction-response / batch / batch-response / history / searchset / collectionBundle.type
_iguhealth-version-seqnumberThe version sequence of the resourceResource.meta.extension.where(url='https://iguhealth.app/version-sequence').value
_iguhealth-authorreferenceThe author of the resourceResource.meta.extension.where(url='https://iguhealth.app/author').value