Name Flags Card. Type Description & Constraints doco
. . Bundle N Resource Contains a collection of resources
+ Rule: total only when a search or history
+ Rule: entry.search only when a search
+ Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
+ Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
+ Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
+ Rule: A document must have an identifier with a system and a value
+ Rule: A document must have a date
+ Rule: A document must have a Composition as the first resource
+ Rule: A message must have a MessageHeader as the first resource
Elements defined in Ancestors: id, meta, implicitRules, language
. . . identifier Σ 0..1 Identifier Persistent identifier for the bundle
. . . type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
BundleType ( Required)
. . . timestamp Σ 0..1 instant When the bundle was assembled
. . . total Σ I 0..1 unsignedInt If search, the total number of matches
. . . link Σ 0..* BackboneElement Links related to this Bundle
. . . . relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
. . . . url Σ 1..1 uri Reference details for the link
. . . entry Σ I 0..* BackboneElement Entry in the bundle - will have a resource or information
+ Rule: must be a resource unless there's a request or response
+ Rule: fullUrl cannot be a version specific reference
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
. . . . link Σ 0..* see link Links related to this entry
. . . . fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
. . . . resource Σ 0..1 Resource A resource in the bundle
. . . . search Σ I 0..1 BackboneElement Search related information
. . . . . mode Σ 0..1 code match | include | outcome - why this is in the result set
SearchEntryMode ( Required)
. . . . . score Σ 0..1 decimal Search ranking (between 0 and 1)
. . . . request Σ I 0..1 BackboneElement Additional execution information (transaction/batch/history)
. . . . . method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
HTTPVerb ( Required)
. . . . . url Σ 1..1 uri URL for HTTP equivalent of this entry
. . . . . ifNoneMatch Σ 0..1 string For managing cache currency
. . . . . ifModifiedSince Σ 0..1 instant For managing cache currency
. . . . . ifMatch Σ 0..1 string For managing update contention
. . . . . ifNoneExist Σ 0..1 string For conditional creates
. . . . response Σ I 0..1 BackboneElement Results of execution (transaction/batch/history)
. . . . . status Σ 1..1 string Status response code (text optional)
. . . . . location Σ 0..1 uri The location (if the operation returns a location)
. . . . . etag Σ 0..1 string The Etag for the resource (if relevant)
. . . . . lastModified Σ 0..1 instant Server's date time modified
. . . . . outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
. . . signature Σ TU 0..1 Signature Digital Signature

doco Documentation for this format