Bundle
Bundle I Bundle Element idBundle
Short description Contains a collection of resources
Definition A container for a collection of resources.
Data type Constraints- bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId
entry.where(fullUrl).select(fullUrl&resource.meta.versionId).isDistinct() - bdl-9: A document must have an identifier with a system and a value
type = 'document' implies (identifier.system.exists() and identifier.value.exists()) - bdl-3: entry.request only for some types of bundles
entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history' - bdl-4: entry.response only for some types of bundles
entry.response.empty() or type = 'batch-response' or type = 'transaction-response' - bdl-1: total only when a search or history
total.empty() or (type = 'searchset') or (type = 'history') - bdl-2: entry.search only when a search
entry.search.empty() or (type = 'searchset')
Mappings- rim: Entity. Role, or Act
- v2: N/A
- rim: N/A
- w5: infrastructure.structure
id Σ 0..1 id There are no (further) constraints on this elementElement idBundle.id
Short description Logical id of this artifact
Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
meta Σ 0..1 Meta There are no (further) constraints on this elementElement idBundle.meta
Short description Metadata about the resource
Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
implicitRules Σ ?! 0..1 uri There are no (further) constraints on this elementElement idBundle.implicitRules
Short description A set of rules under which this content was created
Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.
This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
language 0..1 codeBinding There are no (further) constraints on this elementElement idBundle.language
Short description Language of the resource content
Definition The base language in which the resource is written.
Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Data type Binding A human language.CommonLanguages (extensible)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
identifier Σ 0..1 Identifier Element idBundle.identifier
Short description Persistent identifier for the bundle
Definition A persistent identifier for the batch that won't change as a batch is copied from server to server.
Comments Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results, and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- w5: id
type Σ 1..1 codeBinding Element idBundle.type
Short description document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Definition Indicates the purpose of this bundle - how it was intended to be used.
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.
Data type Binding Indicates the purpose of a bundle - how it was intended to be used.BundleType (required)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
- w5: class
total Σ I 0..1 unsignedInt Element idBundle.total
Short description If search, the total number of matches
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).
Comments Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
link Σ 0..* BackboneElement Element idBundle.link
Short description Links related to this Bundle
Definition A series of links that provide context to this bundle.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
id 0..1 string There are no (further) constraints on this elementElement idBundle.link.id
Short description xml:id (or equivalent in JSON)
Definition unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Comments Note that FHIR strings may not exceed 1MB in size
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idBundle.link.extension
Short description Additional Content defined by implementations
Alternate names extensions, user content
Definition May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idBundle.link.modifierExtension
Short description Extensions that cannot be ignored
Alternate names extensions, user content, modifiers
Definition May 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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
relation Σ 1..1 string Element idBundle.link.relation
Short description See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Definition A name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1.
Comments Note that FHIR strings may not exceed 1MB in size
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
url Σ 1..1 uri Element idBundle.link.url
Short description Reference details for the link
Definition The reference details for the link.
Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
entry Σ I 0..* BackboneElement Element idBundle.entry
Short description Entry in the bundle - will have a resource, or information
Definition An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - bdl-8: fullUrl cannot be a version specific reference
fullUrl.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists()
Mappings- rim: n/a
id 0..1 string There are no (further) constraints on this elementElement idBundle.entry.id
Short description xml:id (or equivalent in JSON)
Definition unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Comments Note that FHIR strings may not exceed 1MB in size
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idBundle.entry.extension
Short description Additional Content defined by implementations
Alternate names extensions, user content
Definition May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idBundle.entry.modifierExtension
Short description Extensions that cannot be ignored
Alternate names extensions, user content, modifiers
Definition May 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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
link Σ 0..* see (link) There are no (further) constraints on this elementElement idBundle.entry.link
Short description Links related to this entry
Definition A series of links that provide context to this entry.
fullUrl Σ 0..1 uri Element idBundle.entry.fullUrl
Short description Absolute URL for resource (server address, or UUID/OID)
Definition The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. 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.
Comments fullUrl may not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the absolute URL may not end with the logical id of the resource (Resource.id), but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then it SHALL end with the Resource.id.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
resource Σ 0..1 Resource Element idBundle.entry.resource
Short description A resource in the bundle
Definition The Resources for the entry.
Data type Mappings- rim: Entity. Role, or Act
search Σ I 0..1 BackboneElement Element idBundle.entry.search
Short description Search related information
Definition Information about the search process that lead to the creation of this entry.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
id 0..1 string There are no (further) constraints on this elementElement idBundle.entry.search.id
Short description xml:id (or equivalent in JSON)
Definition unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Comments Note that FHIR strings may not exceed 1MB in size
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idBundle.entry.search.extension
Short description Additional Content defined by implementations
Alternate names extensions, user content
Definition May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idBundle.entry.search.modifierExtension
Short description Extensions that cannot be ignored
Alternate names extensions, user content, modifiers
Definition May 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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
mode Σ 0..1 codeBinding Element idBundle.entry.search.mode
Short description match | include | outcome - why this is in the result set
Definition Why this entry is in the result set - whether it's included as a match or because of an _include requirement.
Comments There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.
Data type Binding Why an entry is in the result set - whether it's included as a match or because of an _include requirement.SearchEntryMode (required)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
score Σ 0..1 decimal Element idBundle.entry.search.score
Short description Search ranking (between 0 and 1)
Definition When searching, the server's search ranking score for the entry.
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.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
request Σ I 0..1 BackboneElement Element idBundle.entry.request
Short description Transaction Related Information
Definition Additional information about how this entry should be processed as part of a transaction.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
id 0..1 string There are no (further) constraints on this elementElement idBundle.entry.request.id
Short description xml:id (or equivalent in JSON)
Definition unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Comments Note that FHIR strings may not exceed 1MB in size
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idBundle.entry.request.extension
Short description Additional Content defined by implementations
Alternate names extensions, user content
Definition May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idBundle.entry.request.modifierExtension
Short description Extensions that cannot be ignored
Alternate names extensions, user content, modifiers
Definition May 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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
method Σ 1..1 codeBinding Element idBundle.entry.request.method
Short description GET | POST | PUT | DELETE
Definition The HTTP verb for this entry in either a change history, or a transaction/ transaction response.
Comments Note that FHIR strings may not exceed 1MB in size
Data type Binding HTTP verbs (in the HTTP command line).HTTPVerb (required)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
url Σ 1..1 uri Element idBundle.entry.request.url
Short description URL for HTTP equivalent of this entry
Definition The URL for this entry, relative to the root (the address to which the request is posted).
Comments E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT, and the URL would be "Patient/[id]".
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
ifNoneMatch Σ 0..1 string Element idBundle.entry.request.ifNoneMatch
Short description For managing cache currency
Definition If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".
Comments Note that FHIR strings may not exceed 1MB in size
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
ifModifiedSince Σ 0..1 instant Element idBundle.entry.request.ifModifiedSince
Short description For managing update contention
Definition Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".
Comments Note: This is intended for precisely observed times, typically system logs etc., and not human-reported times - for them, see date and dateTime below. Time zone is always required
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
ifMatch Σ 0..1 string Element idBundle.entry.request.ifMatch
Short description For managing update contention
Definition Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".
Comments Note that FHIR strings may not exceed 1MB in size
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
ifNoneExist Σ 0..1 string Element idBundle.entry.request.ifNoneExist
Short description For conditional creates
Definition Instruct 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 "?").
Comments Note that FHIR strings may not exceed 1MB in size
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
response Σ I 0..1 BackboneElement Element idBundle.entry.response
Short description Transaction Related Information
Definition Additional information about how this entry should be processed as part of a transaction.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
id 0..1 string There are no (further) constraints on this elementElement idBundle.entry.response.id
Short description xml:id (or equivalent in JSON)
Definition unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Comments Note that FHIR strings may not exceed 1MB in size
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
extension I 0..* Extension There are no (further) constraints on this elementElement idBundle.entry.response.extension
Short description Additional Content defined by implementations
Alternate names extensions, user content
Definition May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data type Sliced: Unordered, Open, by url(Value)
Extensions are always sliced by (at least) urlConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! I 0..* Extension There are no (further) constraints on this elementElement idBundle.entry.response.modifierExtension
Short description Extensions that cannot be ignored
Alternate names extensions, user content, modifiers
Definition May 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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
status Σ 1..1 string Element idBundle.entry.response.status
Short description Status response code (text optional)
Definition The 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.
Comments Note that FHIR strings may not exceed 1MB in size
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
location Σ 0..1 uri Element idBundle.entry.response.location
Short description The location, if the operation returns a location
Definition The location header created by processing this operation.
Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
etag Σ 0..1 string Element idBundle.entry.response.etag
Short description The etag for the resource (if relevant)
Definition The etag for the resource, it the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention).
Comments Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
lastModified Σ 0..1 instant Element idBundle.entry.response.lastModified
Short description Server's date time modified
Definition The date/time that the resource was modified on the server.
Comments This has to match the same time in the meta header if a resource is included.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
outcome Σ 0..1 Resource Element idBundle.entry.response.outcome
Short description OperationOutcome with hints and warnings (for batch/transaction)
Definition An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.
Comments For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
Data type Mappings- rim: Entity. Role, or Act
signature Σ 0..1 Signature Element idBundle.signature
Short description Digital Signature
Definition Digital Signature - base64 encoded. XML-DSIg or a JWT.
Requirements This element allows capturing signatures on documents. It also allows signatures on messages, transactions or even query responses. It may support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.
Comments The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.
Data type Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
| Bundle | I | Bundle | Element idBundle Contains a collection of resources DefinitionA container for a collection of resources.
| |
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idBundle.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
|
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idBundle.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idBundle.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language. CommonLanguages (extensible)Constraints
| |
| identifier | Σ | 0..1 | Identifier | Element idBundle.identifier Persistent identifier for the bundle DefinitionA persistent identifier for the batch that won't change as a batch is copied from server to server. Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results, and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.
|
| type | Σ | 1..1 | codeBinding | Element idBundle.type document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection DefinitionIndicates the purpose of this bundle - how it was intended to be used. 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. Indicates the purpose of a bundle - how it was intended to be used. BundleType (required)Constraints
|
| total | Σ I | 0..1 | unsignedInt | Element idBundle.total If search, the total number of matches DefinitionIf 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). Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.
|
| link | Σ | 0..* | BackboneElement | Element idBundle.link Links related to this Bundle DefinitionA series of links that provide context to this bundle.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.link.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.link.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.link.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| relation | Σ | 1..1 | string | Element idBundle.link.relation See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 DefinitionA name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1. Note that FHIR strings may not exceed 1MB in size
|
| url | Σ | 1..1 | uri | Element idBundle.link.url Reference details for the link DefinitionThe reference details for the link. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
| entry | Σ I | 0..* | BackboneElement | Element idBundle.entry Entry in the bundle - will have a resource, or information DefinitionAn entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| link | Σ | 0..* | see (link) | There are no (further) constraints on this element Element idBundle.entry.link Links related to this entry DefinitionA series of links that provide context to this entry. |
| fullUrl | Σ | 0..1 | uri | Element idBundle.entry.fullUrl Absolute URL for resource (server address, or UUID/OID) DefinitionThe Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
fullUrl may not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the absolute URL may not end with the logical id of the resource (Resource.id), but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then it SHALL end with the Resource.id.
|
| resource | Σ | 0..1 | Resource | Element idBundle.entry.resource A resource in the bundle DefinitionThe Resources for the entry.
|
| search | Σ I | 0..1 | BackboneElement | Element idBundle.entry.search Search related information DefinitionInformation about the search process that lead to the creation of this entry.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.search.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.search.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.search.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| mode | Σ | 0..1 | codeBinding | Element idBundle.entry.search.mode match | include | outcome - why this is in the result set DefinitionWhy this entry is in the result set - whether it's included as a match or because of an _include requirement. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Why an entry is in the result set - whether it's included as a match or because of an _include requirement. SearchEntryMode (required)Constraints
|
| score | Σ | 0..1 | decimal | Element idBundle.entry.search.score Search ranking (between 0 and 1) DefinitionWhen searching, the server's search ranking score for the entry. 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.
|
| request | Σ I | 0..1 | BackboneElement | Element idBundle.entry.request Transaction Related Information DefinitionAdditional information about how this entry should be processed as part of a transaction.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.request.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.request.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| method | Σ | 1..1 | codeBinding | Element idBundle.entry.request.method GET | POST | PUT | DELETE DefinitionThe HTTP verb for this entry in either a change history, or a transaction/ transaction response. Note that FHIR strings may not exceed 1MB in size HTTP verbs (in the HTTP command line). HTTPVerb (required)Constraints
|
| url | Σ | 1..1 | uri | Element idBundle.entry.request.url URL for HTTP equivalent of this entry DefinitionThe URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT, and the URL would be "Patient/[id]".
|
| ifNoneMatch | Σ | 0..1 | string | Element idBundle.entry.request.ifNoneMatch For managing cache currency DefinitionIf the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". Note that FHIR strings may not exceed 1MB in size
|
| ifModifiedSince | Σ | 0..1 | instant | Element idBundle.entry.request.ifModifiedSince For managing update contention DefinitionOnly perform the operation if the last updated date matches. See the API documentation for "Conditional Read". Note: This is intended for precisely observed times, typically system logs etc., and not human-reported times - for them, see date and dateTime below. Time zone is always required
|
| ifMatch | Σ | 0..1 | string | Element idBundle.entry.request.ifMatch For managing update contention DefinitionOnly perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". Note that FHIR strings may not exceed 1MB in size
|
| ifNoneExist | Σ | 0..1 | string | Element idBundle.entry.request.ifNoneExist For conditional creates DefinitionInstruct 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 "?"). Note that FHIR strings may not exceed 1MB in size
|
| response | Σ I | 0..1 | BackboneElement | Element idBundle.entry.response Transaction Related Information DefinitionAdditional information about how this entry should be processed as part of a transaction.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.response.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.response.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| status | Σ | 1..1 | string | Element idBundle.entry.response.status Status response code (text optional) DefinitionThe 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. Note that FHIR strings may not exceed 1MB in size
|
| location | Σ | 0..1 | uri | Element idBundle.entry.response.location The location, if the operation returns a location DefinitionThe location header created by processing this operation. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
| etag | Σ | 0..1 | string | Element idBundle.entry.response.etag The etag for the resource (if relevant) DefinitionThe etag for the resource, it the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.
|
| lastModified | Σ | 0..1 | instant | Element idBundle.entry.response.lastModified Server's date time modified DefinitionThe date/time that the resource was modified on the server. This has to match the same time in the meta header if a resource is included.
|
| outcome | Σ | 0..1 | Resource | Element idBundle.entry.response.outcome OperationOutcome with hints and warnings (for batch/transaction) DefinitionAn OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
|
| signature | Σ | 0..1 | Signature | Element idBundle.signature Digital Signature DefinitionDigital Signature - base64 encoded. XML-DSIg or a JWT. This element allows capturing signatures on documents. It also allows signatures on messages, transactions or even query responses. It may support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient. The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.
|