PATIENT ADMINISTRTAION (PA) Workgroup Development Draft

6.8.6 Resource Bundle - Detailed Descriptions

Detailed Descriptions for the elements in the Bundle resource.

Bundle
Definition

A container for a collection of resources.

Control1..1
InvariantsDefined on this element
bdl-1: total only when a search or history (xpath: not(f:total) or (f:type/@value = 'searchset') or (f:type/@value = 'history'))
bdl-2: entry.search only when a search (xpath: not(f:entry/f:search) or (f:type/@value = 'searchset'))
bdl-3: entry.transaction when (and only when) a transaction (xpath: not(f:entry/f:transaction) or (f:type/@value = 'transaction') or (f:type/@value = 'history'))
bdl-4: entry.transactionResponse when (and only when) a transaction-response (xpath: not(f:entry/f:transactionResponse) or (f:type/@value = 'transaction-response'))
Bundle.type
Definition

Indicates the purpose of this bundle- how it was intended to be used.

Control1..1
BindingBundleType: Required: http://hl7.org/fhir/bundle-type (Indicates the purpose of a bundle- how it was intended to be used)
Typecode
Comments

It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.

Bundle.base
Definition

The base URL for the service that provided these resources. All relative URLs are relative to this one (equivalent to xml:base).

Control0..1
Typeuri
Bundle.total
Definition

If a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle).

Control0..1
TypeunsignedInt
Comments

Only used if the bundle is a search result set.

InvariantsAffect this element
bdl-1: total only when a search or history (xpath: not(f:total) or (f:type/@value = 'searchset') or (f:type/@value = 'history'))
Bundle.link
Definition

A series of links that provide context to this bundle.

Control0..*
Bundle.link.relation
Definition

A name which details the functional use for this link - see [[http://www.iana.org/assignments/link-relations/link-relations.xhtml]].

Control1..1
Typestring
Bundle.link.url
Definition

The reference details for the link.

Control1..1
Typeuri
Bundle.entry
Definition

An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).

Control0..*
InvariantsDefined on this element
bdl-5: must be a resource unless there's a transaction or transaction response (xpath: f:resource or f:transaction or f:transactionResponse)
Bundle.entry.base
Definition

The Base URL for the resource, if different to the base URL specified for the bundle as a whole.

Control0..1
Typeuri
Comments

This allows bundles to be composed of resources from multiple servers (collated search, documents etc).

Bundle.entry.link
Definition

A series of links that provide context to this entry.

Control0..*
TypeSee Bundle.link
Bundle.entry.resource
Definition

The Resources for the entry.

Control0..1
TypeResource
Bundle.entry.search
Definition

Information about the search process that lead to the creation of this entry.

Control0..1
InvariantsAffect this element
bdl-2: entry.search only when a search (xpath: not(f:entry/f:search) or (f:type/@value = 'searchset'))
Bundle.entry.search.mode
Definition

Why this entry is in the result set - whether it's included as a match or because of an _include requirement.

Control0..1
BindingSearchEntryMode: Required: http://hl7.org/fhir/search-entry-mode (Why an entry is in the result set - whether it's included as a match or because of an _include requirement)
Typecode
Bundle.entry.search.score
Definition

When searching, the server's search ranking score for the entry.

Control0..1
Typedecimal
Comments

Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.

Bundle.entry.transaction
Definition

Additional information about how this entry should be processed as part of a transaction.

Control0..1
InvariantsAffect this element
bdl-3: entry.transaction when (and only when) a transaction (xpath: not(f:entry/f:transaction) or (f:type/@value = 'transaction') or (f:type/@value = 'history'))
Bundle.entry.transaction.method
Definition

The HTTP verb for this entry in either a update history, or a transaction/ transaction response.

Control1..1
BindingHTTPVerb: Required: http://hl7.org/fhir/http-verb (HTTP verbs (in the HTTP command line))
Typecode
Bundle.entry.transaction.url
Definition

A search URL for this resource that specifies how the resource is matched to an existing resource when processing a transaction (see transaction documentation).

Control1..1
Typeuri
Bundle.entry.transaction.ifNoneMatch
Definition

If the ETag values match, return a 304 Not modified status. See the read/vread interaction documentation.

Control0..1
Typestring
Bundle.entry.transaction.ifMatch
Definition

Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".

Control0..1
Typestring
Bundle.entry.transaction.ifModifiedSince
Definition

Only perform the operation if the last updated date matches. For more information, see the API section "Managing Resource Contention".

Control0..1
Typeinstant
Bundle.entry.transaction.ifNoneExist
Definition

Instruct the server not to perform the create if a specified resource already exists. For further information, see "Conditional Create".

Control0..1
Typestring
Bundle.entry.transactionResponse
Definition

Additional information about how this entry should be processed as part of a transaction.

Control0..1
InvariantsAffect this element
bdl-4: entry.transactionResponse when (and only when) a transaction-response (xpath: not(f:entry/f:transactionResponse) or (f:type/@value = 'transaction-response'))
Bundle.entry.transactionResponse.status
Definition

The status code returned by processing this entry.

Control1..1
Typestring
Bundle.entry.transactionResponse.location
Definition

The location header created by processing this operation.

Control0..1
Typeuri
Bundle.entry.transactionResponse.etag
Definition

The etag for the resource, it the operation for the entry produced a versioned resource.

Control0..1
Typestring
Comments

This has to match the version id in the header if a resource is included.

Bundle.entry.transactionResponse.lastModified
Definition

The date/time that the resource was modified on the server.

Control0..1
Typeinstant
Comments

This has to match the same time in the meta header if a resource is included.

Bundle.signature
Definition

XML Digital Signature - base64 encoded.

Control0..1
Typebase64Binary
Comments

This is base 64 encoded to address issues with json/xml.