Da Vinci - Coverage Requirements Discovery
2.2.0-ballot - STU 2.2 Ballot United States of America flag

This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.2.0-ballot: STU 2.2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 2.1.0. For a full list of available versions, see the Directory of published versions

Logical Model: CRD CDSHooks Additional Orders Response (Logical Definition) ( Abstract )

Official URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-additionalOrders Version: 2.2.0-ballot
Standards status: Trial-use Maturity Level: 4 Computable Name: CRDHooksResponseAdditionalOrders
Other Identifiers: OID:2.16.840.1.113883.4.642.40.18.42.40

Defines CRD-specific constraints for the Additional Orders response type

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksResponse 0..* CRDHooksResponseBase This is an abstract profile.
Elements defined in Ancestors:extension, cards, systemActions, cards
The response to the discovery endpoint
... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
... cards SC 1..* CDSHooksElement CDS responses to show user
JSON: The type of this element is inferred from the JSON type in the instance
Constraints: cds-resp-1, cds-resp-6
.... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
.... uuid S 1..1 uuid Unique identifier of the card (for logging/feedback)
When this element is read urn:uuid: is prefixed to the value before validation
.... summary S 1..1 string Summary message for display to the user (<140 char)
.... detail 0..1 markdown Optional detailed information to display (GitHub Flavored Markdown)
.... indicator S 0..1 code info, warning, critical - Urgency/importance of what this card conveys
Binding: CDSIndicator Codes ValueSet (required)
.... source S 1..1 CDSHooksElement The primary source of guidance for the content the card represents.
..... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
..... label S 1..1 string Short, human-readable label to display for the source.
..... url 0..1 url Link for when user clicks for more information about the source
..... icon 0..1 url absolute URL to an icon for the source (<100x100 PNG))
..... topic S 1..1 Coding Describes the content of the card
Binding: CRD Card Types Value Set (extensible)
.... suggestions SC 1..* CDSHooksElement Suggest a set of changes in the context of the current activity
Constraints: cds-resp-5
..... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
..... label S 1..1 string Human-readable label to display for this suggestion
..... uuid 0..1 uuid Unique identifier, used for auditing and logging suggestions
When this element is read urn:uuid: is prefixed to the value before validation
..... isRecommended 0..1 boolean Which suggestion is most preferred of a set
..... actions SC 1..* CDSHooksElement Defines a suggested action (all apply)
Constraints: cds-resp-2
...... extension 0..1 CDSHooksExtensions Extension
...... type S 1..1 code create, update, delete - type of action performed
Binding: CDSActionType Codes ValueSet (required)
Required Pattern: create
...... description SC 1..1 string Human-readable description of the suggested action
...... resource S 0..1 CRDAppointmentWithOrder, CRDAppointmentNoOrder, CRDCommunicationRequest, CRDDeviceRequest, CRDMedicationRequest, CRDNutritionOrder, CRDServiceRequest, CRDVisionPrescription A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
.... selectionBehavior C 0..1 code at-most-one | any
Binding: CDSSelectionBehavior Codes ValueSet (required)
.... overrideReasons C 0..* Coding Feedback from user on card - why not acted on
Constraints: cds-resp-4
... systemActions 0..* CDSHooksElement Actions to auto-apply
JSON: This element may be present as a JSON Array even when there are no items in the instance
.... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
.... type S 1..1 code create, update, delete - type of action performed
Binding: CDSActionType Codes ValueSet (required)
.... description C 0..1 string Human-readable description of the suggested action
.... resource 0..1 Resource FHIR resource to create/update
.... resourceId 0..1 url A relative reference to the relevant resource.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CDSHooksResponse.cards.indicatorrequiredCDSIndicatorCodesVS
http://hl7.org/fhir/tools/ValueSet/CDSIndicator
CDSHooksResponse.cards.source.topicextensibleCRDCardType
http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType
From this IG
CDSHooksResponse.cards.suggestions.actions.typerequiredPattern Value: create
http://hl7.org/fhir/tools/ValueSet/CDSActionType
CDSHooksResponse.cards.selectionBehaviorrequiredCDSSelectionBehaviorCodesVS
http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior
CDSHooksResponse.cards.links.typerequiredCDSLinkTypeCodesVS
http://hl7.org/fhir/tools/ValueSet/CDSLinkType
CDSHooksResponse.systemActions.typerequiredCDSActionTypeCodesVS
http://hl7.org/fhir/tools/ValueSet/CDSActionType

