Shared Health Specification and Guide Version 5.0

 

The official URL for this profile is:

http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-request

The Clear Message Queue Request is used in the context of 3 different scenarios including;

  1. Clearing bundles that have been retrieved from the inbox through the polling process
    • Further details on polling can be found in the Polling for Messages section.
    • Given that a single of multiple bundles and be retrieved during the polling process the clear message can also be sent to clear multiple bundles at one time
  2. Clearing either a deferred or held bundle that has been retrieved using the retrieval query (PMS only)
    • Further details on retrieving deferred or held bundles can be found in the Retrieving Deferred or Held Bundles section.
    • Given that only one deferred or bundle is retrieved at a time the clear message is sent only for the single deferred bundle that is retrieved
  3. Returning a deferred bundle back to PrescribeIT® that has previously been retrieved and cleared using the retrieval query (PMS Only)
    • After a deferred bundle has been retrieved, the pharmacy user may need to return the retrieved deferred bundle back to PrescribeIT® for various reasoning including; the patient may change their mind and want to go to a different pharmacy, the pharmacy may not have the product in stock and asks the patient to go to another pharmacy, etc.
    • Only retrieved deferred bundles can be returned, retrieved held bundles cannot be returned

The following details the Clear Message steps related to scenario 1 and 2 above and the associated HTTP action. The actual URL’s will be provided to vendors in a separate document.

Step HTTP action (Example URL) HTTP Payload Profile Example
Batch Clear Message Queue Request POST https://site2.api.sharedhealth.exchange/rest/v1/preconf/THP/mailbox_vs1 Batch DELETE Request Request to clear message queue
Batch Clear Message Queue Response Response to POST with Bundle payload Batch DELETE Response Response to clear message queue request

The following details the steps and the associated HTTP action for Returning a Retrieved Deferred bundle. The actual URL’s will be provided to vendors in a separate document.

Step HTTP action (Example URL) HTTP Payload Profile Example
Returned Retrieved Deferred Bundle Request POST https://site2.api.sharedhealth.exchange/rest/v1/preconf/THP/mailbox_vs1 Returned Retrieved Deferred Bundle Request Request to Return Retrieved Deferred Bundle
Returned Retrieved Deferred Bundle Response Response to POST with Bundle payload Batch PUT Response Response to Return Retrieved Deferred bundle with French status translation

Download Excel representation

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

>

This structure is derived from Shared Health Bundle

NameCard.TypeConstraints and Usage
.  Bundle 0..*Shared Health Bundlebdl-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:
Conformance Rule: When sending this request this field must not be populated and should be omitted.



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-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..*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: batch
Definition:
Indicates the purpose of this bundle- how it was intended to be used.


Comments:
Fixed value: batch

..  entry 1..*BackboneElementbdl-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..1BackboneElementDefinition:
Additional information about how this entry should be processed as part of a transaction.

....  method 1..1codeBinding: HTTPVerb (required): HTTP verbs (in the HTTP command line).


method-1: IF method = PUT, cancelRetrievalReason MUST be specified
Definition:
The HTTP verb for this entry in either a change history, or a transaction/ transaction response.


Comments:
Conformance Rule: In the context of Batch Clear Message Queue Request for clearing polled, deferred, or held bundles, use the HTTP Verb = DELETE



Conformance Rule: In the context of Returning a Retrieved Deferred Bundle Request, use the HTTP Verb = PUT

.....  extension 0..1ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

.....  extension
           (cancelRetrievalReason)
0..1Bundle Cancel Retrieval ReasonDefinition:
An extension that conveys any relevant reasons/rational related to why the a retrieved Deferred bundle is being returned back to PrescribeIT®

....  url 1..1uriDefinition:
The URL for the bundle to be cleared(DELETE) / created(PUT)


Comments:
Conformance Rule: The URL must be populated with the corresponding fullUrl value that was returned in the polling response or the held or deferred retrieval response for the bundle that needs to be cleared (DELETE) or returned back to PrescribeIT® (PUT).

This structure is derived from Shared Health Bundle

Summary

Mandatory: 9 elements
Must-Support: 13 elements
Fixed Value: 3 elements
Prohibited: 9 elements

Extensions

This structure refers to these extensions:

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle S0..*Shared Health BundleContains a collection of resources
... id S0..1idLogical id of this artifact
... 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-clear-queue-request
..... tag:version S1..1CodingTags applied to this resource
...... code S1..1codeSymbol in syntax defined by the system
Fixed Value: Shared5.0
... type S1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: batch
... total 0..0
... entry S1..*BackboneElementEntry in the bundle - will have a resource, or information
.... fullUrl 0..0
.... resource 0..0
.... search 0..0
.... request S1..1BackboneElementTransaction Related Information
..... method SI1..1codeGET | POST | PUT | DELETE
method-1: IF method = PUT, cancelRetrievalReason MUST be specified
...... extension S0..1ExtensionExtension
Slice: Unordered, Open by value:url
...... ext-bundle-cancel-retrieval-reason S0..1Shared Health CodeableConcept CodeBundle Cancel Retrieval Reason
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason
Binding: CancelRetrievalReason (required)
..... url S1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch 0..0
..... ifModifiedSince 0..0
..... ifMatch 0..0
..... ifNoneExist 0..0
.... response 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle SΣI0..*Shared Health BundleContains 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-clear-queue-request
.... 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: batch
... link Σ0..*BackboneElementLinks 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 Σ1..1stringhttp://www.iana.org/assignments/link-relations/link-relations.xhtml
.... url Σ1..1uriReference details for the link
... entry SΣI1..*BackboneElementEntry in the bundle - will have a resource, or information
.... 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
.... request SΣI1..1BackboneElementTransaction Related Information
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... method SΣI1..1codeGET | POST | PUT | DELETE
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line).


