3.21 Extension: Bundle Cancel Retrieval Reason
The official URL for this extension is:
http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason
Status: draft
Extension maintained by:
An extension that conveys any relevant reasons/rational related to why the a retrieved Deferred bundle is being returned back to PrescribeIT®
Context of Use
This extension may be used on the following element(s):
- {"type"=>"Bundle.entry.request.method"}
Usage info
Usage:
- Use this Extension: Interaction Bundle - Clear Message Queue Request
3.21.2 Formal Views of Extension Content
Download Excel representation
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Extension | 0..1 | Extension | Definition: An extension that conveys any relevant reasons/rational related to why the a retrieved Deferred bundle is being returned back to PrescribeIT® |
 url | 1..1 | uri | "http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason" |
 value[x] | 1..1 | Shared Health CodeableConcept Code | Binding: CancelRetrievalReason (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: |
 coding | 1..* | Coding | Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
| system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
| code | 1..1 | 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). Comments: This is the code as defined within the binding. |
| display | 0..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
This structure is derived from Extension
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Extension | 0..1 | Extension | Bundle Cancel Retrieval Reason | |
 extension | 0..0 | |||
| url | S | 1..1 | uri | "http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason" |
 value[x] | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: CancelRetrievalReason (required) |
| coding | ||||
| code | S | 1..1 | code | Symbol in syntax defined by the system |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..1 | Extension | Bundle Cancel Retrieval Reason | |
 id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason" |
| value[x] | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: CancelRetrievalReason (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | 1..* | Coding | Code defined by a terminology system |
 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 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | SΣ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| Documentation for this format | ||||
Grid View
This structure is derived from Extension
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Extension | 0..1 | Extension | Definition: An extension that conveys any relevant reasons/rational related to why the a retrieved Deferred bundle is being returned back to PrescribeIT® |
| url | 1..1 | uri | "http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason" |
| value[x] | 1..1 | Shared Health CodeableConcept Code | Binding: CancelRetrievalReason (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: |
| coding | 1..* | Coding | Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
| system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
| code | 1..1 | 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). Comments: This is the code as defined within the binding. |
| display | 0..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
This structure is derived from Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..1 | Extension | Bundle Cancel Retrieval Reason | |
| extension | 0..0 | |||
| url | S | 1..1 | uri | "http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason" |
| value[x] | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: CancelRetrievalReason (required) |
| coding | ||||
| code | S | 1..1 | code | Symbol in syntax defined by the system |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..1 | Extension | Bundle Cancel Retrieval Reason | |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason" |
| value[x] | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: CancelRetrievalReason (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | 1..* | Coding | Code defined by a terminology system |
| 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 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | SΣ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| Documentation for this format | ||||
Other representations of extension: Schematron
3.21.3 Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| Extension.value[x] | required | CancelRetrievalReason |
3.21.4 Constraints
Constraints
| Id | Path | Details | Requirements |