Constraints

IdGradePath(s)DetailsRequirements
cds-resp-1errorCDSHooksResponse.cardsonly one action can be suggested if selectionBehavior = at-most-one
: (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1
cds-resp-2warningCDSHooksResponse.cards.suggestions.actionsA resourceId not a resource must be provided when type = delete
: (type = 'delete') implies (resourceId.exists() and resource.empty())
cds-resp-4errorCDSHooksResponse.cards.overrideReasonsthe CDS Service MUST populate a display value for each reason's Coding
: all(display.exists())
cds-resp-5errorCDSHooksResponse.cards.suggestionsAll suggestion actions must have a description
: actions.all(description.exists())
cds-resp-6errorCDSHooksResponse.cardsIf suggestions are present, selectionBehavior MUST also be provided.
: suggestions.exists() implies selectionBehavior.exists()

This structure is derived from CRDHooksResponseBase

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksResponse 0..* CRDHooksResponseBase This is an abstract profile.
Elements defined in Ancestors:extension, cards, systemActions, cards
The response to the discovery endpoint
... cards S 1..* CDSHooksElement CDS responses to show user
.... suggestions S 1..* CDSHooksElement Suggest a set of changes in the context of the current activity
..... actions S 1..* CDSHooksElement Defines a suggested action (all apply)
...... type S 1..1 code create, update, delete - type of action performed
Required Pattern: create
...... resource S 0..1 CRDAppointmentWithOrder, CRDAppointmentNoOrder, CRDCommunicationRequest, CRDDeviceRequest, CRDMedicationRequest, CRDNutritionOrder, CRDServiceRequest, CRDVisionPrescription A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
...... resourceId 0..0
.... links 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksResponse 0..* CRDHooksResponseBase This is an abstract profile.
Elements defined in Ancestors:extension, cards, systemActions, cards
The response to the discovery endpoint
... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
... cards SC 1..* CDSHooksElement CDS responses to show user
JSON: The type of this element is inferred from the JSON type in the instance
Constraints: cds-resp-1, cds-resp-6
.... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
.... uuid S 1..1 uuid Unique identifier of the card (for logging/feedback)
When this element is read urn:uuid: is prefixed to the value before validation
.... summary S 1..1 string Summary message for display to the user (<140 char)
.... detail 0..1 markdown Optional detailed information to display (GitHub Flavored Markdown)
.... indicator S 0..1 code info, warning, critical - Urgency/importance of what this card conveys
Binding: CDSIndicator Codes ValueSet (required)
.... source S 1..1 CDSHooksElement The primary source of guidance for the content the card represents.
..... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
..... label S 1..1 string Short, human-readable label to display for the source.
..... url 0..1 url Link for when user clicks for more information about the source
..... icon 0..1 url absolute URL to an icon for the source (<100x100 PNG))
..... topic S 1..1 Coding Describes the content of the card
Binding: CRD Card Types Value Set (extensible)
.... suggestions SC 1..* CDSHooksElement Suggest a set of changes in the context of the current activity
Constraints: cds-resp-5
..... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
..... label S 1..1 string Human-readable label to display for this suggestion
..... uuid 0..1 uuid Unique identifier, used for auditing and logging suggestions
When this element is read urn:uuid: is prefixed to the value before validation
..... isRecommended 0..1 boolean Which suggestion is most preferred of a set
..... actions SC 1..* CDSHooksElement Defines a suggested action (all apply)
Constraints: cds-resp-2
...... extension 0..1 CDSHooksExtensions Extension
...... type S 1..1 code create, update, delete - type of action performed
Binding: CDSActionType Codes ValueSet (required)
Required Pattern: create
...... description SC 1..1 string Human-readable description of the suggested action
...... resource S 0..1 CRDAppointmentWithOrder, CRDAppointmentNoOrder, CRDCommunicationRequest, CRDDeviceRequest, CRDMedicationRequest, CRDNutritionOrder, CRDServiceRequest, CRDVisionPrescription A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
.... selectionBehavior C 0..1 code at-most-one | any
Binding: CDSSelectionBehavior Codes ValueSet (required)
.... overrideReasons C 0..* Coding Feedback from user on card - why not acted on
Constraints: cds-resp-4
... systemActions 0..* CDSHooksElement Actions to auto-apply
JSON: This element may be present as a JSON Array even when there are no items in the instance
.... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
.... type S 1..1 code create, update, delete - type of action performed
Binding: CDSActionType Codes ValueSet (required)
.... description C 0..1 string Human-readable description of the suggested action
.... resource 0..1 Resource FHIR resource to create/update
.... resourceId 0..1 url A relative reference to the relevant resource.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CDSHooksResponse.cards.indicatorrequiredCDSIndicatorCodesVS
http://hl7.org/fhir/tools/ValueSet/CDSIndicator
CDSHooksResponse.cards.source.topicextensibleCRDCardType
http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType
From this IG
CDSHooksResponse.cards.suggestions.actions.typerequiredPattern Value: create
http://hl7.org/fhir/tools/ValueSet/CDSActionType
CDSHooksResponse.cards.selectionBehaviorrequiredCDSSelectionBehaviorCodesVS
http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior
CDSHooksResponse.cards.links.typerequiredCDSLinkTypeCodesVS
http://hl7.org/fhir/tools/ValueSet/CDSLinkType
CDSHooksResponse.systemActions.typerequiredCDSActionTypeCodesVS
http://hl7.org/fhir/tools/ValueSet/CDSActionType

