Shared Health Specification and Guide Version 5.0

 

The official URL for this profile is:

http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-poll-response

Download Excel representation

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

>

This structure is derived from Shared Health Bundle - Query Response

NameCard.TypeConstraints and Usage
.  Bundle 0..*Shared Health Bundle - Query Responsebdl-2: entry.search only when a search
bdl-1: total only when a search or history
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId
bdl-3: entry.request only for some types of bundles
bdl-4: entry.response only for some types of bundles
Definition:
A container for a collection of resources.

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


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.

..  meta 1..1MetaDefinition:
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.

...  profile 1..*uriSlice: Unordered, Open by value:value
Definition:
A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].


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.

...  profile
       (profile)
1..1uriFixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-poll-response
Definition:
A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].


Comments:
Fixed value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-poll-response

...  tag 1..*CodingSlice: Unordered, Open by value:system
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


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.

...  tag
       (version)
1..1CodingBinding: SharedSpecificationVersion (20210501) (required)
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:
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)



....  system 1..1uriFixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
Definition:
The identification of the code system that defines the meaning of the symbol in the code.


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

....  code 1..1codeFixed Value: Shared5.0
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).


Comments:
Fixed value: Shared5.0

..  type 1..1codeBinding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used.


Fixed Value: searchset
Definition:
Indicates the purpose of this bundle- how it was intended to be used.


Comments:
Fixed value: searchset

..  total 0..1unsignedIntDefinition:
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).


Comments:
Only used if the bundle is a search result set.

..  link 1..*BackboneElementSlice: Unordered, Open by value:relation
Definition:
A series of links that provide context to this bundle.

..  link
     (self)
1..1BackboneElementDefinition:
A series of links that provide context to this bundle.


Comments:
Echoes the submitted query, including only those parameters which were processed by the server. This allows for the possibility that the server might not support all of the parameters submitted by the client.