method-1: IF method = PUT, cancelRetrievalReason MUST be specified
...... extension S0..1ExtensionExtension
Slice: Unordered, Open by value:url
...... ext-bundle-cancel-retrieval-reason S0..1Shared Health CodeableConcept CodeBundle Cancel Retrieval Reason
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason
Binding: CancelRetrievalReason (required)
...... value 0..1codePrimitive value for code
..... url SΣ1..1uriURL for HTTP equivalent of this entry
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

Grid View

This structure is derived from Shared Health Bundle

NameCard.TypeConstraints and Usage
.  Bundle 0..*Shared Health Bundlebdl-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:
Conformance Rule: When sending this request this field must not be populated and should be omitted.



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-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..*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: batch
Definition:
Indicates the purpose of this bundle- how it was intended to be used.


Comments:
Fixed value: batch

..  entry 1..*BackboneElementbdl-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..1BackboneElementDefinition:
Additional information about how this entry should be processed as part of a transaction.

....  method 1..1codeBinding: HTTPVerb (required): HTTP verbs (in the HTTP command line).


method-1: IF method = PUT, cancelRetrievalReason MUST be specified
Definition:
The HTTP verb for this entry in either a change history, or a transaction/ transaction response.


Comments:
Conformance Rule: In the context of Batch Clear Message Queue Request for clearing polled, deferred, or held bundles, use the HTTP Verb = DELETE



Conformance Rule: In the context of Returning a Retrieved Deferred Bundle Request, use the HTTP Verb = PUT

.....  extension 0..1ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

.....  extension
           (cancelRetrievalReason)
0..1Bundle Cancel Retrieval ReasonDefinition:
An extension that conveys any relevant reasons/rational related to why the a retrieved Deferred bundle is being returned back to PrescribeIT®

....  url 1..1uriDefinition:
The URL for the bundle to be cleared(DELETE) / created(PUT)


Comments:
Conformance Rule: The URL must be populated with the corresponding fullUrl value that was returned in the polling response or the held or deferred retrieval response for the bundle that needs to be cleared (DELETE) or returned back to PrescribeIT® (PUT).

This structure is derived from Shared Health Bundle

Summary

Mandatory: 9 elements
Must-Support: 13 elements
Fixed Value: 3 elements
Prohibited: 9 elements

Extensions

This structure refers to these extensions:

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle S0..*Shared Health BundleContains a collection of resources
... id S0..1idLogical id of this artifact
... 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-clear-queue-request
..... tag:version S1..1CodingTags applied to this resource
...... code S1..1codeSymbol in syntax defined by the system
Fixed Value: Shared5.0
... type S1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: batch
... total 0..0
... entry S1..*BackboneElementEntry in the bundle - will have a resource, or information
.... fullUrl 0..0
.... resource 0..0
.... search 0..0
.... request S1..1BackboneElementTransaction Related Information
..... method SI1..1codeGET | POST | PUT | DELETE
method-1: IF method = PUT, cancelRetrievalReason MUST be specified
...... extension S0..1ExtensionExtension
Slice: Unordered, Open by value:url
...... ext-bundle-cancel-retrieval-reason S0..1Shared Health CodeableConcept CodeBundle Cancel Retrieval Reason
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason
Binding: CancelRetrievalReason (required)
..... url S1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch 0..0
..... ifModifiedSince 0..0
..... ifMatch 0..0
..... ifNoneExist 0..0
.... response 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle SΣI0..*Shared Health BundleContains 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-clear-queue-request
.... 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: batch
... link Σ0..*BackboneElementLinks 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 Σ1..1stringhttp://www.iana.org/assignments/link-relations/link-relations.xhtml
.... url Σ1..1uriReference details for the link
... entry SΣI1..*BackboneElementEntry in the bundle - will have a resource, or information
.... 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
.... request SΣI1..1BackboneElementTransaction Related Information
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... method SΣI1..1codeGET | POST | PUT | DELETE
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line).


method-1: IF method = PUT, cancelRetrievalReason MUST be specified
...... extension S0..1ExtensionExtension
Slice: Unordered, Open by value:url
...... ext-bundle-cancel-retrieval-reason S0..1Shared Health CodeableConcept CodeBundle Cancel Retrieval Reason
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason
Binding: CancelRetrievalReason (required)
...... value 0..1codePrimitive value for code
..... url SΣ1..1uriURL for HTTP equivalent of this entry
... 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: batch
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()
method-1Bundle.entry.request.methodIF method = PUT, cancelRetrievalReason MUST be specified
: $this.value='PUT' implies extension('http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason').exists()
© 2017+ . Based on FHIR version (1.4.0-8139). IG generated on Fri, Feb 4, 2022 12:22-0500. | IG Change History