Constraints

IdGradePath(s)DetailsRequirements
cds-resp-1errorCDSHooksResponse.cardsonly one action can be suggested if selectionBehavior = at-most-one
: (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1
cds-resp-2warningCDSHooksResponse.cards.suggestions.actionsA resourceId not a resource must be provided when type = delete
: (type = 'delete') implies (resourceId.exists() and resource.empty())
cds-resp-4errorCDSHooksResponse.cards.overrideReasonsthe CDS Service MUST populate a display value for each reason's Coding
: all(display.exists())
cds-resp-5errorCDSHooksResponse.cards.suggestionsAll suggestion actions must have a description
: actions.all(description.exists())
cds-resp-6errorCDSHooksResponse.cardsIf suggestions are present, selectionBehavior MUST also be provided.
: suggestions.exists() implies selectionBehavior.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksResponse 0..* CRDHooksResponseBase This is an abstract profile.
Elements defined in Ancestors:extension, cards, systemActions, cards
The response to the discovery endpoint
... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
... cards SC 1..* CDSHooksElement CDS responses to show user
JSON: The type of this element is inferred from the JSON type in the instance
Constraints: cds-resp-1, cds-resp-6
.... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
.... uuid S 1..1 uuid Unique identifier of the card (for logging/feedback)
When this element is read urn:uuid: is prefixed to the value before validation
.... summary S 1..1 string Summary message for display to the user (<140 char)
.... detail 0..1 markdown Optional detailed information to display (GitHub Flavored Markdown)
.... indicator S 0..1 code info, warning, critical - Urgency/importance of what this card conveys
Binding: CDSIndicator Codes ValueSet (required)
.... source S 1..1 CDSHooksElement The primary source of guidance for the content the card represents.
..... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
..... label S 1..1 string Short, human-readable label to display for the source.
..... url 0..1 url Link for when user clicks for more information about the source
..... icon 0..1 url absolute URL to an icon for the source (<100x100 PNG))
..... topic S 1..1 Coding Describes the content of the card
Binding: CRD Card Types Value Set (extensible)
.... suggestions SC 1..* CDSHooksElement Suggest a set of changes in the context of the current activity
Constraints: cds-resp-5
..... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
..... label S 1..1 string Human-readable label to display for this suggestion
..... uuid 0..1 uuid Unique identifier, used for auditing and logging suggestions
When this element is read urn:uuid: is prefixed to the value before validation
..... isRecommended 0..1 boolean Which suggestion is most preferred of a set
..... actions SC 1..* CDSHooksElement Defines a suggested action (all apply)
Constraints: cds-resp-2
...... extension 0..1 CDSHooksExtensions Extension
...... type S 1..1 code create, update, delete - type of action performed
Binding: CDSActionType Codes ValueSet (required)
Required Pattern: create
...... description SC 1..1 string Human-readable description of the suggested action
...... resource S 0..1 CRDAppointmentWithOrder, CRDAppointmentNoOrder, CRDCommunicationRequest, CRDDeviceRequest, CRDMedicationRequest, CRDNutritionOrder, CRDServiceRequest, CRDVisionPrescription A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
.... selectionBehavior C 0..1 code at-most-one | any
Binding: CDSSelectionBehavior Codes ValueSet (required)
.... overrideReasons C 0..* Coding Feedback from user on card - why not acted on
Constraints: cds-resp-4
... systemActions 0..* CDSHooksElement Actions to auto-apply
JSON: This element may be present as a JSON Array even when there are no items in the instance
.... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
.... type S 1..1 code create, update, delete - type of action performed
Binding: CDSActionType Codes ValueSet (required)
.... description C 0..1 string Human-readable description of the suggested action
.... resource 0..1 Resource FHIR resource to create/update
.... resourceId 0..1 url A relative reference to the relevant resource.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CDSHooksResponse.cards.indicatorrequiredCDSIndicatorCodesVS
http://hl7.org/fhir/tools/ValueSet/CDSIndicator
CDSHooksResponse.cards.source.topicextensibleCRDCardType
http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType
From this IG
CDSHooksResponse.cards.suggestions.actions.typerequiredPattern Value: create
http://hl7.org/fhir/tools/ValueSet/CDSActionType
CDSHooksResponse.cards.selectionBehaviorrequiredCDSSelectionBehaviorCodesVS
http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior
CDSHooksResponse.cards.links.typerequiredCDSLinkTypeCodesVS
http://hl7.org/fhir/tools/ValueSet/CDSLinkType
CDSHooksResponse.systemActions.typerequiredCDSActionTypeCodesVS
http://hl7.org/fhir/tools/ValueSet/CDSActionType

