Shared Health Specification and Guide Version 5.0

 

Definitions for the profile-bundle-message Profile.

1. Bundle
Definition

A container for a collection of resources.

Control0..*
Must Supporttrue
Max Length0
InvariantsDefined on this element
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 only for some types of bundles (: entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history')
bdl-4: entry.response only for some types of bundles (: entry.response.empty() or type = 'batch-response' or type = 'transaction-response')
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (: entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct())
groupIdsSame: GroupIdentifier values must all be the same within a message (: entry.resource.extension('http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier').value.value.distinct().count()<=1)
headerExists: First entry must be a MessageHeader (: entry[0].resource.is(MessageHeader))
max1patient: Cannot have no more than 1 patient in one message (: entry.select(resource as Patient).count()<=1)
2. Bundle.id
Definition

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

Control0..1
Typeid
Must Supporttrue
Comments

Usage Note: This value is assigned by the PrescribeIT® system upon receipt of a bundle and returned synchronously in the response to that bundle. This ID should not be confused with the traceID that is also returned in the response and is generally used when diagnosing message failures within the PrescribeIT® system logs. The Bundle.id is also used by receiving systems to remove the bundle from their inbox after they have successfully retrieved the bundle.

Max Length0
3. Bundle.meta
Definition

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

Control1..1
TypeMeta
Must Supporttrue
Max Length0
4. Bundle.meta.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
5. Bundle.meta.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
6. Bundle.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.

Control0..1
Typeid
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.

Max Length0
7. Bundle.meta.lastUpdated
Definition

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

Control0..1
Typeinstant
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.

Max Length0
8. Bundle.meta.profile
Definition

A list of profiles StructureDefinitions that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control1..*
Typeuri
Must Supporttrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Max Length0
SlicingThis element introduces a set of slices on Bundle.meta.profile. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ value
9. Bundle.meta.profile:baseProfile
SliceNamebaseProfile
Definition

A list of profiles StructureDefinitions that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control1..1
Typeuri
Must Supporttrue
Comments

Fixed value: http://sharedhealth.exchange/fhir/StructureDefinition/profile-bundle-message

Max Length0
Fixed Valuehttp://sharedhealth.exchange/fhir/StructureDefinition/profile-bundle-message
10. Bundle.meta.security
Definition

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

Control0..*
BindingThe codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System.
TypeCoding
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.

Max Length0
11. 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.

Control1..*
Binding

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

TypeCoding
Must Supporttrue
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.

Max Length0
SlicingThis element introduces a set of slices on Bundle.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
12. Bundle.meta.tag:version
SliceNameversion
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.

Control1..1
BindingThe codes SHALL be taken from SharedSpecificationVersion (20210501)
TypeCoding
Must Supporttrue
Comments

Usage Note: This the version of the specification the Bundle claims to be conformant with.

Usage Note: Only these 2 situations are not enforced by FHIR Validator:

1) Non-routed EMR/PMS Inbox messages and Clear Queue Request that is sent only to Central Switch; and

2) Synchronous messages generated by Central Switch (Errors with only OperationOutcome profile and Clear Queue Response)

Max Length0
13. Bundle.meta.tag:version.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
14. Bundle.meta.tag:version.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
15. Bundle.meta.tag:version.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Must Supporttrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion

Max Length0
Fixed Valuehttps://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
16. Bundle.meta.tag:version.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Max Length0
17. Bundle.meta.tag:version.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Max Length0
18. Bundle.meta.tag:version.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Max Length0
19. Bundle.meta.tag:version.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Max Length0
20. 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.

Control0..1
Typeuri
Is Modifiertrue
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 as much as possible.

Max Length0
21. Bundle.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from http://tools.ietf.org/html/bcp47 A human language.
Typecode
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).

Max Length0
22. Bundle.type
Definition

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

Control1..1
BindingThe codes SHALL be taken from BundleType Indicates the purpose of a bundle - how it was intended to be used.
Typecode
Must Supporttrue
Comments

Fixed value: message

Max Length0
Fixed Valuemessage
23. Bundle.total
Definition

If a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle).

Control0..1 This element is affected by the following invariants: bdl-1
TypeunsignedInt
Comments

Only used if the bundle is a search result set.

