3.58 StructureDefinition: Interaction Bundle - Batch Clear Message Queue Request
The official URL for this profile is:
http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-request
The following details each step in the polling process and the associated HTTP action. The actual URL’s will be provided to vendors in a separate document.
| Polling step | HTTP action (Example URL) | HTTP Payload Profile | Example |
|---|---|---|---|
| Polling query for waiting messages |
GET https://site2.api.sharedhealth.exchange/rest/v1/preconf/THP/mailbox_vs1/Bundle
|
N/A | N/A |
| Polling query response | Response to GET with FHIR Bundle payload | Bundle Poll Response | Polling Query Response examples |
| Clear Queue batch request |
POST https://site2.api.sharedhealth.exchange/rest/v1/preconf/THP/mailbox_vs1/Bundle
|
Batch Delete Request | Clear queue request |
| Clear Queue batch response | Response to POST with Bundle payload | Batch Delete Response | Clear queue response |
3.58.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
>
This structure is derived from Shared Health Bundle
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Bundle | 0..* | Shared Health Bundle | bdl-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..1 | id | Definition: 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..1 | 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. |
 profile | 1..* | uri | Slice: 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..1 | uri | Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-request 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-clear-queue-request |
| tag | 1..* | Coding | 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" 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..1 | Coding | Binding: 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. |
  system | 1..1 | uri | Fixed 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..1 | code | Fixed 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..1 | code | Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used. Fixed Value: batch Definition: Indicates the purpose of this bundle- how it was intended to be used. Comments: Fixed value: batch |