Constraints

IdGradePath(s)DetailsRequirements
cds-resp-1errorCDSHooksResponse.cardsonly one action can be suggested if selectionBehavior = at-most-one
: (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1
cds-resp-2warningCDSHooksResponse.cards.suggestions.actionsA resourceId not a resource must be provided when type = delete
: (type = 'delete') implies (resourceId.exists() and resource.empty())
cds-resp-4errorCDSHooksResponse.cards.overrideReasonsthe CDS Service MUST populate a display value for each reason's Coding
: all(display.exists())
cds-resp-5errorCDSHooksResponse.cards.suggestionsAll suggestion actions must have a description
: actions.all(description.exists())
cds-resp-6errorCDSHooksResponse.cardsIf suggestions are present, selectionBehavior MUST also be provided.
: suggestions.exists() implies selectionBehavior.exists()

Differential View

This structure is derived from CRDHooksResponseBase

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksResponse 0..* CRDHooksResponseBase This is an abstract profile.
Elements defined in Ancestors:extension, cards, systemActions, cards
The response to the discovery endpoint
... cards S 1..* CDSHooksElement CDS responses to show user
.... suggestions S 1..* CDSHooksElement Suggest a set of changes in the context of the current activity
..... actions S 1..* CDSHooksElement Defines a suggested action (all apply)
...... type S 1..1 code create, update, delete - type of action performed
Required Pattern: create
...... resource S 0..1 CRDAppointmentWithOrder, CRDAppointmentNoOrder, CRDCommunicationRequest, CRDDeviceRequest, CRDMedicationRequest, CRDNutritionOrder, CRDServiceRequest, CRDVisionPrescription A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
...... resourceId 0..0
.... links 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksResponse 0..* CRDHooksResponseBase This is an abstract profile.
Elements defined in Ancestors:extension, cards, systemActions, cards
The response to the discovery endpoint
... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
... cards SC 1..* CDSHooksElement CDS responses to show user
JSON: The type of this element is inferred from the JSON type in the instance
Constraints: cds-resp-1, cds-resp-6
.... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
.... uuid S 1..1 uuid Unique identifier of the card (for logging/feedback)
When this element is read urn:uuid: is prefixed to the value before validation
.... summary S 1..1 string Summary message for display to the user (<140 char)
.... detail 0..1 markdown Optional detailed information to display (GitHub Flavored Markdown)
.... indicator S 0..1 code info, warning, critical - Urgency/importance of what this card conveys
Binding: CDSIndicator Codes ValueSet (required)
.... source S 1..1 CDSHooksElement The primary source of guidance for the content the card represents.
..... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
..... label S 1..1 string Short, human-readable label to display for the source.
..... url 0..1 url Link for when user clicks for more information about the source
..... icon 0..1 url absolute URL to an icon for the source (<100x100 PNG))
..... topic S 1..1 Coding Describes the content of the card
Binding: CRD Card Types Value Set (extensible)
.... suggestions SC 1..* CDSHooksElement Suggest a set of changes in the context of the current activity
Constraints: cds-resp-5
..... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
..... label S 1..1 string Human-readable label to display for this suggestion
..... uuid 0..1 uuid Unique identifier, used for auditing and logging suggestions
When this element is read urn:uuid: is prefixed to the value before validation
..... isRecommended 0..1 boolean Which suggestion is most preferred of a set
..... actions SC 1..* CDSHooksElement Defines a suggested action (all apply)
Constraints: cds-resp-2
...... extension 0..1 CDSHooksExtensions Extension
...... type S 1..1 code create, update, delete - type of action performed
Binding: CDSActionType Codes ValueSet (required)
Required Pattern: create
...... description SC 1..1 string Human-readable description of the suggested action
...... resource S 0..1 CRDAppointmentWithOrder, CRDAppointmentNoOrder, CRDCommunicationRequest, CRDDeviceRequest, CRDMedicationRequest, CRDNutritionOrder, CRDServiceRequest, CRDVisionPrescription A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
.... selectionBehavior C 0..1 code at-most-one | any
Binding: CDSSelectionBehavior Codes ValueSet (required)
.... overrideReasons C 0..* Coding Feedback from user on card - why not acted on
Constraints: cds-resp-4
... systemActions 0..* CDSHooksElement Actions to auto-apply
JSON: This element may be present as a JSON Array even when there are no items in the instance
.... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
.... type S 1..1 code create, update, delete - type of action performed
Binding: CDSActionType Codes ValueSet (required)
.... description C 0..1 string Human-readable description of the suggested action
.... resource 0..1 Resource FHIR resource to create/update
.... resourceId 0..1 url A relative reference to the relevant resource.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CDSHooksResponse.cards.indicatorrequiredCDSIndicatorCodesVS
http://hl7.org/fhir/tools/ValueSet/CDSIndicator
CDSHooksResponse.cards.source.topicextensibleCRDCardType
http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType
From this IG
CDSHooksResponse.cards.suggestions.actions.typerequiredPattern Value: create
http://hl7.org/fhir/tools/ValueSet/CDSActionType
CDSHooksResponse.cards.selectionBehaviorrequiredCDSSelectionBehaviorCodesVS
http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior
CDSHooksResponse.cards.links.typerequiredCDSLinkTypeCodesVS
http://hl7.org/fhir/tools/ValueSet/CDSLinkType
CDSHooksResponse.systemActions.typerequiredCDSActionTypeCodesVS
http://hl7.org/fhir/tools/ValueSet/CDSActionType

Constraints

IdGradePath(s)DetailsRequirements
cds-resp-1errorCDSHooksResponse.cardsonly one action can be suggested if selectionBehavior = at-most-one
: (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1
cds-resp-2warningCDSHooksResponse.cards.suggestions.actionsA resourceId not a resource must be provided when type = delete
: (type = 'delete') implies (resourceId.exists() and resource.empty())
cds-resp-4errorCDSHooksResponse.cards.overrideReasonsthe CDS Service MUST populate a display value for each reason's Coding
: all(display.exists())
cds-resp-5errorCDSHooksResponse.cards.suggestionsAll suggestion actions must have a description
: actions.all(description.exists())
cds-resp-6errorCDSHooksResponse.cardsIf suggestions are present, selectionBehavior MUST also be provided.
: suggestions.exists() implies selectionBehavior.exists()

 

Other representations of profile: CSV, Excel