Max Length0
24. Bundle.link
Definition

A series of links that provide context to this bundle.

Control0..*
TypeBackboneElement
Max Length0
25. Bundle.link.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
26. Bundle.link.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
27. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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

Max Length0
28. 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]].

Control1..1
Typestring
Max Length0
29. Bundle.link.url
Definition

The reference details for the link.

Control1..1
Typeuri
Max Length0
30. Bundle.entry
Definition

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

Control1..*
TypeBackboneElement
Must Supporttrue
Max Length0
InvariantsDefined on this element
bdl-5: must be a resource unless there's a request or response (: resource.exists() or request.exists() or response.exists())
bdl-6: The fullUrl element must be present when a resource is present, and not present otherwise (: fullUrl.empty() xor resource.exists())
tbdl-1: Full URL must end with resource id when present (: fullUrl.exists().not() or resource.id.exists().not() or fullUrl.endsWith($this.resource.id))
31. Bundle.entry.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
32. Bundle.entry.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
33. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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

Max Length0
34. Bundle.entry.link
Definition

A series of links that provide context to this entry.

Control0..0
TypeSee ttp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
35. Bundle.entry.fullUrl
Definition

The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: * fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) * Results from operations might involve resources that are not identified.

Control1..1
Typeuri
Must Supporttrue
Comments

fullUrl may not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the absolute URL may not end with the logical id of the resource (Resource.id), but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then it SHALL end with the Resource.id.

Max Length0
36. Bundle.entry.resource
Definition

The Resources for the entry.

Control1..1
TypeResource
Must Supporttrue
Max Length0
37. Bundle.entry.search
Definition

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

Control0..0 This element is affected by the following invariants: bdl-2
TypeBackboneElement
Max Length0
38. Bundle.entry.search.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
39. Bundle.entry.search.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
40. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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

Max Length0
41. 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.

Control0..1
BindingThe codes SHALL be taken from SearchEntryMode Why an entry is in the result set - whether it's included as a match or because of an _include requirement.
Typecode
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.

Max Length0
42. Bundle.entry.search.score
Definition

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

Control0..1
Typedecimal
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.

Max Length0
43. Bundle.entry.request
Definition

Additional information about how this entry should be processed as part of a transaction.

Control0..0 This element is affected by the following invariants: bdl-3
TypeBackboneElement
Max Length0
44. Bundle.entry.request.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
45. Bundle.entry.request.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
46. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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

Max Length0
47. Bundle.entry.request.method
Definition

The HTTP verb for this entry in either a change history, or a transaction/ transaction response.

Control1..1
BindingThe codes SHALL be taken from HTTPVerb HTTP verbs (in the HTTP command line).
Typecode
Max Length0
48. Bundle.entry.request.url
Definition

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

Control1..1
Typeuri
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]".

Max Length0
49. Bundle.entry.request.ifNoneMatch
Definition

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

Control0..1
Typestring
Max Length0
50. Bundle.entry.request.ifModifiedSince
Definition

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

Control0..1
Typeinstant
Max Length0
51. Bundle.entry.request.ifMatch
Definition

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

Control0..1
Typestring
Max Length0
52. Bundle.entry.request.ifNoneExist
Definition

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

Control0..1
Typestring
Max Length0
53. Bundle.entry.response
Definition

Additional information about how this entry should be processed as part of a transaction.

Control0..0 This element is affected by the following invariants: bdl-4
TypeBackboneElement
Max Length0
54. Bundle.entry.response.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
55. Bundle.entry.response.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
56. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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

Max Length0
57. 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.

Control1..1
Typestring
Max Length0
58. Bundle.entry.response.location
Definition

The location header created by processing this operation.

Control0..1
Typeuri
Max Length0
59. Bundle.entry.response.etag
Definition

The etag for the resource, it the operation for the entry produced a versioned resource.

Control0..1
Typestring
Comments

This has to match the version id in the header if a resource is included.

Max Length0
60. Bundle.entry.response.lastModified
Definition

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

Control0..1
Typeinstant
Comments

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

Max Length0
61. Bundle.signature
Definition

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

Control0..1
TypeSignature
Requirements

This element allows capturing signatures on documents. It also allows signatures on messages, transactions or even query responses. It may support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.

Comments

The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.

Max Length0