Ontario Health HL7® FHIR® Subscription Implementation Guide - v1.0.0

Profiles & Operations > Profile: Subscription Notification Bundle

Profile: Subscription Notification Bundle

The Subscription Notification Bundle resource is used by the server to notify a subscription client of available content, for example, HealthcareService or DiagnosticReport resourcesthat have been created or updated.

In order to align with the use of FHIR R4 at OntarioHealth, Subscription Notification Bundles are expected to conform to the Bundle profile defined by the Subscriptions R5 Backport Implementation Guide.

This profile provides guidance for implementing FHIR R5 Bundle resource features & elements using FHIR R4.

Simplifier project page: R4B Topic-Based Subscription Notification Bundle

Derived from: Subscription R5 Backport

Canonical_URL	Profile_Status	Profile_Version	FHIR_Version
http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification	active	1.2.0-ballot	4.3.0

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work

Differential View

BackportSubscriptionNotificationR4 (Bundle)

Bundle

Element id

Bundle

Short description

Contains a collection of resources

Definition

A container for a collection of resources.

Data type

Bundle

Constraints

bdl-1: total only when a search or history
total.empty() or (type = 'searchset') or (type = 'history')
bdl-2: entry.search only when a search
entry.search.empty() or (type = 'searchset')
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-9: A document must have an identifier with a system and a value
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10: A document must have a date
type = 'document' implies (timestamp.hasValue())
bdl-11: A document must have a Composition as the first resource
type = 'document' implies entry.first().resource.is(Composition)
bdl-12: A message must have a MessageHeader as the first resource
type = 'message' implies entry.first().resource.is(MessageHeader)
backport-notification-bundle-r4-1: A notification bundle MUST have a Parameters as the first entry
(entry.first().resource.is(Parameters))

Mappings

rim: Entity. Role, or Act
v2: N/A
rim: N/A
cda: ClinicalDocument, if bundle.type = document

0..1

string

There are no (further) constraints on this element

Element id

Bundle.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

string

Meta

There are no (further) constraints on this element

Element id

Bundle.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

uri

There are no (further) constraints on this element

Element id

Bundle.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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 it's narrative along with other profiles, value sets, etc.

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

identifier

0..1

Identifier

There are no (further) constraints on this element

Element id

Bundle.identifier

Short description

Persistent identifier for the bundle

Definition

A persistent identifier for the bundle that won't change as a bundle is copied from server to server.

Comments

Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.

Data type

Identifier

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.identifier
cda: ClinicalDocument.id

type

1..1

codeBindingPattern

Element id

Bundle.type

Short description

Definition

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

Comments

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

Data type

code

Binding

Indicates the purpose of a bundle - how it is intended to be used.

BundleType (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

history

Mappings

w5: FiveWs.class

timestamp

0..1

instant

There are no (further) constraints on this element

Element id

Bundle.timestamp

Short description

When the bundle was assembled

Definition

The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

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:

document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning

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.

Data type

instant

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.init
cda: ClinicalDocument.effectiveTime

total

Σ C

0..1

unsignedInt

There are no (further) constraints on this element

Element id

Bundle.total

Short description

If search, the total number of matches

Definition

If a set of search matches, this is the 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.

Comments

Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.

Data type

unsignedInt

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

link

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.link

Short description

Links related to this Bundle

Definition

A series of links that provide context to this bundle.

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.

Data type

BackboneElement

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.link.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.link.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.link.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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 manageable, 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).

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.

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

relation

1..1

string

There are no (further) constraints on this element

Element id

Bundle.link.relation

Short description

See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1

Definition

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

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

uri

There are no (further) constraints on this element

Element id

Bundle.link.url

Short description

Reference details for the link

Definition

The reference details for the link.

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

entry

Σ C

1..*

BackboneElement

Element id

Bundle.entry

Short description

Entry in the bundle - will have a resource or information

Definition

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

Data type

BackboneElement

Slicing

Unordered, Open, by resource(Type)

Slice based on resource

Constraints

bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists()
bdl-8: fullUrl cannot be a version specific reference
fullUrl.contains('/_history/').not()
ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

(All Slices)

The requirements in this element apply to all slices

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

link

0..*

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

fullUrl

0..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry.fullUrl

Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that:

fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
Results from operations might involve resources that are not identified.

Comments

fullUrl 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).

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

resource

0..1

Resource

There are no (further) constraints on this element

Element id

Bundle.entry.resource

Short description

A resource in the bundle

Definition

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

Data type

Resource

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry.search

Short description

Search related information

Definition

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

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.search.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.search.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.search.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry.search.mode

Short description

match | include | outcome - why this is in the result set

Definition

Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

Comments

There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

Data type

code

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.

