Visit the HL7 website
Visit the FHIR website

Pan-Canadian eReferral-eConsult (CA:eReC)

1.1.0-DFT   Canada flag
  • Index
  • Home
  • Business Context
    • Business Models
    • Use Cases
    • Business Events
    • Business Rules
    • Privacy and Security Guidance
    • Provincial Considerations
  • Technical Context
    • Technical Foundation
    • Integration Patterns
    • Messaging
    • Sequence Diagrams
    • Conformance Requirements
  • FHIR Artifacts
    • Messaging Events
    • Resource Profiles
    • Extensions
    • Terminology
    • Identifier Naming System
    • Examples
    • Capability Statements
    • Downloads
    • ---
    • Appointment (CA:eReC)
    • Bundle (CA:eReC)
    • Communication (CA:eReC)
    • DocumentReference (CA:eReC)
    • Location (CA:eReC)
    • MessageHeader (CA:eReC)
    • Organization (CA:eReC)
    • Patient (CA:eReC)
    • Practitioner (CA:eReC)
    • PractitionerRole (CA:eReC)
    • HealthcareService (CA:eReC)
    • QuestionnaireResponse (CA:eReC)
    • ServiceRequest (CA:eReC)
    • Task (CA:eReC)
  • Change Log
    1. Index
    2. FHIR Artifacts
    3. Bundle (CA:eReC)

DFT - The specification is currently in development and subject to change. For a full list of available versions, see the Directory of published versions

Bundle (CA:eReC)

Links

Profile

CA-eReC-Bundle

Derived from

http://hl7.org/fhir/StructureDefinition/Bundle

Description

The bundle resource is used to package a collection of resources into a single instance. This resource would be used for referral in the following contexts: - Sending a set of resources as part of a message exchange - Grouping a self-contained set of resources to act as an exchangeable and persistable collection with clinical integrity , e.g. a clinical document

References to this resource

Resource Content

  • Tree view
  • Overview
  • XML
  • JSON
BundleCBundle
There are no (further) constraints on this element
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)
Mappings
  • rim: Entity. Role, or Act
  • v2: N/A
  • rim: N/A
  • cda: ClinicalDocument, if bundle.type = document
idΣ0..1string
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

metaS Σ0..1Meta
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())
id0..1string
There are no (further) constraints on this element
Element id
Bundle.meta.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
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.meta.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

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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
versionIdΣ0..1id
There are no (further) constraints on this element
Element id
Bundle.meta.versionId
Short description

Version specific identifier

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.

Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Data type

id

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
lastUpdatedΣ0..1instant
There are no (further) constraints on this element
Element id
Bundle.meta.lastUpdated
Short description

When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Data type

instant

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
sourceΣ0..1uri
There are no (further) constraints on this element
Element id
Bundle.meta.source
Short description

Identifies where the resource comes from

Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance 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.

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.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
profileS Σ0..*canonical(StructureDefinition)Element id
Bundle.meta.profile
Short description

Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Comments

Implementers should be aware that some Canadian jurisdictions require vendors to use meta.profile to declare which FHIR profile(s) and version(s) the resource conforms to.

Data type

canonical(StructureDefinition)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
securityΣ0..*CodingBinding
There are no (further) constraints on this element
Element id
Bundle.meta.security
Short description

Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

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.

Data type

Coding

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
tagΣ0..*Coding
There are no (further) constraints on this element
Element id
Bundle.meta.tag
Short description

Tags applied to this resource

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.

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.

Data type

Coding

Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
implicitRulesΣ ?!0..1uri
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())
language0..1codeBinding
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
maxValueSetAllLanguages
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
identifierS Σ0..1Identifier
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
id0..1string
There are no (further) constraints on this element
Element id
Bundle.identifier.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
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.identifier.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

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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
useΣ ?!0..1codeBinding
There are no (further) constraints on this element
Element id
Bundle.identifier.use
Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

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.

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
typeΣ0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Bundle.identifier.type
Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

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.

Data type