| entry | 1..* | BackboneElement | bdl-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 Definition: An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only). |
| request | 1..1 | BackboneElement | Definition: Additional information about how this entry should be processed as part of a transaction. |
| method | 1..1 | code | Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). Fixed Value: DELETE Definition: The HTTP verb for this entry in either a change history, or a transaction/ transaction response. Comments: Fixed value: DELETE |
| url | 1..1 | uri | Definition: The URL for the message to be deleted, relative to the root (the address to which the request is posted). I.e. Bundle/[bundle identifier] Comments: Conformance Rule: The URL must be populated with the corresponding fullUrl value that was returned in the polling response for the bundle that needs to be deleted from the inbox. |
This structure is derived from Shared Health Bundle
Summary
Mandatory: 9 elements
Must-Support: 10 elements
Fixed Value: 4 elements
Prohibited: 9 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Bundle | S | 0..* | Shared Health Bundle | Contains a collection of resources |
 meta | S | 1..1 | Meta | Metadata about the resource |
 profile | S | 1..* | (Slice Definition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:value |
  profile:profile | S | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-request |
 tag:version | S | 1..1 | Coding | Tags applied to this resource |
| code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Shared5.0 |
| type | S | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: batch |
| total | 0..0 | |||
| entry | S | 1..* | BackboneElement | Entry in the bundle - will have a resource, or information |
| fullUrl | 0..0 | |||
| resource | 0..0 | |||
| search | 0..0 | |||
| request | S | 1..1 | BackboneElement | Transaction Related Information |
| method | S | 1..1 | code | GET | POST | PUT | DELETE Fixed Value: DELETE |
| url | S | 1..1 | uri | URL for HTTP equivalent of this entry |
| ifNoneMatch | 0..0 | |||
| ifModifiedSince | 0..0 | |||
| ifMatch | 0..0 | |||
| ifNoneExist | 0..0 | |||
| response | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | SΣI | 0..* | Shared Health Bundle | Contains a collection of resources |
 id | SΣ | 0..1 | id | Logical id of this artifact |
 meta | SΣ | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When 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..1 | uri | Profiles this resource claims to conform to Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-request |
| security | Σ | 0..* | Coding | Security 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..1 | Coding | Tags applied to this resource Binding: SharedSpecificationVersion (20210501) (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Shared5.0 |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
| type | SΣ | 1..1 | code | document | 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: batch |
| link | Σ | 0..* | BackboneElement | Links related to this Bundle |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| relation | Σ | 1..1 | string | http://www.iana.org/assignments/link-relations/link-relations.xhtml |
| url | Σ | 1..1 | uri | Reference details for the link |
| entry | SΣI | 1..* | BackboneElement | Entry in the bundle - will have a resource, or information |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| link | 0..* | See link (Bundle) | Links related to this entry | |
| request | SΣI | 1..1 | BackboneElement | Transaction Related Information |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| method | SΣ | 1..1 | code | GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). Fixed Value: DELETE |
| url | SΣ | 1..1 | uri | URL for HTTP equivalent of this entry |
| signature | Σ | 0..1 | Signature | Digital Signature |
| Documentation for this format | ||||
Grid View
This structure is derived from Shared Health Bundle
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Bundle | 0..* | Shared Health Bundle | bdl-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..1 | id | Definition: 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..1 | 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. |
| profile | 1..* | uri | Slice: 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..1 | uri | Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-request 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-clear-queue-request |
| tag | 1..* | Coding | 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" 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..1 | Coding | Binding: 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. |
| system | 1..1 | uri | Fixed 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..1 | code | Fixed 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..1 | code | Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used. Fixed Value: batch Definition: Indicates the purpose of this bundle- how it was intended to be used. Comments: Fixed value: batch |
| entry | 1..* | BackboneElement | bdl-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 Definition: An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only). |
| request | 1..1 | BackboneElement | Definition: Additional information about how this entry should be processed as part of a transaction. |
| method | 1..1 | code | Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). Fixed Value: DELETE Definition: The HTTP verb for this entry in either a change history, or a transaction/ transaction response. Comments: Fixed value: DELETE |
| url | 1..1 | uri | Definition: The URL for the message to be deleted, relative to the root (the address to which the request is posted). I.e. Bundle/[bundle identifier] Comments: Conformance Rule: The URL must be populated with the corresponding fullUrl value that was returned in the polling response for the bundle that needs to be deleted from the inbox. |
This structure is derived from Shared Health Bundle
Summary
Mandatory: 9 elements
Must-Support: 10 elements
Fixed Value: 4 elements
Prohibited: 9 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | S | 0..* | Shared Health Bundle | Contains a collection of resources |
| meta | S | 1..1 | Meta | Metadata about the resource |
| profile | S | 1..* | (Slice Definition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:value |
| profile:profile | S | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-request |
| tag:version | S | 1..1 | Coding | Tags applied to this resource |
| code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Shared5.0 |
| type | S | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: batch |
| total | 0..0 | |||
| entry | S | 1..* | BackboneElement | Entry in the bundle - will have a resource, or information |
| fullUrl | 0..0 | |||
| resource | 0..0 | |||
| search | 0..0 | |||
| request | S | 1..1 | BackboneElement | Transaction Related Information |
| method | S | 1..1 | code | GET | POST | PUT | DELETE Fixed Value: DELETE |
| url | S | 1..1 | uri | URL for HTTP equivalent of this entry |
| ifNoneMatch | 0..0 | |||
| ifModifiedSince | 0..0 | |||
| ifMatch | 0..0 | |||
| ifNoneExist | 0..0 | |||
| response | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | SΣI | 0..* | Shared Health Bundle | Contains a collection of resources |
| id | SΣ | 0..1 | id | Logical id of this artifact |
| meta | SΣ | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When 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..1 | uri | Profiles this resource claims to conform to Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-request |
| security | Σ | 0..* | Coding | Security 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..1 | Coding | Tags applied to this resource Binding: SharedSpecificationVersion (20210501) (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Shared5.0 |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
| type | SΣ | 1..1 | code | document | 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: batch |
| link | Σ | 0..* | BackboneElement | Links related to this Bundle |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| relation | Σ | 1..1 | string | http://www.iana.org/assignments/link-relations/link-relations.xhtml |
| url | Σ | 1..1 | uri | Reference details for the link |
| entry | SΣI | 1..* | BackboneElement | Entry in the bundle - will have a resource, or information |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| link | 0..* | See link (Bundle) | Links related to this entry | |
| request | SΣI | 1..1 | BackboneElement | Transaction Related Information |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| method | SΣ | 1..1 | code | GET | POST | PUT | DELETE Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). Fixed Value: DELETE |
| url | SΣ | 1..1 | uri | URL for HTTP equivalent of this entry |
| signature | Σ | 0..1 | Signature | Digital Signature |
| Documentation for this format | ||||
Other representations of profile: Schematron
3.58.3 Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet / Code | ||||||||||||||||||||||||||||||||||||||||||||
| Bundle.meta.security | extensible | All Security Labels | ||||||||||||||||||||||||||||||||||||||||||||
| Bundle.meta.tag | example | |||||||||||||||||||||||||||||||||||||||||||||
| Bundle.meta.tag:version | required | Fixed Value: Shared5.0
| Bundle.language | required | http://tools.ietf.org/html/bcp47 | Bundle.type | required | Fixed Value: batch | Bundle.entry.search.mode | required | SearchEntryMode | Bundle.entry.request.method | required | Fixed Value: DELETE | 3.58.4 ConstraintsConstraints
|