Name Flags Card. Type Description & Constraints doco
. . Bundle Σ I Resource Contains a collection of resources
entry.search only when a search
total only when a search or history
FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId
entry.request only for some types of bundles
entry.response only for some types of bundles
. . . type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
BundleType ( Required)
. . . total Σ I 0..1 unsignedInt If search, the total number of matches
. . . link Σ 0..* BackboneElement Links related to this Bundle
. . . . relation Σ 1..1 string http://www.iana.org/assignments/link-relations/link-relations.xhtml
. . . . url Σ 1..1 uri Reference details for the link
. . . entry Σ I 0..* BackboneElement Entry in the bundle - will have a resource, or information
must be a resource unless there's a request or response
The fullUrl element must be present when a resource is present, and not present otherwise
. . . . link Σ 0..* see link Links related to this entry
. . . . fullUrl Σ 0..1 uri Absolute URL for resource (server address, or 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 Transaction Related Information
. . . . . method Σ 1..1 code GET | POST | PUT | DELETE
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 update contention
. . . . . ifMatch Σ 0..1 string For managing update contention
. . . . . ifNoneExist Σ 0..1 string For conditional creates
. . . . response Σ I 0..1 BackboneElement Transaction Related Information
. . . . . status Σ 1..1 string Status return code for entry
. . . . . 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
. . . signature Σ 0..1 Signature Digital Signature

doco Documentation for this format