CodeableConcept

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
systemS Σ1..1uri
There are no (further) constraints on this element
Element id
Bundle.identifier.system
Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

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

Identifier.system is always case sensitive.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
valueS Σ1..1string
There are no (further) constraints on this element
Element id
Bundle.identifier.value
Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
periodΣ0..1Period
There are no (further) constraints on this element
Element id
Bundle.identifier.period
Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Period

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
assignerΣ0..1Reference(Organization)
There are no (further) constraints on this element
Element id
Bundle.identifier.assigner
Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

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.

Data type

Reference(Organization)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
typeS Σ1..1codeBindingPatternElement id
Bundle.type
Short description

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.

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
message
Mappings
  • w5: FiveWs.class
timestampS Σ1..1instant
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Σ C0..1unsignedInt
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())
id0..1string
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
extensionC0..*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Σ ?! C0..*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

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
relationΣ1..1string
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..1uri
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())
entryS Σ C2..*BackboneElementElement 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(Profile)

The specific bundle entries that are needed for an eReC Message Bundle.

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

id0..1string
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
extensionC0..*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

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Σ ?! C0..*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

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

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
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())
fullUrlS Σ1..1uri
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())
resourceS Σ1..1Resource
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

searchΣ C0..0BackboneElement
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())
requestΣ C0..0BackboneElement
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())
responseΣ C0..0BackboneElement
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())
MessageS Σ C1..1BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:Message
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())
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:Message.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
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:Message.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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:Message.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

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:Message.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())
fullUrlS Σ1..1uri
There are no (further) constraints on this element
Element id
Bundle.entry:Message.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())
resourceS C1..1MessageHeaderElement id
Bundle.entry:Message.resource
Short description

A resource that describes a message that is exchanged between systems

Definition

The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.

Data type

MessageHeader

Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity. Role, or Act
  • v2: MSH / MSA / ERR
  • rim: Message
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:Message.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())
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:Message.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())
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:Message.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())
FocusS Σ C1..*BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:Focus
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())
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:Focus.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
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:Focus.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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:Focus.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

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:Focus.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())
fullUrlS Σ1..1uri
There are no (further) constraints on this element
Element id
Bundle.entry:Focus.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())
resourceS Σ1..1ServiceRequest, Task, Appointment, CommunicationElement id
Bundle.entry:Focus.resource
Short description

A resource that describes a message that is exchanged between systems

Definition

The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.

Data type

ServiceRequest, Task, Appointment, Communication

searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:Focus.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())
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:Focus.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())
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:Focus.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())
signatureΣ0..1Signature
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())
BundleBundle
There are no (further) constraints on this element
Data type

Bundle

metaS
There are no (further) constraints on this element
Element id
Bundle.meta
profileS
There are no (further) constraints on this element
Element id
Bundle.meta.profile
Comments

Implementers should be aware that some Canadian jurisdictions require vendors to use meta.profile to declare which FHIR profile(s) and version(s) the resource conforms to.

identifierS
There are no (further) constraints on this element
Element id
Bundle.identifier
systemS1..
There are no (further) constraints on this element
Element id
Bundle.identifier.system
valueS1..
There are no (further) constraints on this element
Element id
Bundle.identifier.value
typeSPattern
There are no (further) constraints on this element
Element id
Bundle.type
Pattern
message
timestampS1..
There are no (further) constraints on this element
Element id
Bundle.timestamp
entryS2..
There are no (further) constraints on this element
Element id
Bundle.entry
Slicing

Unordered, Open, by resource(Profile)

The specific bundle entries that are needed for an eReC Message Bundle.

(All Slices)
The requirements in this element apply to all slices

fullUrlS1..
There are no (further) constraints on this element
Element id
Bundle.entry.fullUrl
resourceS1..
There are no (further) constraints on this element
Element id
Bundle.entry.resource
search..0
There are no (further) constraints on this element
Element id
Bundle.entry.search
request..0
There are no (further) constraints on this element
Element id
Bundle.entry.request
response..0
There are no (further) constraints on this element
Element id
Bundle.entry.response
MessageS1..1
There are no (further) constraints on this element
Element id
Bundle.entry:Message
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).

