Bundle
Bundle | I | Bundle | |
id | Σ | 1..1 | string |
meta | Σ | 1..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | Σ | 0..1 | id |
lastUpdated | Σ | 0..1 | instant |
source | Σ | 0..1 | uri |
profile | Σ | 1..1 | canonical(StructureDefinition)Fixed Value |
security | Σ | 0..1 | CodingBinding |
tag | Σ | 0..1 | Coding |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
text | Σ | 1..1 | string |
system | Σ | 1..1 | uri |
value | Σ | 0..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
type | Σ | 1..1 | codeBinding |
timestamp | Σ | 1..1 | instant |
total | Σ I | 0..1 | unsignedInt |
link | Σ | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
relation | Σ | 1..1 | string |
url | Σ | 1..1 | uri |
entry | Σ I | 0..* | BackboneElement |
id | 0..0 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
link | Σ | 0..0 | see (link) |
fullUrl | Σ | 0..1 | uri |
resource | Σ | 0..1 | Resource |
search | Σ I | 0..0 | BackboneElement |
request | Σ I | 0..0 | BackboneElement |
response | Σ I | 0..0 | BackboneElement |
signature | Σ | 0..1 | Signature |
Bundle | |
Definition | A container for a collection of resources. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Bundle.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | Unique GUID |
Bundle.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 1...1 |
Type | Meta |
Summary | True |
Invariants |
|
Bundle.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.meta.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Bundle.meta.versionId | |
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | Use '2025.01.1' (It indicates FHIR changes on 2025-Jan). |
Invariants |
|
Bundle.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Comments | Updated: Relax the previously crossed-out elements. |
Invariants |
|
Bundle.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
Invariants |
|
Bundle.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 1...1 |
Type | canonical(StructureDefinition) |
Summary | True |
Comments | Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunicationdistribution/Bundle' |
Invariants |
|
Fixed Value | http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Bundle |
Bundle.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...1 |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
Bundle.meta.tag | |
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
Cardinality | 0...1 |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Summary | True |
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
Bundle.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
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. |
Invariants |
|
Bundle.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Bundle.identifier | |
Definition | A persistent identifier for the bundle that won't change as a bundle is copied from server to server. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique. |
Invariants |
|
Mappings |
|
Bundle.identifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.identifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Bundle.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
Bundle.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Mappings |
|
Bundle.identifier.type.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.identifier.type.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Bundle.identifier.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Bundle.identifier.type.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Bundle.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | See Mappings |
Invariants |
|
Examples | General http://www.acme.com/identifiers/patient |
Mappings |
|
Bundle.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | See Mappings |
Invariants |
|
Examples | General 123456 |
Mappings |
|
Bundle.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
Bundle.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants |
|
Mappings |
|
Bundle.type | |
Definition | Indicates the purpose of this bundle - how it is intended to be used. |
Cardinality | 1...1 |
Type | code |
Binding | Indicates the purpose of a bundle - how it is intended to be used. |
Summary | True |
Comments | Hardcode as "collection" for distribution |
Invariants |
|
Mappings |
|
Bundle.timestamp | |
Definition | The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. |
Cardinality | 1...1 |
Type | instant |
Summary | True |
Comments | Full dateTime with GMT offset, use local PIR timezone. |
Invariants |
|
Mappings |
|
Bundle.total | |
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. |
Cardinality | 0...1 |
Type | unsignedInt |
Summary | True |
Comments | Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources. |
Invariants |
|
Bundle.link | |
Definition | A series of links that provide context to this bundle. |
Cardinality | 0...1 |
Type | BackboneElement |
Summary | True |
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. |
Invariants |
|
Bundle.link.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.link.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.link.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.link.relation | |
Definition | A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1). |
Cardinality | 1...1 |
Type | string |
Summary | True |
Invariants |
|
Bundle.link.url | |
Definition | The reference details for the link. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Invariants |
|
Bundle.entry | |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Invariants |
|
Bundle.entry.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...0 |
Type | string |
Mappings |
|
Bundle.entry.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.entry.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.entry.link | |
Definition | A series of links that provide context to this entry. |
Cardinality | 0...0 |
Type | see (link) |
Summary | True |
Invariants |
|
Bundle.entry.fullUrl | |
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. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Comments | fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). |
Invariants |
|
Bundle.entry.resource | |
Definition | The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
Cardinality | 0...1 |
Type | Resource |
Summary | True |
Bundle.entry.search | |
Definition | Information about the search process that lead to the creation of this entry. |
Cardinality | 0...0 |
Type | BackboneElement |
Summary | True |
Invariants |
|
Bundle.entry.search.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.entry.search.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.entry.search.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.entry.search.mode | |
Definition | Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
Cardinality | 0...1 |
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. |
Summary | True |
Comments | There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. |
Invariants |
|
Bundle.entry.search.score | |
Definition | When searching, the server's search ranking score for the entry. |
Cardinality | 0...1 |
Type | decimal |
Summary | True |
Comments | Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. |
Invariants |
|
Bundle.entry.request | |
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. |
Cardinality | 0...0 |
Type | BackboneElement |
Summary | True |
Invariants |
|
Bundle.entry.request.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.entry.request.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.entry.request.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.entry.request.method | |
Definition | In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. |
Cardinality | 1...1 |
Type | code |
Binding | HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
Summary | True |
Invariants |
|
Bundle.entry.request.url | |
Definition | The URL for this entry, relative to the root (the address to which the request is posted). |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". |
Invariants |
|
Bundle.entry.request.ifNoneMatch | |
Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Invariants |
|
Bundle.entry.request.ifModifiedSince | |
Definition | Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread). |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Invariants |
|
Bundle.entry.request.ifMatch | |
Definition | Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Invariants |
|
Bundle.entry.request.ifNoneExist | |
Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?"). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Invariants |
|
Bundle.entry.response | |
Definition | Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. |
Cardinality | 0...0 |
Type | BackboneElement |
Summary | True |
Invariants |
|
Bundle.entry.response.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.entry.response.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.entry.response.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.entry.response.status | |
Definition | The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Invariants |
|
Bundle.entry.response.location | |
Definition | The location header created by processing this operation, populated if the operation returns a location. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Invariants |
|
Bundle.entry.response.etag | |
Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. |
Invariants |
|
Bundle.entry.response.lastModified | |
Definition | The date/time that the resource was modified on the server. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. |
Invariants |
|
Bundle.entry.response.outcome | |
Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. |
Cardinality | 0...1 |
Type | Resource |
Summary | True |
Comments | For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. |
Bundle.signature | |
Definition | Digital Signature - base64 encoded. XML-DSig or a JWT. |
Cardinality | 0...1 |
Type | Signature |
Summary | True |
Requirements | A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient. |
Comments | The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific. |
Invariants |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="3a46c1e4-621b-4f05-a9ee-6df81b928311" /> <meta> <versionId value="6" /> <lastUpdated value="2025-01-24T22:55:17.8280561+00:00" /> </meta> <url value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Bundle" /> <name value="Bundle" /> <status value="draft" /> <date value="2021-11-26T22:46:05.681609Z" /> <fhirVersion value="4.0.1" /> <mapping> <identity value="v2" /> <uri value="http://hl7.org/v2" /> <name value="HL7 v2 Mapping" /> </mapping> <mapping> <identity value="rim" /> <uri value="http://hl7.org/v3" /> <name value="RIM Mapping" /> </mapping> <mapping> <identity value="cda" /> <uri value="http://hl7.org/v3/cda" /> <name value="CDA (R2)" /> </mapping> <mapping> <identity value="w5" /> <uri value="http://hl7.org/fhir/fivews" /> <name value="FiveWs Pattern Mapping" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="Bundle" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Bundle" /> <derivation value="constraint" /> <differential> <element id="Bundle.id"> <path value="Bundle.id" /> <comment value="Unique GUID" /> <min value="1" /> </element> <element id="Bundle.meta"> <path value="Bundle.meta" /> <min value="1" /> </element> <element id="Bundle.meta.versionId"> <path value="Bundle.meta.versionId" /> <comment value="Use '2025.01.1' (It indicates FHIR changes on 2025-Jan)." /> </element> <element id="Bundle.meta.lastUpdated"> <path value="Bundle.meta.lastUpdated" /> <comment value="Updated: Relax the previously crossed-out elements." /> </element> <element id="Bundle.meta.profile"> <path value="Bundle.meta.profile" /> <comment value="Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunicationdistribution/Bundle'" /> <min value="1" /> <max value="1" /> <fixedCanonical value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Bundle" /> </element> <element id="Bundle.meta.security"> <path value="Bundle.meta.security" /> <max value="1" /> </element> <element id="Bundle.meta.tag"> <path value="Bundle.meta.tag" /> <max value="1" /> </element> <element id="Bundle.identifier.type.text"> <path value="Bundle.identifier.type.text" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-panorama-ids" /> <map value="Panorama IDS Bundle ID" /> </mapping> </element> <element id="Bundle.identifier.system"> <path value="Bundle.identifier.system" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-panorama-ids" /> <map value="https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-panorama-ids-source-gundle-id" /> </mapping> </element> <element id="Bundle.identifier.value"> <path value="Bundle.identifier.value" /> <comment value="See Mappings" /> <mapping> <identity value="source-panorama-ids" /> <map value="resourceBundle.id" /> </mapping> </element> <element id="Bundle.type"> <path value="Bundle.type" /> <comment value="Hardcode as "collection" for distribution" /> </element> <element id="Bundle.timestamp"> <path value="Bundle.timestamp" /> <comment value="Full dateTime with GMT offset, use local PIR timezone." /> <min value="1" /> </element> <element id="Bundle.link"> <path value="Bundle.link" /> <max value="1" /> </element> <element id="Bundle.entry.id"> <path value="Bundle.entry.id" /> <max value="0" /> </element> <element id="Bundle.entry.link"> <path value="Bundle.entry.link" /> <max value="0" /> </element> <element id="Bundle.entry.search"> <path value="Bundle.entry.search" /> <max value="0" /> </element> <element id="Bundle.entry.request"> <path value="Bundle.entry.request" /> <max value="0" /> </element> <element id="Bundle.entry.response"> <path value="Bundle.entry.response" /> <max value="0" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "3a46c1e4-621b-4f05-a9ee-6df81b928311", "meta": { "versionId": "6", "lastUpdated": "01/24/2025 22:55:17" }, "url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Bundle", "name": "Bundle", "status": "draft", "date": "11/26/2021 22:46:05", "fhirVersion": "4.0.1", "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", "differential": { "element": [ { "id": "Bundle.id", "path": "Bundle.id", "comment": "Unique GUID", "min": 1 }, { "id": "Bundle.meta", "path": "Bundle.meta", "min": 1 }, { "id": "Bundle.meta.versionId", "path": "Bundle.meta.versionId", "comment": "Use '2025.01.1' (It indicates FHIR changes on 2025-Jan)." }, { "id": "Bundle.meta.lastUpdated", "path": "Bundle.meta.lastUpdated", "comment": "Updated: Relax the previously crossed-out elements." }, { "id": "Bundle.meta.profile", "path": "Bundle.meta.profile", "comment": "Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunicationdistribution/Bundle'", "min": 1, "max": "1", "fixedCanonical": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Bundle" }, { "id": "Bundle.meta.security", "path": "Bundle.meta.security", "max": "1" }, { "id": "Bundle.meta.tag", "path": "Bundle.meta.tag", "max": "1" }, { "id": "Bundle.identifier.type.text", "path": "Bundle.identifier.type.text", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-panorama-ids", "map": "Panorama IDS Bundle ID" } ] }, { "id": "Bundle.identifier.system", "path": "Bundle.identifier.system", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-panorama-ids", "map": "https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-panorama-ids-source-gundle-id" } ] }, { "id": "Bundle.identifier.value", "path": "Bundle.identifier.value", "comment": "See Mappings", "mapping": [ { "identity": "source-panorama-ids", "map": "resourceBundle.id" } ] }, { "id": "Bundle.type", "path": "Bundle.type", "comment": "Hardcode as \"collection\" for distribution" }, { "id": "Bundle.timestamp", "path": "Bundle.timestamp", "comment": "Full dateTime with GMT offset, use local PIR timezone.", "min": 1 }, { "id": "Bundle.link", "path": "Bundle.link", "max": "1" }, { "id": "Bundle.entry.id", "path": "Bundle.entry.id", "max": "0" }, { "id": "Bundle.entry.link", "path": "Bundle.entry.link", "max": "0" }, { "id": "Bundle.entry.search", "path": "Bundle.entry.search", "max": "0" }, { "id": "Bundle.entry.request", "path": "Bundle.entry.request", "max": "0" }, { "id": "Bundle.entry.response", "path": "Bundle.entry.response", "max": "0" } ] } }