Shared Health Specification and Guide Version 5.0

 

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:

Download Excel representation

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

This structure is derived from Extension

NameCard.TypeConstraints and Usage
.  Extension 0..1ExtensionDefinition:
An extension that conveys any relevant reasons/rational related to why the a retrieved Deferred bundle is being returned back to PrescribeIT®

..  url 1..1uri"http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason"
..  value[x] 1..1Shared Health CodeableConcept CodeBinding: 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..*CodingDefinition:
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..1uriDefinition:
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..1codeDefinition:
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.

This structure is derived from Extension

Summary

Mandatory: 3 elements
Must-Support: 3 elements
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionBundle Cancel Retrieval Reason
... extension 0..0
... url S1..1uri"http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason"
... value[x] S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: CancelRetrievalReason (required)
.... coding
..... code S1..1codeSymbol in syntax defined by the system

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionBundle Cancel Retrieval Reason
... id 0..1idxml:id (or equivalent in JSON)
... url S1..1uri"http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason"
... value[x] S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: CancelRetrievalReason (required)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding SΣ1..*CodingCode defined by a terminology system
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system SΣ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept

doco Documentation for this format

Grid View

This structure is derived from Extension

NameCard.TypeConstraints and Usage
.  Extension 0..1ExtensionDefinition:
An extension that conveys any relevant reasons/rational related to why the a retrieved Deferred bundle is being returned back to PrescribeIT®

..  url 1..1uri"http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason"
..  value[x] 1..1Shared Health CodeableConcept CodeBinding: 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..*CodingDefinition:
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..1uriDefinition:
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..1codeDefinition:
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.

This structure is derived from Extension

Summary

Mandatory: 3 elements
Must-Support: 3 elements
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionBundle Cancel Retrieval Reason
... extension 0..0
... url S1..1uri"http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason"
... value[x] S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: CancelRetrievalReason (required)
.... coding
..... code S1..1codeSymbol in syntax defined by the system

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionBundle Cancel Retrieval Reason
... id 0..1idxml:id (or equivalent in JSON)
... url S1..1uri"http://sharedhealth.exchange/fhir/StructureDefinition/ext-bundle-cancel-retrieval-reason"
... value[x] S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: CancelRetrievalReason (required)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding SΣ1..*CodingCode defined by a terminology system
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system SΣ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept

doco Documentation for this format

 

Other representations of extension: Schematron

3.17.3 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Extension.value[x]requiredCancelRetrievalReason

Constraints

IdPathDetailsRequirements