resourceMessageHeader
There are no (further) constraints on this element
Element id
Bundle.entry:Message.resource
Short description

A resource that describes a message that is exchanged between systems

Definition

The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.

Data type

MessageHeader

FocusS1..
There are no (further) constraints on this element
Element id
Bundle.entry:Focus
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).

resourceServiceRequest, Task, Appointment, Communication
There are no (further) constraints on this element
Element id
Bundle.entry:Focus.resource
Short description

A resource that describes a message that is exchanged between systems

Definition

The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.

Data type

ServiceRequest, Task, Appointment, Communication

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="CA-eReC-Bundle" />
<url value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Bundle" />
<name value="Bundle" />
<status value="draft" />
<description value="The bundle resource is used to package a collection of resources into a single instance. This resource would be used for referral in the following contexts: - Sending a set of resources as part of a message exchange - Grouping a self-contained set of resources to act as an exchangeable and persistable collection with clinical integrity , e.g. a clinical document" />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="Bundle" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Bundle" />
<derivation value="constraint" />
<differential>
<element id="Bundle.meta">
<path value="Bundle.meta" />
<mustSupport value="true" />
</element>
<element id="Bundle.meta.profile">
<path value="Bundle.meta.profile" />
<comment value="Implementers should be aware that some Canadian jurisdictions require vendors to use meta.profile to declare which FHIR profile(s) and version(s) the resource conforms to." />
<mustSupport value="true" />
</element>
<element id="Bundle.identifier">
<path value="Bundle.identifier" />
<mustSupport value="true" />
</element>
<element id="Bundle.identifier.system">
<path value="Bundle.identifier.system" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.identifier.value">
<path value="Bundle.identifier.value" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.type">
<path value="Bundle.type" />
<patternCode value="message" />
<mustSupport value="true" />
</element>
<element id="Bundle.timestamp">
<path value="Bundle.timestamp" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry">
<path value="Bundle.entry" />
<slicing>
<discriminator>
<type value="profile" />
<path value="resource" />
</discriminator>
<description value="The specific bundle entries that are needed for an eReC Message Bundle." />
<rules value="open" />
</slicing>
<min value="2" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry.fullUrl">
<path value="Bundle.entry.fullUrl" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<mustSupport value="true" />
</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>
<element id="Bundle.entry:Message">
<path value="Bundle.entry" />
<sliceName value="Message" />
<short value="Entry in the bundle - will have a resource or information" />
<definition value="An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only)." />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry:Message.resource">
<path value="Bundle.entry.resource" />
<short value="A resource that describes a message that is exchanged between systems" />
<definition value="The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle." />
<type>
<code value="Resource" />
<profile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-MessageHeader" />
</type>
</element>
<element id="Bundle.entry:Focus">
<path value="Bundle.entry" />
<sliceName value="Focus" />
<short value="Entry in the bundle - will have a resource or information" />
<definition value="An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only)." />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry:Focus.resource">
<path value="Bundle.entry.resource" />
<short value="A resource that describes a message that is exchanged between systems" />
<definition value="The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle." />
<type>
<code value="Resource" />
<profile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-ServiceRequest" />
<profile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Task" />
<profile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Appointment" />
<profile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Communication" />
</type>
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "CA-eReC-Bundle",
"url": "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Bundle",
"name": "Bundle",
"status": "draft",
"description": "The bundle resource is used to package a collection of resources into a single instance. This resource would be used for referral in the following contexts: - Sending a set of resources as part of a message exchange - Grouping a self-contained set of resources to act as an exchangeable and persistable collection with clinical integrity , e.g. a clinical document",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Bundle",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Bundle",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Bundle.meta",
"path": "Bundle.meta",
"mustSupport": true
},
{
"id": "Bundle.meta.profile",
"path": "Bundle.meta.profile",
"mustSupport": true,
"comment": "Implementers should be aware that some Canadian jurisdictions require vendors to use meta.profile to declare which FHIR profile(s) and version(s) the resource conforms to."
},
{
"id": "Bundle.identifier",
"path": "Bundle.identifier",
"mustSupport": true
},
{
"id": "Bundle.identifier.system",
"path": "Bundle.identifier.system",
"min": 1,
"mustSupport": true
},
{
"id": "Bundle.identifier.value",
"path": "Bundle.identifier.value",
"min": 1,
"mustSupport": true
},
{
"id": "Bundle.type",
"path": "Bundle.type",
"patternCode": "message",
"mustSupport": true
},
{
"id": "Bundle.timestamp",
"path": "Bundle.timestamp",
"min": 1,
"mustSupport": true
},
{
"id": "Bundle.entry",
"path": "Bundle.entry",
"min": 2,
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resource"
}
],
"description": "The specific bundle entries that are needed for an eReC Message Bundle.",
"rules": "open"
},
"mustSupport": true
},
{
"id": "Bundle.entry.fullUrl",
"path": "Bundle.entry.fullUrl",
"min": 1,
"mustSupport": true
},
{
"id": "Bundle.entry.resource",
"path": "Bundle.entry.resource",
"min": 1,
"mustSupport": true
},
{
"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"
},
{
"id": "Bundle.entry:Message",
"path": "Bundle.entry",
"sliceName": "Message",
"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",
"mustSupport": true
},
{
"id": "Bundle.entry:Message.resource",
"path": "Bundle.entry.resource",
"short": "A resource that describes a message that is exchanged between systems",
"definition": "The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.",
"type": [
{
"code": "Resource",
"profile": [
"http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-MessageHeader"
]
}
]
},
{
"id": "Bundle.entry:Focus",
"path": "Bundle.entry",
"sliceName": "Focus",
"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,
"mustSupport": true
},
{
"id": "Bundle.entry:Focus.resource",
"path": "Bundle.entry.resource",
"short": "A resource that describes a message that is exchanged between systems",
"definition": "The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.",
"type": [
{
"code": "Resource",
"profile": [
"http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-ServiceRequest",
"http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Task",
"http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Appointment",
"http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Communication"
]
}
]
}
]
}
}