...  relation 1..1stringFixed Value: self
Definition:
A name which details the functional use for this link - see [[http://www.iana.org/assignments/link-relations/link-relations.xhtml]].


Comments:
Fixed value: self

...  url 1..1uriDefinition:
The reference details for the link.

..  link
     (next)
0..1BackboneElementDefinition:
A series of links that provide context to this bundle.


Comments:
For Provider Registry Organization query, this element is not curently supported.

...  relation 1..1stringFixed Value: next
Definition:
A name which details the functional use for this link - see [[http://www.iana.org/assignments/link-relations/link-relations.xhtml]].


Comments:
Fixed value: next

...  url 1..1uriDefinition:
The reference details for the link.


Comments:
If present, indicates additional results are available and can be retrieved by performing a GET on this URL

..  entry 0..100BackboneElementbdl-5: must be a resource unless there's a request or response
bdl-6: The fullUrl element must be present when a resource is present, and not present otherwise
entryIsMessage: Entries must be Bundles declaring profile-bundle-message
Definition:
An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).

...  fullUrl 1..1uriDefinition:
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.


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.

...  resource 1..1ResourceDefinition:
The Resources for the entry.

This structure is derived from Shared Health Bundle - Query Response

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 7 elements
Fixed Value: 2 elements

Slices

This structure defines the following Slices:

  • The element Bundle.meta.profile is sliced based on the value of value:value

This structure is derived from Shared Health Bundle - Query Response

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle S0..*Shared Health Bundle - Query ResponseContains a collection of resources
... meta S1..1MetaMetadata about the resource
.... profile S1..*(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:profile S1..1uriProfiles this resource claims to conform to
Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-poll-response
..... tag:version S1..1CodingTags applied to this resource
...... code S1..1codeSymbol in syntax defined by the system
Fixed Value: Shared5.0
... entry SI0..100BackboneElementEntry in the bundle - will have a resource, or information
entryIsMessage: Entries must be Bundles declaring profile-bundle-message
.... resource S1..1ResourceA resource in the bundle

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle SΣI0..*Shared Health Bundle - Query ResponseContains a collection of resources
... id SΣ0..1idLogical id of this artifact
... meta SΣ1..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile SΣ1..*(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:profile SΣ1..1uriProfiles this resource claims to conform to

Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-poll-response
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag SΣ1..*(Slice Definition)Tags applied to this resource
Slice: Unordered, Open by value:system
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:version SΣ1..1CodingTags applied to this resource
Binding: SharedSpecificationVersion (20210501) (required)
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: Shared5.0
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... type SΣ1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used.


Fixed Value: searchset
... total SΣI0..1unsignedIntIf search, the total number of matches
... link SΣ1..*(Slice Definition)Links related to this Bundle
Slice: Unordered, Open by value:relation
.... link:All Slices Content/Rules for all slices
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... relation Σ1..1stringhttp://www.iana.org/assignments/link-relations/link-relations.xhtml
..... url Σ1..1uriReference details for the link
.... link:self SΣ1..1BackboneElementLinks related to this Bundle
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... relation SΣ1..1stringhttp://www.iana.org/assignments/link-relations/link-relations.xhtml
Fixed Value: self
..... url SΣ1..1uriReference details for the link
.... link:next SΣ0..1BackboneElementLinks related to this Bundle
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... relation SΣ1..1stringhttp://www.iana.org/assignments/link-relations/link-relations.xhtml
Fixed Value: next
..... url SΣ1..1uriReference details for the link
... entry SΣI0..100BackboneElementEntry in the bundle - will have a resource, or information
entryIsMessage: Entries must be Bundles declaring profile-bundle-message
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... link 0..*See link (Bundle)Links related to this entry
.... fullUrl SΣ1..1uriAbsolute URL for resource (server address, or UUID/OID)
.... resource SΣ1..1ResourceA resource in the bundle
.... search ΣI0..1BackboneElementSearch related information
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement.

..... score Σ0..1decimalSearch ranking (between 0 and 1)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

Grid View

This structure is derived from Shared Health Bundle - Query Response

NameCard.TypeConstraints and Usage
.  Bundle 0..*Shared Health Bundle - Query Responsebdl-2: entry.search only when a search
bdl-1: total only when a search or history
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId
bdl-3: entry.request only for some types of bundles
bdl-4: entry.response only for some types of bundles
Definition:
A container for a collection of resources.

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


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.

..  meta 1..1MetaDefinition:
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.

...  profile 1..*uriSlice: Unordered, Open by value:value
Definition:
A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].


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.

...  profile
       (profile)
1..1uriFixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-poll-response
Definition:
A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].


Comments:
Fixed value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-poll-response

...  tag 1..*CodingSlice: Unordered, Open by value:system
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


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.

...  tag
       (version)
1..1CodingBinding: SharedSpecificationVersion (20210501) (required)
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:
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)



....  system 1..1uriFixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
Definition:
The identification of the code system that defines the meaning of the symbol in the code.


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

....  code 1..1codeFixed Value: Shared5.0
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).


Comments:
Fixed value: Shared5.0

..  type 1..1codeBinding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used.


Fixed Value: searchset
Definition:
Indicates the purpose of this bundle- how it was intended to be used.


Comments:
Fixed value: searchset

..  total 0..1unsignedIntDefinition:
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).


Comments:
Only used if the bundle is a search result set.

..  link 1..*BackboneElementSlice: Unordered, Open by value:relation
Definition:
A series of links that provide context to this bundle.

..  link
     (self)
1..1BackboneElementDefinition:
A series of links that provide context to this bundle.


Comments:
Echoes the submitted query, including only those parameters which were processed by the server. This allows for the possibility that the server might not support all of the parameters submitted by the client.