SearchEntryMode (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

score

0..1

decimal

There are no (further) constraints on this element

Element id

Bundle.entry.search.score

Short description

Search ranking (between 0 and 1)

Definition

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

Comments

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

See Patient Match for the EMPI search which relates to this element.

Data type

decimal

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

request

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry.request

Short description

Additional execution information (transaction/batch/history)

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.request.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.request.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.request.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

method

1..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry.request.method

Short description

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.

Data type

code

Binding

HTTP verbs (in the HTTP command line). See HTTP rfc for details.

HTTPVerb (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry.request.url

Short description

URL for HTTP equivalent of this entry

Definition

The URL for this entry, relative to the root (the address to which the request is posted).

Comments

E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneMatch

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.request.ifNoneMatch

Short description

For managing cache currency

Definition

If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifModifiedSince

0..1

instant

There are no (further) constraints on this element

Element id

Bundle.entry.request.ifModifiedSince

Short description

For managing cache currency

Definition

Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

Data type

instant

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifMatch

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.request.ifMatch

Short description

For managing update contention

Definition

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

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneExist

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.request.ifNoneExist

Short description

For conditional creates

Definition

Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?").

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

response

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry.response

Short description

Results of execution (transaction/batch/history)

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-4

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.response.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.response.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.response.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

status

1..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.response.status

Short description

Status response code (text optional)

Definition

The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

location

0..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry.response.location

Short description

The location (if the operation returns a location)

Definition

The location header created by processing this operation, populated if the operation returns a location.

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

etag

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.response.etag

Short description

The Etag for the resource (if relevant)

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).

Comments

Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

lastModified

0..1

instant

There are no (further) constraints on this element

Element id

Bundle.entry.response.lastModified

Short description

Server's date time modified

Definition

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

Comments

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

Data type

instant

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

outcome

0..1

Resource

There are no (further) constraints on this element

Element id

Bundle.entry.response.outcome

Short description

OperationOutcome with hints and warnings (for batch/transaction)

Definition

An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

Comments

For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

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.

Data type

Resource

subscriptionStatus

S Σ C

1..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus

Short description

Entry in the bundle - will have a resource or information

Definition

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

Data type

BackboneElement

Constraints

bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists()
bdl-8: fullUrl cannot be a version specific reference
fullUrl.contains('/_history/').not()
ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

link

0..*

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

fullUrl

0..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.fullUrl

Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
Results from operations might involve resources that are not identified.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

resource

1..1

BackportSubscriptionStatusR4

Element id

Bundle.entry:subscriptionStatus.resource

Short description

Parameter containing subscription status information

Definition

This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it.

Comments

The parameters that may be used are defined by the OperationDefinition resource.

Data type

BackportSubscriptionStatusR4

Mappings

rim: Entity. Role, or Act
v2: n/a
rim: n/a
w5: infrastructure.exchange

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search

Short description

Search related information

Definition

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

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search.mode

Short description

match | include | outcome - why this is in the result set

Definition

Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

Comments

There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

Data type

code

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.

SearchEntryMode (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

score

0..1

decimal

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search.score

Short description

Search ranking (between 0 and 1)

Definition

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

Comments

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

See Patient Match for the EMPI search which relates to this element.

Data type

decimal

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

request

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request

Short description

Additional execution information (transaction/batch/history)

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

method

1..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.method

Short description

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.

Data type

code

Binding

HTTP verbs (in the HTTP command line). See HTTP rfc for details.

HTTPVerb (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.url

Short description

URL for HTTP equivalent of this entry

Definition

The URL for this entry, relative to the root (the address to which the request is posted).

Comments

E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneMatch

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.ifNoneMatch

Short description

For managing cache currency

Definition

If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifModifiedSince

0..1

instant

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.ifModifiedSince

Short description

For managing cache currency

Definition

Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

Data type

instant

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifMatch

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.ifMatch

Short description

For managing update contention

Definition

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

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneExist

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.ifNoneExist

Short description

For conditional creates

Definition

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

response

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response

Short description

Results of execution (transaction/batch/history)

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-4

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

status

1..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.status

Short description

Status response code (text optional)

Definition

The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

location

0..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.location

Short description

The location (if the operation returns a location)

Definition

The location header created by processing this operation, populated if the operation returns a location.

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

etag

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.etag

Short description

The Etag for the resource (if relevant)

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).

Comments

Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

lastModified

0..1

instant

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.lastModified

Short description

Server's date time modified

Definition

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

Comments

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

Data type

instant

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

outcome

0..1

Resource

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.outcome

Short description

OperationOutcome with hints and warnings (for batch/transaction)

Definition

An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

Comments

For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

Data type

Resource

signature

0..1

Signature

There are no (further) constraints on this element

Element id

Bundle.signature

Short description

Digital Signature

Definition

Digital Signature - base64 encoded. XML-DSig or a JWT.

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.

Data type

Signature

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Hybrid View

BackportSubscriptionNotificationR4 (Bundle)

Bundle

Element id

Bundle

Short description

Contains a collection of resources

Definition

A container for a collection of resources.

Data type

Bundle

Constraints

bdl-1: total only when a search or history
total.empty() or (type = 'searchset') or (type = 'history')
bdl-2: entry.search only when a search
entry.search.empty() or (type = 'searchset')
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-9: A document must have an identifier with a system and a value
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10: A document must have a date
type = 'document' implies (timestamp.hasValue())
bdl-11: A document must have a Composition as the first resource
type = 'document' implies entry.first().resource.is(Composition)
bdl-12: A message must have a MessageHeader as the first resource
type = 'message' implies entry.first().resource.is(MessageHeader)
backport-notification-bundle-r4-1: A notification bundle MUST have a Parameters as the first entry
(entry.first().resource.is(Parameters))

Mappings

rim: Entity. Role, or Act
v2: N/A
rim: N/A
cda: ClinicalDocument, if bundle.type = document

0..1

string

There are no (further) constraints on this element

Element id

Bundle.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

string

Meta

There are no (further) constraints on this element

Element id

Bundle.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

uri

There are no (further) constraints on this element

Element id

Bundle.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

identifier

0..1

Identifier

There are no (further) constraints on this element

Element id

Bundle.identifier

Short description

Persistent identifier for the bundle

Definition

A persistent identifier for the bundle that won't change as a bundle is copied from server to server.

Comments

Data type

Identifier

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.identifier
cda: ClinicalDocument.id

type

1..1

codeBindingPattern

Element id

Bundle.type

Short description

Definition

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

Comments

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

Data type

code

Binding

Indicates the purpose of a bundle - how it is intended to be used.

BundleType (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

history

Mappings

w5: FiveWs.class

timestamp

0..1

instant

There are no (further) constraints on this element

Element id

Bundle.timestamp

Short description

When the bundle was assembled

Definition

The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

Comments

Usage:

document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning

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.

Data type

instant

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.init
cda: ClinicalDocument.effectiveTime

total

Σ C

0..1

unsignedInt

There are no (further) constraints on this element

Element id

Bundle.total

Short description

If search, the total number of matches

Definition

Comments

Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.

Data type

unsignedInt

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

link

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.link

Short description

Links related to this Bundle

Definition

A series of links that provide context to this bundle.

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.

Data type

BackboneElement

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.link.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.link.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.link.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

relation

1..1

string

There are no (further) constraints on this element

Element id

Bundle.link.relation

Short description

See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1

Definition

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

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

uri

There are no (further) constraints on this element

Element id

Bundle.link.url

Short description

Reference details for the link

Definition

The reference details for the link.

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

entry

Σ C

1..*

BackboneElement

Element id

Bundle.entry

Short description

Entry in the bundle - will have a resource or information

Definition

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

Data type

BackboneElement

Slicing

Unordered, Open, by resource(Type)

Slice based on resource

Constraints

bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists()
bdl-8: fullUrl cannot be a version specific reference
fullUrl.contains('/_history/').not()
ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

(All Slices)

The requirements in this element apply to all slices

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

link

0..*

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

fullUrl

0..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry.fullUrl

Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
Results from operations might involve resources that are not identified.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

resource

0..1

Resource

There are no (further) constraints on this element

Element id

Bundle.entry.resource

Short description

A resource in the bundle

Definition

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

Data type

Resource

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry.search

Short description

Search related information

Definition

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

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.search.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.search.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.search.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry.search.mode

Short description

match | include | outcome - why this is in the result set

Definition

Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

Comments

There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

Data type

code

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.

SearchEntryMode (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

score

0..1

decimal

There are no (further) constraints on this element

Element id

Bundle.entry.search.score

Short description

Search ranking (between 0 and 1)

Definition

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

Comments

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

See Patient Match for the EMPI search which relates to this element.

Data type

decimal

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

request

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry.request

Short description

Additional execution information (transaction/batch/history)

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.request.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.request.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.request.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

method

1..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry.request.method

Short description

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.

Data type

code

Binding

HTTP verbs (in the HTTP command line). See HTTP rfc for details.

HTTPVerb (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry.request.url

Short description

URL for HTTP equivalent of this entry

Definition

The URL for this entry, relative to the root (the address to which the request is posted).

Comments

E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneMatch

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.request.ifNoneMatch

Short description

For managing cache currency

Definition

If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifModifiedSince

0..1

instant

There are no (further) constraints on this element

Element id

Bundle.entry.request.ifModifiedSince

Short description

For managing cache currency

Definition

Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

Data type

instant

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifMatch

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.request.ifMatch

Short description

For managing update contention

Definition

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

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneExist

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.request.ifNoneExist

Short description

For conditional creates

Definition

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

response

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry.response

Short description

Results of execution (transaction/batch/history)

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-4

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.response.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.response.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.response.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

status

1..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.response.status

Short description

Status response code (text optional)

Definition

The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

location

0..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry.response.location

Short description

The location (if the operation returns a location)

Definition

The location header created by processing this operation, populated if the operation returns a location.

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

etag

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.response.etag

Short description

The Etag for the resource (if relevant)

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).

Comments

Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

lastModified

0..1

instant

There are no (further) constraints on this element

Element id

Bundle.entry.response.lastModified

Short description

Server's date time modified

Definition

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

Comments

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

Data type

instant

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

outcome

0..1

Resource

There are no (further) constraints on this element

Element id

Bundle.entry.response.outcome

Short description

OperationOutcome with hints and warnings (for batch/transaction)

Definition

An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

Comments

For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

Data type

Resource

subscriptionStatus

S Σ C

1..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus

Short description

Entry in the bundle - will have a resource or information

Definition

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

Data type

BackboneElement

Constraints

bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists()
bdl-8: fullUrl cannot be a version specific reference
fullUrl.contains('/_history/').not()
ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

link

0..*

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

fullUrl

0..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.fullUrl

Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
Results from operations might involve resources that are not identified.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

resource

1..1

BackportSubscriptionStatusR4

Element id

Bundle.entry:subscriptionStatus.resource

Short description

Parameter containing subscription status information

Definition

This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it.

Comments

The parameters that may be used are defined by the OperationDefinition resource.

Data type

BackportSubscriptionStatusR4

Mappings

rim: Entity. Role, or Act
v2: n/a
rim: n/a
w5: infrastructure.exchange

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search

Short description

Search related information

Definition

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

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search.mode

Short description

match | include | outcome - why this is in the result set

Definition

Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

Comments

There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

Data type

code

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.

SearchEntryMode (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

score

0..1

decimal

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search.score

Short description

Search ranking (between 0 and 1)

Definition

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

Comments

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

See Patient Match for the EMPI search which relates to this element.

Data type

decimal

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

request

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request

Short description

Additional execution information (transaction/batch/history)

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

method

1..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.method

Short description

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.

Data type

code

Binding

HTTP verbs (in the HTTP command line). See HTTP rfc for details.

HTTPVerb (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.url

Short description

URL for HTTP equivalent of this entry

Definition

The URL for this entry, relative to the root (the address to which the request is posted).

Comments

E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneMatch

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.ifNoneMatch

Short description

For managing cache currency

Definition

If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifModifiedSince

0..1

instant

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.ifModifiedSince

Short description

For managing cache currency

Definition

Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

Data type

instant

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifMatch

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.ifMatch

Short description

For managing update contention

Definition

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

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneExist

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.ifNoneExist

Short description

For conditional creates

Definition

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

response

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response

Short description

Results of execution (transaction/batch/history)

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-4

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

status

1..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.status

Short description

Status response code (text optional)

Definition

The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

location

0..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.location

Short description

The location (if the operation returns a location)

Definition

The location header created by processing this operation, populated if the operation returns a location.

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

etag

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.etag

Short description

The Etag for the resource (if relevant)

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).

Comments

Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

lastModified

0..1

instant

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.lastModified

Short description

Server's date time modified

Definition

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

Comments

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

Data type

instant

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

outcome

0..1

Resource

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.outcome

Short description

OperationOutcome with hints and warnings (for batch/transaction)

Definition

An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

Comments

For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

Data type

Resource

signature

0..1

Signature

There are no (further) constraints on this element

Element id

Bundle.signature

Short description

Digital Signature

Definition

Digital Signature - base64 encoded. XML-DSig or a JWT.

Requirements

Comments

Data type

Signature

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Snapshot View

BackportSubscriptionNotificationR4 (Bundle)

Bundle

Element id

Bundle

Short description

Contains a collection of resources

Definition

A container for a collection of resources.

Data type

Bundle

Constraints

bdl-1: total only when a search or history
total.empty() or (type = 'searchset') or (type = 'history')
bdl-2: entry.search only when a search
entry.search.empty() or (type = 'searchset')
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-9: A document must have an identifier with a system and a value
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10: A document must have a date
type = 'document' implies (timestamp.hasValue())
bdl-11: A document must have a Composition as the first resource
type = 'document' implies entry.first().resource.is(Composition)
bdl-12: A message must have a MessageHeader as the first resource
type = 'message' implies entry.first().resource.is(MessageHeader)
backport-notification-bundle-r4-1: A notification bundle MUST have a Parameters as the first entry
(entry.first().resource.is(Parameters))

Mappings

rim: Entity. Role, or Act
v2: N/A
rim: N/A
cda: ClinicalDocument, if bundle.type = document

0..1

string

There are no (further) constraints on this element

Element id

Bundle.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

string

Meta

There are no (further) constraints on this element

Element id

Bundle.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

uri

There are no (further) constraints on this element

Element id

Bundle.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

identifier

0..1

Identifier

There are no (further) constraints on this element

Element id

Bundle.identifier

Short description

Persistent identifier for the bundle

Definition

A persistent identifier for the bundle that won't change as a bundle is copied from server to server.

Comments

Data type

Identifier

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.identifier
cda: ClinicalDocument.id

type

1..1

codeBindingPattern

Element id

Bundle.type

Short description

Definition

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

Comments

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

Data type

code

Binding

Indicates the purpose of a bundle - how it is intended to be used.

BundleType (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

history

Mappings

w5: FiveWs.class

timestamp

0..1

instant

There are no (further) constraints on this element

Element id

Bundle.timestamp

Short description

When the bundle was assembled

Definition

The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

Comments

Usage:

document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning

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.

Data type

instant

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.init
cda: ClinicalDocument.effectiveTime

total

Σ C

0..1

unsignedInt

There are no (further) constraints on this element

Element id

Bundle.total

Short description

If search, the total number of matches

Definition

Comments

Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.

Data type

unsignedInt

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

link

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.link

Short description

Links related to this Bundle

Definition

A series of links that provide context to this bundle.

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.

Data type

BackboneElement

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.link.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.link.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.link.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

relation

1..1

string

There are no (further) constraints on this element

Element id

Bundle.link.relation

Short description

See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1

Definition

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

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

uri

There are no (further) constraints on this element

Element id

Bundle.link.url

Short description

Reference details for the link

Definition

The reference details for the link.

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

entry

Σ C

1..*

BackboneElement

Element id

Bundle.entry

Short description

Entry in the bundle - will have a resource or information

Definition

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

Data type

BackboneElement

Slicing

Unordered, Open, by resource(Type)

Slice based on resource

Constraints

bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists()
bdl-8: fullUrl cannot be a version specific reference
fullUrl.contains('/_history/').not()
ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

(All Slices)

The requirements in this element apply to all slices

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

link

0..*

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

fullUrl

0..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry.fullUrl

Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
Results from operations might involve resources that are not identified.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

resource

0..1

Resource

There are no (further) constraints on this element

Element id

Bundle.entry.resource

Short description

A resource in the bundle

Definition

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

Data type

Resource

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry.search

Short description

Search related information

Definition

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

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.search.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.search.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.search.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry.search.mode

Short description

match | include | outcome - why this is in the result set

Definition

Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

Comments

There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

Data type

code

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.

SearchEntryMode (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

score

0..1

decimal

There are no (further) constraints on this element

Element id

Bundle.entry.search.score

Short description

Search ranking (between 0 and 1)

Definition

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

Comments

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

See Patient Match for the EMPI search which relates to this element.

Data type

decimal

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

request

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry.request

Short description

Additional execution information (transaction/batch/history)

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.request.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.request.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.request.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

method

1..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry.request.method

Short description

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.

Data type

code

Binding

HTTP verbs (in the HTTP command line). See HTTP rfc for details.

HTTPVerb (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry.request.url

Short description

URL for HTTP equivalent of this entry

Definition

The URL for this entry, relative to the root (the address to which the request is posted).

Comments

E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneMatch

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.request.ifNoneMatch

Short description

For managing cache currency

Definition

If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifModifiedSince

0..1

instant

There are no (further) constraints on this element

Element id

Bundle.entry.request.ifModifiedSince

Short description

For managing cache currency

Definition

Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

Data type

instant

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifMatch

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.request.ifMatch

Short description

For managing update contention

Definition

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

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneExist

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.request.ifNoneExist

Short description

For conditional creates

Definition

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

response

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry.response

Short description

Results of execution (transaction/batch/history)

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-4

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.response.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.response.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.response.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

status

1..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.response.status

Short description

Status response code (text optional)

Definition

The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

location

0..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry.response.location

Short description

The location (if the operation returns a location)

Definition

The location header created by processing this operation, populated if the operation returns a location.

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

etag

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.response.etag

Short description

The Etag for the resource (if relevant)

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).

Comments

Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

lastModified

0..1

instant

There are no (further) constraints on this element

Element id

Bundle.entry.response.lastModified

Short description

Server's date time modified

Definition

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

Comments

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

Data type

instant

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

outcome

0..1

Resource

There are no (further) constraints on this element

Element id

Bundle.entry.response.outcome

Short description

OperationOutcome with hints and warnings (for batch/transaction)

Definition

An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

Comments

For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

Data type

Resource

subscriptionStatus

S Σ C

1..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus

Short description

Entry in the bundle - will have a resource or information

Definition

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

Data type

BackboneElement

Constraints

bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists()
bdl-8: fullUrl cannot be a version specific reference
fullUrl.contains('/_history/').not()
ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

link

0..*

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

fullUrl

0..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.fullUrl

Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
Results from operations might involve resources that are not identified.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

resource

1..1

BackportSubscriptionStatusR4

Element id

Bundle.entry:subscriptionStatus.resource

Short description

Parameter containing subscription status information

Definition

This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it.

Comments

The parameters that may be used are defined by the OperationDefinition resource.

Data type

BackportSubscriptionStatusR4

Mappings

rim: Entity. Role, or Act
v2: n/a
rim: n/a
w5: infrastructure.exchange

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search

Short description

Search related information

Definition

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

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search.mode

Short description

match | include | outcome - why this is in the result set

Definition

Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

Comments

There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

Data type

code

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.

SearchEntryMode (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

score

0..1

decimal

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.search.score

Short description

Search ranking (between 0 and 1)

Definition

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

Comments

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

See Patient Match for the EMPI search which relates to this element.

Data type

decimal

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

request

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request

Short description

Additional execution information (transaction/batch/history)

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

method

1..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.method

Short description

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.

Data type

code

Binding

HTTP verbs (in the HTTP command line). See HTTP rfc for details.

HTTPVerb (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.url

Short description

URL for HTTP equivalent of this entry

Definition

The URL for this entry, relative to the root (the address to which the request is posted).

Comments

E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneMatch

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.ifNoneMatch

Short description

For managing cache currency

Definition

If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifModifiedSince

0..1

instant

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.ifModifiedSince

Short description

For managing cache currency

Definition

Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

Data type

instant

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifMatch

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.ifMatch

Short description

For managing update contention

Definition

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

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneExist

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.request.ifNoneExist

Short description

For conditional creates

Definition

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

response

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response

Short description

Results of execution (transaction/batch/history)

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-4

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

status

1..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.status

Short description

Status response code (text optional)

Definition

The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

location

0..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.location

Short description

The location (if the operation returns a location)

Definition

The location header created by processing this operation, populated if the operation returns a location.

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

etag

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.etag

Short description

The Etag for the resource (if relevant)

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).

Comments

Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

Data type

string

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

lastModified

0..1

instant

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.lastModified

Short description

Server's date time modified

Definition

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

Comments

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

Data type

instant

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

outcome

0..1

Resource

There are no (further) constraints on this element

Element id

Bundle.entry:subscriptionStatus.response.outcome

Short description

OperationOutcome with hints and warnings (for batch/transaction)

Definition

An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

Comments

For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

Data type

Resource

signature

0..1

Signature

There are no (further) constraints on this element

Element id

Bundle.signature

Short description

Digital Signature

Definition

Digital Signature - base64 encoded. XML-DSig or a JWT.

Requirements

Comments

Data type

Signature

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Table View

Bundle		0..*
Bundle.id	id	0..1
Bundle.meta	Meta	0..1
Bundle.implicitRules	uri	0..1
Bundle.language	code	0..1
Bundle.identifier	Identifier	0..1
Bundle.type	code	1..1
Bundle.timestamp	instant	0..1
Bundle.total	unsignedInt	0..1
Bundle.link	BackboneElement	0..*
Bundle.link.id	string	0..1
Bundle.link.extension	Extension	0..*
Bundle.link.modifierExtension	Extension	0..*
Bundle.link.relation	string	1..1
Bundle.link.url	uri	1..1
Bundle.entry	BackboneElement	1..*
Bundle.entry.id	string	0..1
Bundle.entry.extension	Extension	0..*
Bundle.entry.modifierExtension	Extension	0..*
Bundle.entry.link		0..*
Bundle.entry.fullUrl	uri	0..1
Bundle.entry.resource	Resource	0..1
Bundle.entry.search	BackboneElement	0..1
Bundle.entry.search.id	string	0..1
Bundle.entry.search.extension	Extension	0..*
Bundle.entry.search.modifierExtension	Extension	0..*
Bundle.entry.search.mode	code	0..1
Bundle.entry.search.score	decimal	0..1
Bundle.entry.request	BackboneElement	0..1
Bundle.entry.request.id	string	0..1
Bundle.entry.request.extension	Extension	0..*
Bundle.entry.request.modifierExtension	Extension	0..*
Bundle.entry.request.method	code	1..1
Bundle.entry.request.url	uri	1..1
Bundle.entry.request.ifNoneMatch	string	0..1
Bundle.entry.request.ifModifiedSince	instant	0..1
Bundle.entry.request.ifMatch	string	0..1
Bundle.entry.request.ifNoneExist	string	0..1
Bundle.entry.response	BackboneElement	0..1
Bundle.entry.response.id	string	0..1
Bundle.entry.response.extension	Extension	0..*
Bundle.entry.response.modifierExtension	Extension	0..*
Bundle.entry.response.status	string	1..1
Bundle.entry.response.location	uri	0..1
Bundle.entry.response.etag	string	0..1
Bundle.entry.response.lastModified	instant	0..1
Bundle.entry.response.outcome	Resource	0..1
Bundle.entry:subscriptionStatus	BackboneElement	1..1
Bundle.entry:subscriptionStatus.id	string	0..1
Bundle.entry:subscriptionStatus.extension	Extension	0..*
Bundle.entry:subscriptionStatus.modifierExtension	Extension	0..*
Bundle.entry:subscriptionStatus.link		0..*
Bundle.entry:subscriptionStatus.fullUrl	uri	0..1
Bundle.entry:subscriptionStatus.resource	BackportSubscriptionStatusR4	1..1
Bundle.entry:subscriptionStatus.search	BackboneElement	0..1
Bundle.entry:subscriptionStatus.search.id	string	0..1
Bundle.entry:subscriptionStatus.search.extension	Extension	0..*
Bundle.entry:subscriptionStatus.search.modifierExtension	Extension	0..*
Bundle.entry:subscriptionStatus.search.mode	code	0..1
Bundle.entry:subscriptionStatus.search.score	decimal	0..1
Bundle.entry:subscriptionStatus.request	BackboneElement	0..1
Bundle.entry:subscriptionStatus.request.id	string	0..1
Bundle.entry:subscriptionStatus.request.extension	Extension	0..*
Bundle.entry:subscriptionStatus.request.modifierExtension	Extension	0..*
Bundle.entry:subscriptionStatus.request.method	code	1..1
Bundle.entry:subscriptionStatus.request.url	uri	1..1
Bundle.entry:subscriptionStatus.request.ifNoneMatch	string	0..1
Bundle.entry:subscriptionStatus.request.ifModifiedSince	instant	0..1
Bundle.entry:subscriptionStatus.request.ifMatch	string	0..1
Bundle.entry:subscriptionStatus.request.ifNoneExist	string	0..1
Bundle.entry:subscriptionStatus.response	BackboneElement	0..1
Bundle.entry:subscriptionStatus.response.id	string	0..1
Bundle.entry:subscriptionStatus.response.extension	Extension	0..*
Bundle.entry:subscriptionStatus.response.modifierExtension	Extension	0..*
Bundle.entry:subscriptionStatus.response.status	string	1..1
Bundle.entry:subscriptionStatus.response.location	uri	0..1
Bundle.entry:subscriptionStatus.response.etag	string	0..1
Bundle.entry:subscriptionStatus.response.lastModified	instant	0..1
Bundle.entry:subscriptionStatus.response.outcome	Resource	0..1
Bundle.signature	Signature	0..1

JSON View

{

"resourceType": "StructureDefinition",
"id": "backport-subscription-notification-r4",
"text": {
"status": "extensions",

--- We have skipped the narrative for better readability of the resource ---
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport"
}
]
}
}
],
"url": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification-r4",
"version": "1.2.0-ballot",
"name": "BackportSubscriptionNotificationR4",
"title": "R4 Topic-Based Subscription Notification Bundle",
"status": "active",
"date": "2024-06-17T16:09:47+00:00",
"publisher": "HL7 International / FHIR Infrastructure",
"contact": [
{
"name": "HL7 International / FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
},
{
"name": "Gino Canessa",
"telecom": [
{
"system": "email",
"value": "mailto:gino.canessa@microsoft.com"
}
]
}
],
"description": "Profile on the R4 Bundle resource to enable R5-style topic-based subscription notifications in FHIR R4.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"fhirVersion": "4.3.0",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "cda",
"uri": "http://hl7.org/v3/cda",
"name": "CDA (R2)"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "Bundle",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Bundle",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Bundle",
"path": "Bundle",
"short": "Contains a collection of resources",
"definition": "A container for a collection of resources.",
"min": 0,
"max": "*",
"base": {
"path": "Bundle",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "bdl-1",
"severity": "error",
"human": "total only when a search or history",
"expression": "total.empty() or (type = 'searchset') or (type = 'history')",
"xpath": "not(f:total) or (f:type/@value = 'searchset') or (f:type/@value = 'history')",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle"
},
{
"key": "bdl-2",
"severity": "error",
"human": "entry.search only when a search",
"expression": "entry.search.empty() or (type = 'searchset')",
"xpath": "not(f:entry/f:search) or (f:type/@value = 'searchset')",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle"
},
{
"key": "bdl-3",
"severity": "error",
"human": "entry.request mandatory for batch/transaction/history, otherwise prohibited",
"expression": "entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))",
"xpath": "not(f:entry/f:request) or (f:type/@value = 'batch') or (f:type/@value = 'transaction') or (f:type/@value = 'history')",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle"
},
{
"key": "bdl-4",
"severity": "error",
"human": "entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited",
"expression": "entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))",
"xpath": "not(f:entry/f:response) or (f:type/@value = 'batch-response') or (f:type/@value = 'transaction-response') or (f:type/@value = 'history')",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle"
},
{
"key": "bdl-7",
"severity": "error",
"human": "FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)",
"expression": "(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()",
"xpath": "(f:type/@value = 'history') or (count(for $entry in f:entry[f:resource] return $entry[count(parent::f:Bundle/f:entry[f:fullUrl/@value=$entry/f:fullUrl/@value and ((not(f:resource/*/f:meta/f:versionId/@value) and not($entry/f:resource/*/f:meta/f:versionId/@value)) or f:resource/*/f:meta/f:versionId/@value=$entry/f:resource/*/f:meta/f:versionId/@value)])!=1])=0)",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle"
},
{
"key": "bdl-9",
"severity": "error",
"human": "A document must have an identifier with a system and a value",
"expression": "type = 'document' implies (identifier.system.exists() and identifier.value.exists())",
"xpath": "not(f:type/@value = 'document') or exists(f:identifier/f:system) or exists(f:identifier/f:value)",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle"
},
{
"key": "bdl-10",
"severity": "error",
"human": "A document must have a date",
"expression": "type = 'document' implies (timestamp.hasValue())",
"xpath": "not(f:type/@value = 'document') or exists(f:timestamp/@value)",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle"
},
{
"key": "bdl-11",
"severity": "error",
"human": "A document must have a Composition as the first resource",
"expression": "type = 'document' implies entry.first().resource.is(Composition)",
"xpath": "not(f:type/@value='document') or f:entry[1]/f:resource/f:Composition",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle"
},
{
"key": "bdl-12",
"severity": "error",
"human": "A message must have a MessageHeader as the first resource",
"expression": "type = 'message' implies entry.first().resource.is(MessageHeader)",
"xpath": "not(f:type/@value='message') or f:entry[1]/f:resource/f:MessageHeader",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle"
},
{
"key": "backport-notification-bundle-r4-1",
"severity": "error",
"human": "A notification bundle MUST have a Parameters as the first entry",
"expression": "(entry.first().resource.is(Parameters))",
"xpath": "f:entry[1]/f:resource/f:Parameters",
"source": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification-r4"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "cda",
"map": "ClinicalDocument, if bundle.type = document"
},
{
"identity": "w5",
"map": "infrastructure.structure"
}
]
},
{
"id": "Bundle.id",
"path": "Bundle.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.meta",
"path": "Bundle.meta",
"short": "Metadata about the resource",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.implicitRules",
"path": "Bundle.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "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 it's narrative along with other profiles, value sets, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
},
{
"id": "Bundle.language",
"path": "Bundle.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "preferred",
"description": "IETF language tag",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "Bundle.identifier",
"path": "Bundle.identifier",
"short": "Persistent identifier for the bundle",
"definition": "A persistent identifier for the bundle that won't change as a bundle is copied from server to server.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "cda",
"map": "ClinicalDocument.id"
}
]
},
{
"id": "Bundle.type",
"path": "Bundle.type",
"short": "document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection",
"definition": "Indicates the purpose of this bundle - how it is intended to be used.",
"comment": "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.",
"min": 1,
"max": "1",
"base": {
"path": "Bundle.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"patternCode": "history",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BundleType"
}
],
"strength": "required",
"description": "Indicates the purpose of a bundle - how it is intended to be used.",
"valueSet": "http://hl7.org/fhir/ValueSet/bundle-type|4.3.0"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.class"
}
]
},
{
"id": "Bundle.timestamp",
"path": "Bundle.timestamp",
"short": "When the bundle was assembled",
"definition": "The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.",
"comment": "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.  \n\nUsage:\n\n* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time\n* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message\n* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates\n* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query\n* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning\n\nThe 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.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.timestamp",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.init"
},
{
"identity": "cda",
"map": "ClinicalDocument.effectiveTime"
}
]
},
{
"id": "Bundle.total",
"path": "Bundle.total",
"short": "If search, the total number of matches",
"definition": "If a set of search matches, this is the 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.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.total",
"min": 0,
"max": "1"
},
"type": [
{
"code": "unsignedInt"
}
],
"condition": [
"bdl-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.link",
"path": "Bundle.link",
"short": "Links related to this Bundle",
"definition": "A series of links that provide context to this bundle.",
"comment": "Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)). \n\nBundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http://hl7.org/fhir/R4B/http.html#read) directly.\n\nThis specification defines some specific uses of Bundle.link for [searching](http://hl7.org/fhir/R4B/search.html#conformance) and [paging](http://hl7.org/fhir/R4B/http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.",
"min": 0,
"max": "*",
"base": {
"path": "Bundle.link",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children unless an empty Parameters resource",
"expression": "hasValue() or (children().count() > id.count()) or $this is Parameters",
"xpath": "@value|f:*|h:div|self::f:Parameters",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.link.id",
"path": "Bundle.link.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.link.extension",
"path": "Bundle.link.extension",
"short": "Additional content defined by implementations",
"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 manageable, 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.link.modifierExtension",
"path": "Bundle.link.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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 manageable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4B/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Bundle.link.relation",
"path": "Bundle.link.relation",
"short": "See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1",
"definition": "A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).",
"min": 1,
"max": "1",
"base": {
"path": "Bundle.link.relation",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.link.url",
"path": "Bundle.link.url",
"short": "Reference details for the link",
"definition": "The reference details for the link.",
"min": 1,
"max": "1",
"base": {
"path": "Bundle.link.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry",
"path": "Bundle.entry",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "resource"
}
],
"description": "Slice based on resource",
"ordered": false,
"rules": "open"
},
"short": "Entry in the bundle - will have a resource or information",
"definition": "An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).",
"min": 1,
"max": "*",
"base": {
"path": "Bundle.entry",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"orderMeaning": "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",
"constraint": [
{
"key": "bdl-5",
"severity": "error",
"human": "must be a resource unless there's a request or response",
"expression": "resource.exists() or request.exists() or response.exists()",
"xpath": "exists(f:resource) or exists(f:request) or exists(f:response)",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle"
},
{
"key": "bdl-8",
"severity": "error",
"human": "fullUrl cannot be a version specific reference",
"expression": "fullUrl.exists() implies fullUrl.contains('/_history/').not()",
"xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle"
},
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children unless an empty Parameters resource",
"expression": "hasValue() or (children().count() > id.count()) or $this is Parameters",
"xpath": "@value|f:*|h:div|self::f:Parameters",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry.id",
"path": "Bundle.entry.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.entry.extension",
"path": "Bundle.entry.extension",
"short": "Additional content defined by implementations",
"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 manageable, 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.entry.modifierExtension",
"path": "Bundle.entry.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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 manageable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4B/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Bundle.entry.link",
"path": "Bundle.entry.link",
"short": "Links related to this entry",
"definition": "A series of links that provide context to this entry.",
"min": 0,
"max": "*",
"base": {
"path": "Bundle.entry.link",
"min": 0,
"max": "*"
},
"contentReference": "http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry.fullUrl",
"path": "Bundle.entry.fullUrl",
"short": "URI for resource (Absolute URL server address or URI for UUID/OID)",
"definition": "The Absolute URL for the resource.  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. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.",
"comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](http://hl7.org/fhir/R4B/references.html), 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](http://hl7.org/fhir/R4B/references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote 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).",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.fullUrl",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry.resource",
"path": "Bundle.entry.resource",
"short": "A resource in the bundle",
"definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.resource",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Resource"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry.search",
"path": "Bundle.entry.search",
"short": "Search related information",
"definition": "Information about the search process that lead to the creation of this entry.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.search",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"bdl-2"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children unless an empty Parameters resource",
"expression": "hasValue() or (children().count() > id.count()) or $this is Parameters",
"xpath": "@value|f:*|h:div|self::f:Parameters",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry.search.id",
"path": "Bundle.entry.search.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.entry.search.extension",
"path": "Bundle.entry.search.extension",
"short": "Additional content defined by implementations",
"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 manageable, 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.entry.search.modifierExtension",
"path": "Bundle.entry.search.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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 manageable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4B/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Bundle.entry.search.mode",
"path": "Bundle.entry.search.mode",
"short": "match | include | outcome - why this is in the result set",
"definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.search.mode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SearchEntryMode"
}
],
"strength": "required",
"description": "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.",
"valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0"
}
},
{
"id": "Bundle.entry.search.score",
"path": "Bundle.entry.search.score",
"short": "Search ranking (between 0 and 1)",
"definition": "When searching, the server's search ranking score for the entry.",
"comment": "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.\n\nSee [Patient Match](http://hl7.org/fhir/R4B/patient-operation-match.html) for the EMPI search which relates to this element.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.search.score",
"min": 0,
"max": "1"
},
"type": [
{
"code": "decimal"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry.request",
"path": "Bundle.entry.request",
"short": "Additional execution information (transaction/batch/history)",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.request",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"bdl-3"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children unless an empty Parameters resource",
"expression": "hasValue() or (children().count() > id.count()) or $this is Parameters",
"xpath": "@value|f:*|h:div|self::f:Parameters",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry.request.id",
"path": "Bundle.entry.request.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.entry.request.extension",
"path": "Bundle.entry.request.extension",
"short": "Additional content defined by implementations",
"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 manageable, 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.entry.request.modifierExtension",
"path": "Bundle.entry.request.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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 manageable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4B/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Bundle.entry.request.method",
"path": "Bundle.entry.request.method",
"short": "GET | HEAD | POST | PUT | DELETE | PATCH",
"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.",
"min": 1,
"max": "1",
"base": {
"path": "Bundle.entry.request.method",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "HTTPVerb"
}
],
"strength": "required",
"description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.",
"valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.3.0"
}
},
{
"id": "Bundle.entry.request.url",
"path": "Bundle.entry.request.url",
"short": "URL for HTTP equivalent of this entry",
"definition": "The URL for this entry, relative to the root (the address to which the request is posted).",
"comment": "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]\".",
"min": 1,
"max": "1",
"base": {
"path": "Bundle.entry.request.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry.request.ifNoneMatch",
"path": "Bundle.entry.request.ifNoneMatch",
"short": "For managing cache currency",
"definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http://hl7.org/fhir/R4B/http.html#cread).",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.request.ifNoneMatch",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry.request.ifModifiedSince",
"path": "Bundle.entry.request.ifModifiedSince",
"short": "For managing cache currency",
"definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http://hl7.org/fhir/R4B/http.html#cread).",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.request.ifModifiedSince",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry.request.ifMatch",
"path": "Bundle.entry.request.ifMatch",
"short": "For managing update contention",
"definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http://hl7.org/fhir/R4B/http.html#concurrency).",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.request.ifMatch",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry.request.ifNoneExist",
"path": "Bundle.entry.request.ifNoneExist",
"short": "For conditional creates",
"definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http://hl7.org/fhir/R4B/http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.request.ifNoneExist",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry.response",
"path": "Bundle.entry.response",
"short": "Results of execution (transaction/batch/history)",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.response",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"bdl-4"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children unless an empty Parameters resource",
"expression": "hasValue() or (children().count() > id.count()) or $this is Parameters",
"xpath": "@value|f:*|h:div|self::f:Parameters",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry.response.id",
"path": "Bundle.entry.response.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.entry.response.extension",
"path": "Bundle.entry.response.extension",
"short": "Additional content defined by implementations",
"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 manageable, 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.entry.response.modifierExtension",
"path": "Bundle.entry.response.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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 manageable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4B/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Bundle.entry.response.status",
"path": "Bundle.entry.response.status",
"short": "Status response code (text optional)",
"definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.",
"min": 1,
"max": "1",
"base": {
"path": "Bundle.entry.response.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry.response.location",
"path": "Bundle.entry.response.location",
"short": "The location (if the operation returns a location)",
"definition": "The location header created by processing this operation, populated if the operation returns a location.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.response.location",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry.response.etag",
"path": "Bundle.entry.response.etag",
"short": "The Etag for the resource (if relevant)",
"definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http://hl7.org/fhir/R4B/http.html#versioning) and [Managing Resource Contention](http://hl7.org/fhir/R4B/http.html#concurrency)).",
"comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.response.etag",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry.response.lastModified",
"path": "Bundle.entry.response.lastModified",
"short": "Server's date time modified",
"definition": "The date/time that the resource was modified on the server.",
"comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.response.lastModified",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry.response.outcome",
"path": "Bundle.entry.response.outcome",
"short": "OperationOutcome with hints and warnings (for batch/transaction)",
"definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.",
"comment": "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.\n\nThis 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.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.response.outcome",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Resource"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry:subscriptionStatus",
"path": "Bundle.entry",
"sliceName": "subscriptionStatus",
"short": "Entry in the bundle - will have a resource or information",
"definition": "An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).",
"min": 1,
"max": "1",
"base": {
"path": "Bundle.entry",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"orderMeaning": "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",
"constraint": [
{
"key": "bdl-5",
"severity": "error",
"human": "must be a resource unless there's a request or response",
"expression": "resource.exists() or request.exists() or response.exists()",
"xpath": "exists(f:resource) or exists(f:request) or exists(f:response)",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle"
},
{
"key": "bdl-8",
"severity": "error",
"human": "fullUrl cannot be a version specific reference",
"expression": "fullUrl.exists() implies fullUrl.contains('/_history/').not()",
"xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle"
},
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children unless an empty Parameters resource",
"expression": "hasValue() or (children().count() > id.count()) or $this is Parameters",
"xpath": "@value|f:*|h:div|self::f:Parameters",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry:subscriptionStatus.id",
"path": "Bundle.entry.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.entry:subscriptionStatus.extension",
"path": "Bundle.entry.extension",
"short": "Additional content defined by implementations",
"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 manageable, 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.entry:subscriptionStatus.modifierExtension",
"path": "Bundle.entry.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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 manageable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4B/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Bundle.entry:subscriptionStatus.link",
"path": "Bundle.entry.link",
"short": "Links related to this entry",
"definition": "A series of links that provide context to this entry.",
"min": 0,
"max": "*",
"base": {
"path": "Bundle.entry.link",
"min": 0,
"max": "*"
},
"contentReference": "http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry:subscriptionStatus.fullUrl",
"path": "Bundle.entry.fullUrl",
"short": "URI for resource (Absolute URL server address or URI for UUID/OID)",
"definition": "The Absolute URL for the resource.  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. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.",
"comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](http://hl7.org/fhir/R4B/references.html), 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](http://hl7.org/fhir/R4B/references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote 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).",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.fullUrl",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry:subscriptionStatus.resource",
"path": "Bundle.entry.resource",
"short": "Parameter containing subscription status information",
"definition": "This resource is a non-persisted resource used to pass information into and back from an [operation](http://hl7.org/fhir/R4B/operations.html). It has no other use, and there is no RESTful endpoint associated with it.",
"comment": "The parameters that may be used are defined by the OperationDefinition resource.",
"min": 1,
"max": "1",
"base": {
"path": "Bundle.entry.resource",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Parameters",
"profile": [
"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-status-r4"
]
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "v2",
"map": "n/a"
},
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "infrastructure.exchange"
}
]
},
{
"id": "Bundle.entry:subscriptionStatus.search",
"path": "Bundle.entry.search",
"short": "Search related information",
"definition": "Information about the search process that lead to the creation of this entry.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.search",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"bdl-2"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children unless an empty Parameters resource",
"expression": "hasValue() or (children().count() > id.count()) or $this is Parameters",
"xpath": "@value|f:*|h:div|self::f:Parameters",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry:subscriptionStatus.search.id",
"path": "Bundle.entry.search.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.entry:subscriptionStatus.search.extension",
"path": "Bundle.entry.search.extension",
"short": "Additional content defined by implementations",
"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 manageable, 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.entry:subscriptionStatus.search.modifierExtension",
"path": "Bundle.entry.search.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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 manageable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4B/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Bundle.entry:subscriptionStatus.search.mode",
"path": "Bundle.entry.search.mode",
"short": "match | include | outcome - why this is in the result set",
"definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.search.mode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SearchEntryMode"
}
],
"strength": "required",
"description": "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.",
"valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0"
}
},
{
"id": "Bundle.entry:subscriptionStatus.search.score",
"path": "Bundle.entry.search.score",
"short": "Search ranking (between 0 and 1)",
"definition": "When searching, the server's search ranking score for the entry.",
"comment": "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.\n\nSee [Patient Match](http://hl7.org/fhir/R4B/patient-operation-match.html) for the EMPI search which relates to this element.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.search.score",
"min": 0,
"max": "1"
},
"type": [
{
"code": "decimal"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry:subscriptionStatus.request",
"path": "Bundle.entry.request",
"short": "Additional execution information (transaction/batch/history)",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.request",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"bdl-3"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children unless an empty Parameters resource",
"expression": "hasValue() or (children().count() > id.count()) or $this is Parameters",
"xpath": "@value|f:*|h:div|self::f:Parameters",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry:subscriptionStatus.request.id",
"path": "Bundle.entry.request.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.entry:subscriptionStatus.request.extension",
"path": "Bundle.entry.request.extension",
"short": "Additional content defined by implementations",
"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 manageable, 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.entry:subscriptionStatus.request.modifierExtension",
"path": "Bundle.entry.request.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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 manageable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4B/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Bundle.entry:subscriptionStatus.request.method",
"path": "Bundle.entry.request.method",
"short": "GET | HEAD | POST | PUT | DELETE | PATCH",
"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.",
"min": 1,
"max": "1",
"base": {
"path": "Bundle.entry.request.method",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "HTTPVerb"
}
],
"strength": "required",
"description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.",
"valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.3.0"
}
},
{
"id": "Bundle.entry:subscriptionStatus.request.url",
"path": "Bundle.entry.request.url",
"short": "URL for HTTP equivalent of this entry",
"definition": "The URL for this entry, relative to the root (the address to which the request is posted).",
"comment": "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]\".",
"min": 1,
"max": "1",
"base": {
"path": "Bundle.entry.request.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry:subscriptionStatus.request.ifNoneMatch",
"path": "Bundle.entry.request.ifNoneMatch",
"short": "For managing cache currency",
"definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http://hl7.org/fhir/R4B/http.html#cread).",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.request.ifNoneMatch",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry:subscriptionStatus.request.ifModifiedSince",
"path": "Bundle.entry.request.ifModifiedSince",
"short": "For managing cache currency",
"definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http://hl7.org/fhir/R4B/http.html#cread).",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.request.ifModifiedSince",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry:subscriptionStatus.request.ifMatch",
"path": "Bundle.entry.request.ifMatch",
"short": "For managing update contention",
"definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http://hl7.org/fhir/R4B/http.html#concurrency).",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.request.ifMatch",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry:subscriptionStatus.request.ifNoneExist",
"path": "Bundle.entry.request.ifNoneExist",
"short": "For conditional creates",
"definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http://hl7.org/fhir/R4B/http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.request.ifNoneExist",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry:subscriptionStatus.response",
"path": "Bundle.entry.response",
"short": "Results of execution (transaction/batch/history)",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.response",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"bdl-4"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children unless an empty Parameters resource",
"expression": "hasValue() or (children().count() > id.count()) or $this is Parameters",
"xpath": "@value|f:*|h:div|self::f:Parameters",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry:subscriptionStatus.response.id",
"path": "Bundle.entry.response.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.entry:subscriptionStatus.response.extension",
"path": "Bundle.entry.response.extension",
"short": "Additional content defined by implementations",
"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 manageable, 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Bundle.entry:subscriptionStatus.response.modifierExtension",
"path": "Bundle.entry.response.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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 manageable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4B/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Bundle.entry:subscriptionStatus.response.status",
"path": "Bundle.entry.response.status",
"short": "Status response code (text optional)",
"definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.",
"min": 1,
"max": "1",
"base": {
"path": "Bundle.entry.response.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry:subscriptionStatus.response.location",
"path": "Bundle.entry.response.location",
"short": "The location (if the operation returns a location)",
"definition": "The location header created by processing this operation, populated if the operation returns a location.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.response.location",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry:subscriptionStatus.response.etag",
"path": "Bundle.entry.response.etag",
"short": "The Etag for the resource (if relevant)",
"definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http://hl7.org/fhir/R4B/http.html#versioning) and [Managing Resource Contention](http://hl7.org/fhir/R4B/http.html#concurrency)).",
"comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.response.etag",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry:subscriptionStatus.response.lastModified",
"path": "Bundle.entry.response.lastModified",
"short": "Server's date time modified",
"definition": "The date/time that the resource was modified on the server.",
"comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.response.lastModified",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.entry:subscriptionStatus.response.outcome",
"path": "Bundle.entry.response.outcome",
"short": "OperationOutcome with hints and warnings (for batch/transaction)",
"definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.",
"comment": "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.\n\nThis 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.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.entry.response.outcome",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Resource"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Bundle.signature",
"path": "Bundle.signature",
"short": "Digital Signature",
"definition": "Digital Signature - base64 encoded. XML-DSig or a JWT.",
"comment": "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.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Bundle.signature",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Signature"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
}
]
},
"differential": {
"element": [
{
"id": "Bundle",
"path": "Bundle",
"constraint": [
{
"key": "backport-notification-bundle-r4-1",
"severity": "error",
"human": "A notification bundle MUST have a Parameters as the first entry",
"expression": "(entry.first().resource.is(Parameters))",
"xpath": "f:entry[1]/f:resource/f:Parameters",
"source": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification-r4"
}
]
},
{
"id": "Bundle.type",
"path": "Bundle.type",
"patternCode": "history"
},
{
"id": "Bundle.entry",
"path": "Bundle.entry",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "resource"
}
],
"description": "Slice based on resource",
"ordered": false,
"rules": "open"
},
"min": 1
},
{
"id": "Bundle.entry:subscriptionStatus",
"path": "Bundle.entry",
"sliceName": "subscriptionStatus",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Bundle.entry:subscriptionStatus.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Parameters",
"profile": [
"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-status-r4"
]
}
],
"mustSupport": true
}
]
}

}

Usage Notes:

.type

FHIR R4 does not have a subscription-notification Bundle type, so "history" must be used

.entry:subscriptionStatus

The first entry in the bundle must be a Parameter resource, conforming to the BackportSubscriptionStatusR4 profile (See Profile: Subscription Status from this IG's drop-down)

.entry

After the first subscriptionStatus entry element, the remaining elements will be the payload of the subscription (referenced in the subscriptionStatus entry), e.g. HealthcareService resources