Usage

The bundle resource is used to package a collection of resources into a single instance. This resource would be used for referral in the following contexts:

  • Sending a set of resources as part of a message exchange
  • Grouping a self-contained set of resources to act as an exchangeable and persistable collection with clinical integrity - e.g. a clinical document

The Bundle SHALL have an entry for each of the FHIR Resources required to convey information about the business event, starting with the MessageHeader which SHALL always be first.

Notes

The following rules apply to message type Bundles.

.id

  • used to uniquely identify a message instance
  • populate this element with a UUID each time a message is sent
  • note: a FHIR message contains two identifiers that are unique within the message stream, rules:
    • a Bundle.id (this element) SHALL be assigned each time the message is sent
    • a MessageHeader.id SHALL be assigned when the message is created

.type

  • Declares that the Bundle contains a message
  • Populate with a fixed value: message

.timestamp

  • Populate with the instant in time when the Bundle was created
  • Format: YYYY-MM-DDThh:mm:ss.sss+zz:zz (e.g. 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z).

.entry

  • Create an entry for each of the FHIR Resources required to convey information about the business event
  • The MessageHeader SHALL be the first entry

.entry.fullUrl

  • Each entry in the Bundle SHALL have a fullUrl which is the identity of the resource in the entry
  • If a persistent identity for the resource is not available to use in the Bundle, a UUID SHOULD be used (urn:uuid:...)

.entry.resource

  • SHALL be populated with the resource for this entry

.entry.Message

  • SHALL have at least one messageHeader

.entry.Focus

  • SHALL have at least one focus resource, same as the focus indicated in the messagerheader.focus

IG © based on FHIR R4 | Package package:ca.infoway.io.erec@1.1.0-dft
HL7® and FHIR® are the registered trademarks of Health Level Seven International