...  relation 1..1stringFixed Value: self
Definition:
A name which details the functional use for this link - see [[http://www.iana.org/assignments/link-relations/link-relations.xhtml]].


Comments:
Fixed value: self

...  url 1..1uriDefinition:
The reference details for the link.

..  link
     (next)
0..1BackboneElementDefinition:
A series of links that provide context to this bundle.


Comments:
For Provider Registry Organization query, this element is not curently supported.

...  relation 1..1stringFixed Value: next
Definition:
A name which details the functional use for this link - see [[http://www.iana.org/assignments/link-relations/link-relations.xhtml]].


Comments:
Fixed value: next

...  url 1..1uriDefinition:
The reference details for the link.


Comments:
If present, indicates additional results are available and can be retrieved by performing a GET on this URL

..  entry 0..100BackboneElementbdl-5: must be a resource unless there's a request or response
bdl-6: The fullUrl element must be present when a resource is present, and not present otherwise
entryIsMessage: Entries must be Bundles declaring profile-bundle-message
Definition:
An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).

...  fullUrl 1..1uriDefinition:
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.


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.

...  resource 1..1ResourceDefinition:
The Resources for the entry.

This structure is derived from Shared Health Bundle - Query Response

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 7 elements
Fixed Value: 2 elements

Slices

This structure defines the following Slices:

  • The element Bundle.meta.profile is sliced based on the value of value:value

Differential View

This structure is derived from Shared Health Bundle - Query Response

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle S0..*Shared Health Bundle - Query ResponseContains a collection of resources
... meta S1..1MetaMetadata about the resource
.... profile S1..*(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:profile S1..1uriProfiles this resource claims to conform to
Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-poll-response
..... tag:version S1..1CodingTags applied to this resource
...... code S1..1codeSymbol in syntax defined by the system
Fixed Value: Shared5.0
... entry SI0..100BackboneElementEntry in the bundle - will have a resource, or information
entryIsMessage: Entries must be Bundles declaring profile-bundle-message
.... resource S1..1ResourceA resource in the bundle

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle SΣI0..*Shared Health Bundle - Query ResponseContains a collection of resources
... id SΣ0..1idLogical id of this artifact
... meta SΣ1..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile SΣ1..*(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:profile SΣ1..1uriProfiles this resource claims to conform to

Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-poll-response
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag SΣ1..*(Slice Definition)Tags applied to this resource
Slice: Unordered, Open by value:system
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:version SΣ1..1CodingTags applied to this resource
Binding: SharedSpecificationVersion (20210501) (required)
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: Shared5.0
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... type SΣ1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used.


Fixed Value: searchset
... total SΣI0..1unsignedIntIf search, the total number of matches
... link SΣ1..*(Slice Definition)Links related to this Bundle
Slice: Unordered, Open by value:relation
.... link:All Slices Content/Rules for all slices
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... relation Σ1..1stringhttp://www.iana.org/assignments/link-relations/link-relations.xhtml
..... url Σ1..1uriReference details for the link
.... link:self SΣ1..1BackboneElementLinks related to this Bundle
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... relation SΣ1..1stringhttp://www.iana.org/assignments/link-relations/link-relations.xhtml
Fixed Value: self
..... url SΣ1..1uriReference details for the link
.... link:next SΣ0..1BackboneElementLinks related to this Bundle
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... relation SΣ1..1stringhttp://www.iana.org/assignments/link-relations/link-relations.xhtml
Fixed Value: next
..... url SΣ1..1uriReference details for the link
... entry SΣI0..100BackboneElementEntry in the bundle - will have a resource, or information
entryIsMessage: Entries must be Bundles declaring profile-bundle-message
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... link 0..*See link (Bundle)Links related to this entry
.... fullUrl SΣ1..1uriAbsolute URL for resource (server address, or UUID/OID)
.... resource SΣ1..1ResourceA resource in the bundle
.... search ΣI0..1BackboneElementSearch related information
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement.

..... score Σ0..1decimalSearch ranking (between 0 and 1)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Constraints

PathConformanceValueSet / Code
Bundle.meta.securityextensibleAll Security Labels
Bundle.meta.tagexample
Bundle.meta.tag:versionrequiredFixed Value: Shared5.0
Bundle.languagerequiredhttp://tools.ietf.org/html/bcp47
Bundle.typerequiredFixed Value: searchset
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb
IdPathDetailsRequirements
bdl-2Bundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-1Bundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-7BundleFullUrl 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()
bdl-3Bundleentry.request only for some types of bundles
: entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history'
bdl-4Bundleentry.response only for some types of bundles
: entry.response.empty() or type = 'batch-response' or type = 'transaction-response'
bdl-5Bundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-6Bundle.entryThe fullUrl element must be present when a resource is present, and not present otherwise
: fullUrl.empty() xor resource.exists()
entryIsMessageBundle.entryEntries must be Bundles declaring profile-bundle-message
: resource.meta.profile.where(matches('http:\\/\\/sharedhealth\\.exchange\\/fhir\\/StructureDefinition\\/interaction-bundle-(301|302|901|997|998)') or matches('http:\\/\\/prescribeit\\.ca\\/fhir\\/StructureDefinition\\/interaction-bundle-(101|102|201|999)')).exists()
© 2017+ . Based on FHIR version (1.4.0-8139). IG generated on Fri, Feb 4, 2022 12:22-0500. | IG Change History