This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions
FHIR Infrastructure Work Group | Maturity Level: 0 | Informative | Use Context: Any |
Definitions for the search-set-bundle Profile.
Bundle | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | A container for a collection of resources. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Contains a collection of resources | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Logical id of this artifact | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.meta | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.meta | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Metadata about the resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Meta | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.implicitRules | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.implicitRules | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | A set of rules under which this content was created | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Modifier | true (Reason: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.language | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.language | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The base language in which the resource is written. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Language of the resource content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | IETF language tag for a human language The codes SHALL be taken from All Languages | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.identifier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | A persistent identifier for the bundle that won't change as a bundle is copied from server to server. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Persistent identifier for the bundle | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: bdl-9 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Indicates the purpose of this bundle - how it is intended to be used. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 This element is affected by the following invariants: bdl-1, bdl-2, bdl-3a, bdl-3b, bdl-3c, bdl-3d, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-17, bdl-18 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Indicates the purpose of a bundle - how it is intended to be used. The codes SHALL be taken from Bundle Type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Pattern Value | searchset | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.timestamp | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.timestamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | When the bundle was assembled | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: bdl-10 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | instant | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated. Usage:
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.total | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.total | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | If a set of search matches, this is the (potentially estimated) 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | If search, the total number of matches | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: bdl-1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | unsignedInt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.link | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.link | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | A series of links that provide context to this bundle. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Links related to this Bundle | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* This element is affected by the following invariants: bdl-18 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS ). Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly. This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.link.id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.link.id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.link.extension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.link.extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | May 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 managable, 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.link.modifierExtension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.link.modifierExtension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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 managable, 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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.link.relation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | 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#link-relations-1 . | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 This element is affected by the following invariants: bdl-18 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | null The codes SHALL be taken from Link Relation Types | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.link.url | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.link.url | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The reference details for the link. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Reference details for the link | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 This element is affected by the following invariants: bdl-18 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Entry in the bundle - will have a resource or information | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Order Meaning | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.extension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | May 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 managable, 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.modifierExtension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.modifierExtension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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 managable, 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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.link | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.link | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | A series of links that provide context to this entry. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Links related to this entry | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.fullUrl | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.fullUrl | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. 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. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: bdl-7, bdl-15, bdl-8 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | fullUrl might 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 fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.resource | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | A resource in the bundle | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.search | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Information about the search process that lead to the creation of this entry. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Search related information | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: bdl-2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search.id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.search.id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search.extension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.search.extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | May 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 managable, 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search.modifierExtension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.search.modifierExtension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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 managable, 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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search.mode | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | 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, or to convey information or warning information about the search process. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | match | include - why this is in the result set | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Why an 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. The codes SHALL be taken from Search Entry Mode | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search.score | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.search.score | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | When searching, the server's search ranking score for the entry. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Search ranking (between 0 and 1) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | decimal | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. See Patient Match for the EMPI search which relates to this element. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.request | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Additional 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Additional execution information (transaction/batch/history) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-5 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.request.id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.extension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.request.extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | May 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 managable, 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.modifierExtension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.request.modifierExtension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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 managable, 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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.method | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.request.method | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | In 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | GET | HEAD | POST | PUT | DELETE | PATCH | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 This element is affected by the following invariants: bdl-3b, bdl-3c, bdl-14, bdl-15 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details. The codes SHALL be taken from H T T P Verb | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.url | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.request.url | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | URL for HTTP equivalent of this entry | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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]". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.ifNoneMatch | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.request.ifNoneMatch | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | For managing cache validation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.ifModifiedSince | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.request.ifModifiedSince | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | For managing cache currency | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | instant | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.ifMatch | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.request.ifMatch | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | For managing update contention | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.ifNoneExist | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.request.ifNoneExist | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 "?"). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | For conditional creates | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Indicates 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Results of execution (transaction/batch/history) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3d, bdl-5 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.response.id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.extension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.response.extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | May 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 managable, 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.modifierExtension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.response.modifierExtension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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 managable, 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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.status | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.response.status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Status response code (text optional) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.location | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.response.location | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The location header created by processing this operation, populated if the operation returns a location. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | The location (if the operation returns a location) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.etag | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.response.etag | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | The Etag for the resource (if relevant) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.lastModified | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.response.lastModified | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The date/time that the resource was modified on the server. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Server's date time modified | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | instant | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.outcome | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry.response.outcome | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry(operationOutcome) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Entry in the bundle - will have a resource or information | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Order Meaning | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.extension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | May 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 managable, 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.modifierExtension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.modifierExtension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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 managable, 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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.link | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.link | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | A series of links that provide context to this entry. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Links related to this entry | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.fullUrl | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.fullUrl | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. 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. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 This element is affected by the following invariants: bdl-7, bdl-15, bdl-8 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | fullUrl might 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 fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.resource | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | A resource in the bundle | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | OperationOutcome | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.search | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Information about the search process that lead to the creation of this entry. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Search related information | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: bdl-2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search.id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.search.id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search.extension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.search.extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | May 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 managable, 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search.modifierExtension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.search.modifierExtension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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 managable, 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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search.mode | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.search.mode | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Why 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | match | include - why this is in the result set | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Why an 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. The codes SHALL be taken from Search Entry Mode | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Pattern Value | outcome | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search.score | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.search.score | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | When searching, the server's search ranking score for the entry. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Search ranking (between 0 and 1) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | decimal | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. See Patient Match for the EMPI search which relates to this element. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.request | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Additional 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Additional execution information (transaction/batch/history) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..0 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-5 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.request.id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.extension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.request.extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | May 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 managable, 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.modifierExtension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.request.modifierExtension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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 managable, 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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.method | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.request.method | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | In 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | GET | HEAD | POST | PUT | DELETE | PATCH | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 This element is affected by the following invariants: bdl-3b, bdl-3c, bdl-14, bdl-15 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details. The codes SHALL be taken from H T T P Verb | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.url | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.request.url | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | URL for HTTP equivalent of this entry | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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]". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.ifNoneMatch | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.request.ifNoneMatch | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | For managing cache validation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.ifModifiedSince | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.request.ifModifiedSince | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | For managing cache currency | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | instant | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.ifMatch | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.request.ifMatch | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | For managing update contention | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.ifNoneExist | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.request.ifNoneExist | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 "?"). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | For conditional creates | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Indicates 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Results of execution (transaction/batch/history) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..0 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3d, bdl-5 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.response.id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.extension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.response.extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | May 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 managable, 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.modifierExtension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.response.modifierExtension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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 managable, 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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.status | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.response.status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Status response code (text optional) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.location | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.response.location | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The location header created by processing this operation, populated if the operation returns a location. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | The location (if the operation returns a location) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.etag | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.response.etag | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | The Etag for the resource (if relevant) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.lastModified | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.response.lastModified | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The date/time that the resource was modified on the server. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Server's date time modified | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | instant | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.outcome | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:operationOutcome.response.outcome | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry(other) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Entry in the bundle - will have a resource or information | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Order Meaning | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.extension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | May 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 managable, 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.modifierExtension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.modifierExtension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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 managable, 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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.link | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.link | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | A series of links that provide context to this entry. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Links related to this entry | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.fullUrl | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.fullUrl | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. 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. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 This element is affected by the following invariants: bdl-7, bdl-15, bdl-8 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | fullUrl might 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 fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.resource | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | A resource in the bundle | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.search | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Information about the search process that lead to the creation of this entry. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Search related information | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: bdl-2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search.id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.search.id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search.extension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.search.extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | May 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 managable, 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search.modifierExtension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.search.modifierExtension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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 managable, 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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search.mode | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.search.mode | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Why 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | match | include - why this is in the result set | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Why an 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. The codes SHALL be taken from Search Entry Mode | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.search.score | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.search.score | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | When searching, the server's search ranking score for the entry. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Search ranking (between 0 and 1) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | decimal | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. See Patient Match for the EMPI search which relates to this element. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.request | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Additional 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Additional execution information (transaction/batch/history) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..0 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-5 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.request.id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.extension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.request.extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | May 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 managable, 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.modifierExtension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.request.modifierExtension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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 managable, 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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.method | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.request.method | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | In 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | GET | HEAD | POST | PUT | DELETE | PATCH | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 This element is affected by the following invariants: bdl-3b, bdl-3c, bdl-14, bdl-15 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details. The codes SHALL be taken from H T T P Verb | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.url | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.request.url | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The URL for this entry, relative to the root (the address to which the request is posted). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | URL for HTTP equivalent of this entry | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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]". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.ifNoneMatch | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.request.ifNoneMatch | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | For managing cache validation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.ifModifiedSince | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.request.ifModifiedSince | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | For managing cache currency | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | instant | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.ifMatch | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.request.ifMatch | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | For managing update contention | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.request.ifNoneExist | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.request.ifNoneExist | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 "?"). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | For conditional creates | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Indicates 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Results of execution (transaction/batch/history) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..0 This element is affected by the following invariants: bdl-3a, bdl-3b, bdl-3d, bdl-5 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.response.id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.extension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.response.extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | May 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 managable, 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.modifierExtension | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.response.modifierExtension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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 managable, 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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.status | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.response.status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Status response code (text optional) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.location | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.response.location | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The location header created by processing this operation, populated if the operation returns a location. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | The location (if the operation returns a location) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.etag | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.response.etag | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | The Etag for the resource (if relevant) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.lastModified | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.response.lastModified | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The date/time that the resource was modified on the server. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Server's date time modified | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | instant | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.entry.response.outcome | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.entry:other.response.outcome | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | OperationOutcome with hints and warnings (for batch/transaction) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.signature | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.signature | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Digital Signature - base64 encoded. XML-DSig or a JWS. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Digital Signature | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Signature | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bundle.issues | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Bundle.issues | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Captures issues and warnings that relate to the construction of the Bundle and the content within it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Issues with the Bundle | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: bdl-16, bdl-17 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Resource(OperationOutcome) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle. |