This page is part of the HL7 Tools Extension IG (v0.8.0: Release - Informative) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/tools/StructureDefinition/CDSHooksResponse | Version: 0.8.0 | |||
Standards status: Informative | Maturity Level: 1 | Computable Name: CDSHooksResponse | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.1.42.7 |
This structure is defined to allow the FHIR Validator to validate a CDSHooks Response body. TODO: This content will be moved to the CDS Hooks specification in the future
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CDSHooksElement | Elements defined in Ancestors:extension The response to the discovery endpoint | |
![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() |
C | 0..* | 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 |
![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() |
0..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read urn:uuid: is prefixed to the value before validation | |
![]() ![]() ![]() ![]() |
1..1 | string | Summary message for display to the user (<140 char) | |
![]() ![]() ![]() ![]() |
0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown) | |
![]() ![]() ![]() ![]() |
0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required) | |
![]() ![]() ![]() ![]() |
1..1 | CDSHooksElement | The primary source of guidance for the content the card represents. | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Short, human-readable label to display for the source. | |
![]() ![]() ![]() ![]() ![]() |
0..1 | url | Link for when user clicks for more information about the source | |
![]() ![]() ![]() ![]() ![]() |
0..1 | url | absolute URL to an icon for the source (<100x100 PNG)) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Describes the content of the card | |
![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5 |
![]() ![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Human-readable label to display for this suggestion | |
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Which suggestion is most preferred of a set | |
![]() ![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required) | |
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Human-readable description of the suggested action |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Resource | FHIR resource to create/update | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | url | A relative reference to the relevant resource. | |
![]() ![]() ![]() ![]() |
C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required) |
![]() ![]() ![]() ![]() |
C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4 |
![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3 |
![]() ![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Human-readable label to display for this link | |
![]() ![]() ![]() ![]() ![]() |
1..1 | url | URL to load | |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Information to share when launching SMART app | |
![]() ![]() ![]() |
0..* | See actions | Actions to auto-apply JSON: This element may be present as a JSON Array even when there are no items in the instance | |
![]() |
Path | Conformance | ValueSet | URI |
CDSHooksResponse.cards.indicator | required | CDSIndicatorCodesVS(a valid code from CDSIndicator Codes)http://hl7.org/fhir/tools/ValueSet/CDSIndicator From this IG | |
CDSHooksResponse.cards.suggestions.actions.type | required | CDSActionTypeCodesVS(a valid code from CDSActionType Codes)http://hl7.org/fhir/tools/ValueSet/CDSActionType From this IG | |
CDSHooksResponse.cards.selectionBehavior | required | CDSSelectionBehaviorCodesVS(a valid code from CDSSelectionBehavior Codes)http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior From this IG | |
CDSHooksResponse.cards.links.type | required | CDSLinkTypeCodesVS(a valid code from CDSLinkType Codes)http://hl7.org/fhir/tools/ValueSet/CDSLinkType From this IG |
Id | Grade | Path(s) | Details | Requirements |
cds-resp-1 | error | CDSHooksResponse.cards | only one action can be suggested if selectionBehavior = at-most-one : (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1 | |
cds-resp-2 | warning | CDSHooksResponse.cards.suggestions.actions | A resourceId not a resource must be provided when type = delete : (type = 'delete') implies (resourceId.exists() and resource.empty()) | |
cds-resp-3 | error | CDSHooksResponse.cards.links | AppContext only for smart Apps : (type != 'smart') implies (appContext.empty()) | |
cds-resp-4 | error | CDSHooksResponse.cards.overrideReasons | the CDS Service MUST populate a display value for each reason's Coding : all(display.exists()) | |
cds-resp-5 | error | CDSHooksResponse.cards.suggestions | All suggestion actions must have a description : actions.all(description.exists()) | |
cds-resp-6 | error | CDSHooksResponse.cards | If suggestions are present, selectionBehavior MUST also be provided. : suggestions.exists() implies selectionBehavior.exists() |
This structure is derived from CDSHooksElement
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CDSHooksElement | Elements defined in Ancestors:extension The response to the discovery endpoint | |
![]() ![]() ![]() |
C | 0..* | 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 |
![]() ![]() ![]() ![]() |
0..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read urn:uuid: is prefixed to the value before validation | |
![]() ![]() ![]() ![]() |
1..1 | string | Summary message for display to the user (<140 char) | |
![]() ![]() ![]() ![]() |
0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown) | |
![]() ![]() ![]() ![]() |
0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required) | |
![]() ![]() ![]() ![]() |
1..1 | CDSHooksElement | The primary source of guidance for the content the card represents. | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Short, human-readable label to display for the source. | |
![]() ![]() ![]() ![]() ![]() |
0..1 | url | Link for when user clicks for more information about the source | |
![]() ![]() ![]() ![]() ![]() |
0..1 | url | absolute URL to an icon for the source (<100x100 PNG)) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Describes the content of the card | |
![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5 |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Human-readable label to display for this suggestion | |
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Which suggestion is most preferred of a set | |
![]() ![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2 |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required) | |
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Human-readable description of the suggested action |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Resource | FHIR resource to create/update | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | url | A relative reference to the relevant resource. | |
![]() ![]() ![]() ![]() |
C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required) |
![]() ![]() ![]() ![]() |
C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4 |
![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3 |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Human-readable label to display for this link | |
![]() ![]() ![]() ![]() ![]() |
1..1 | url | URL to load | |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Information to share when launching SMART app | |
![]() ![]() ![]() |
0..* | See actions | Actions to auto-apply JSON: This element may be present as a JSON Array even when there are no items in the instance | |
![]() |
Path | Conformance | ValueSet | URI |
CDSHooksResponse.cards.indicator | required | CDSIndicatorCodesVS(a valid code from CDSIndicator Codes)http://hl7.org/fhir/tools/ValueSet/CDSIndicator From this IG | |
CDSHooksResponse.cards.suggestions.actions.type | required | CDSActionTypeCodesVS(a valid code from CDSActionType Codes)http://hl7.org/fhir/tools/ValueSet/CDSActionType From this IG | |
CDSHooksResponse.cards.selectionBehavior | required | CDSSelectionBehaviorCodesVS(a valid code from CDSSelectionBehavior Codes)http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior From this IG | |
CDSHooksResponse.cards.links.type | required | CDSLinkTypeCodesVS(a valid code from CDSLinkType Codes)http://hl7.org/fhir/tools/ValueSet/CDSLinkType From this IG |
Id | Grade | Path(s) | Details | Requirements |
cds-resp-1 | error | CDSHooksResponse.cards | only one action can be suggested if selectionBehavior = at-most-one : (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1 | |
cds-resp-2 | warning | CDSHooksResponse.cards.suggestions.actions | A resourceId not a resource must be provided when type = delete : (type = 'delete') implies (resourceId.exists() and resource.empty()) | |
cds-resp-3 | error | CDSHooksResponse.cards.links | AppContext only for smart Apps : (type != 'smart') implies (appContext.empty()) | |
cds-resp-4 | error | CDSHooksResponse.cards.overrideReasons | the CDS Service MUST populate a display value for each reason's Coding : all(display.exists()) | |
cds-resp-5 | error | CDSHooksResponse.cards.suggestions | All suggestion actions must have a description : actions.all(description.exists()) | |
cds-resp-6 | error | CDSHooksResponse.cards | If suggestions are present, selectionBehavior MUST also be provided. : suggestions.exists() implies selectionBehavior.exists() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CDSHooksElement | Elements defined in Ancestors:extension The response to the discovery endpoint | |
![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() |
C | 0..* | 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 |
![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() |
0..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read urn:uuid: is prefixed to the value before validation | |
![]() ![]() ![]() ![]() |
1..1 | string | Summary message for display to the user (<140 char) | |
![]() ![]() ![]() ![]() |
0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown) | |
![]() ![]() ![]() ![]() |
0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required) | |
![]() ![]() ![]() ![]() |
1..1 | CDSHooksElement | The primary source of guidance for the content the card represents. | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Short, human-readable label to display for the source. | |
![]() ![]() ![]() ![]() ![]() |
0..1 | url | Link for when user clicks for more information about the source | |
![]() ![]() ![]() ![]() ![]() |
0..1 | url | absolute URL to an icon for the source (<100x100 PNG)) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Describes the content of the card | |
![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5 |
![]() ![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Human-readable label to display for this suggestion | |
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Which suggestion is most preferred of a set | |
![]() ![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required) | |
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Human-readable description of the suggested action |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Resource | FHIR resource to create/update | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | url | A relative reference to the relevant resource. | |
![]() ![]() ![]() ![]() |
C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required) |
![]() ![]() ![]() ![]() |
C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4 |
![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3 |
![]() ![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Human-readable label to display for this link | |
![]() ![]() ![]() ![]() ![]() |
1..1 | url | URL to load | |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Information to share when launching SMART app | |
![]() ![]() ![]() |
0..* | See actions | Actions to auto-apply JSON: This element may be present as a JSON Array even when there are no items in the instance | |
![]() |
Path | Conformance | ValueSet | URI |
CDSHooksResponse.cards.indicator | required | CDSIndicatorCodesVS(a valid code from CDSIndicator Codes)http://hl7.org/fhir/tools/ValueSet/CDSIndicator From this IG | |
CDSHooksResponse.cards.suggestions.actions.type | required | CDSActionTypeCodesVS(a valid code from CDSActionType Codes)http://hl7.org/fhir/tools/ValueSet/CDSActionType From this IG | |
CDSHooksResponse.cards.selectionBehavior | required | CDSSelectionBehaviorCodesVS(a valid code from CDSSelectionBehavior Codes)http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior From this IG | |
CDSHooksResponse.cards.links.type | required | CDSLinkTypeCodesVS(a valid code from CDSLinkType Codes)http://hl7.org/fhir/tools/ValueSet/CDSLinkType From this IG |
Id | Grade | Path(s) | Details | Requirements |
cds-resp-1 | error | CDSHooksResponse.cards | only one action can be suggested if selectionBehavior = at-most-one : (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1 | |
cds-resp-2 | warning | CDSHooksResponse.cards.suggestions.actions | A resourceId not a resource must be provided when type = delete : (type = 'delete') implies (resourceId.exists() and resource.empty()) | |
cds-resp-3 | error | CDSHooksResponse.cards.links | AppContext only for smart Apps : (type != 'smart') implies (appContext.empty()) | |
cds-resp-4 | error | CDSHooksResponse.cards.overrideReasons | the CDS Service MUST populate a display value for each reason's Coding : all(display.exists()) | |
cds-resp-5 | error | CDSHooksResponse.cards.suggestions | All suggestion actions must have a description : actions.all(description.exists()) | |
cds-resp-6 | error | CDSHooksResponse.cards | If suggestions are present, selectionBehavior MUST also be provided. : suggestions.exists() implies selectionBehavior.exists() |
This structure is derived from CDSHooksElement
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CDSHooksElement | Elements defined in Ancestors:extension The response to the discovery endpoint | |
![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() |
C | 0..* | 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 |
![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() |
0..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read urn:uuid: is prefixed to the value before validation | |
![]() ![]() ![]() ![]() |
1..1 | string | Summary message for display to the user (<140 char) | |
![]() ![]() ![]() ![]() |
0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown) | |
![]() ![]() ![]() ![]() |
0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required) | |
![]() ![]() ![]() ![]() |
1..1 | CDSHooksElement | The primary source of guidance for the content the card represents. | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Short, human-readable label to display for the source. | |
![]() ![]() ![]() ![]() ![]() |
0..1 | url | Link for when user clicks for more information about the source | |
![]() ![]() ![]() ![]() ![]() |
0..1 | url | absolute URL to an icon for the source (<100x100 PNG)) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Describes the content of the card | |
![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5 |
![]() ![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Human-readable label to display for this suggestion | |
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Which suggestion is most preferred of a set | |
![]() ![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required) | |
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Human-readable description of the suggested action |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Resource | FHIR resource to create/update | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | url | A relative reference to the relevant resource. | |
![]() ![]() ![]() ![]() |
C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required) |
![]() ![]() ![]() ![]() |
C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4 |
![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3 |
![]() ![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Human-readable label to display for this link | |
![]() ![]() ![]() ![]() ![]() |
1..1 | url | URL to load | |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Information to share when launching SMART app | |
![]() ![]() ![]() |
0..* | See actions | Actions to auto-apply JSON: This element may be present as a JSON Array even when there are no items in the instance | |
![]() |
Path | Conformance | ValueSet | URI |
CDSHooksResponse.cards.indicator | required | CDSIndicatorCodesVS(a valid code from CDSIndicator Codes)http://hl7.org/fhir/tools/ValueSet/CDSIndicator From this IG | |
CDSHooksResponse.cards.suggestions.actions.type | required | CDSActionTypeCodesVS(a valid code from CDSActionType Codes)http://hl7.org/fhir/tools/ValueSet/CDSActionType From this IG | |
CDSHooksResponse.cards.selectionBehavior | required | CDSSelectionBehaviorCodesVS(a valid code from CDSSelectionBehavior Codes)http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior From this IG | |
CDSHooksResponse.cards.links.type | required | CDSLinkTypeCodesVS(a valid code from CDSLinkType Codes)http://hl7.org/fhir/tools/ValueSet/CDSLinkType From this IG |
Id | Grade | Path(s) | Details | Requirements |
cds-resp-1 | error | CDSHooksResponse.cards | only one action can be suggested if selectionBehavior = at-most-one : (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1 | |
cds-resp-2 | warning | CDSHooksResponse.cards.suggestions.actions | A resourceId not a resource must be provided when type = delete : (type = 'delete') implies (resourceId.exists() and resource.empty()) | |
cds-resp-3 | error | CDSHooksResponse.cards.links | AppContext only for smart Apps : (type != 'smart') implies (appContext.empty()) | |
cds-resp-4 | error | CDSHooksResponse.cards.overrideReasons | the CDS Service MUST populate a display value for each reason's Coding : all(display.exists()) | |
cds-resp-5 | error | CDSHooksResponse.cards.suggestions | All suggestion actions must have a description : actions.all(description.exists()) | |
cds-resp-6 | error | CDSHooksResponse.cards | If suggestions are present, selectionBehavior MUST also be provided. : suggestions.exists() implies selectionBehavior.exists() |
Differential View
This structure is derived from CDSHooksElement
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CDSHooksElement | Elements defined in Ancestors:extension The response to the discovery endpoint | |
![]() ![]() ![]() |
C | 0..* | 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 |
![]() ![]() ![]() ![]() |
0..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read urn:uuid: is prefixed to the value before validation | |
![]() ![]() ![]() ![]() |
1..1 | string | Summary message for display to the user (<140 char) | |
![]() ![]() ![]() ![]() |
0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown) | |
![]() ![]() ![]() ![]() |
0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required) | |
![]() ![]() ![]() ![]() |
1..1 | CDSHooksElement | The primary source of guidance for the content the card represents. | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Short, human-readable label to display for the source. | |
![]() ![]() ![]() ![]() ![]() |
0..1 | url | Link for when user clicks for more information about the source | |
![]() ![]() ![]() ![]() ![]() |
0..1 | url | absolute URL to an icon for the source (<100x100 PNG)) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Describes the content of the card | |
![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5 |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Human-readable label to display for this suggestion | |
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Which suggestion is most preferred of a set | |
![]() ![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2 |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required) | |
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Human-readable description of the suggested action |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Resource | FHIR resource to create/update | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | url | A relative reference to the relevant resource. | |
![]() ![]() ![]() ![]() |
C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required) |
![]() ![]() ![]() ![]() |
C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4 |
![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3 |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Human-readable label to display for this link | |
![]() ![]() ![]() ![]() ![]() |
1..1 | url | URL to load | |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Information to share when launching SMART app | |
![]() ![]() ![]() |
0..* | See actions | Actions to auto-apply JSON: This element may be present as a JSON Array even when there are no items in the instance | |
![]() |
Path | Conformance | ValueSet | URI |
CDSHooksResponse.cards.indicator | required | CDSIndicatorCodesVS(a valid code from CDSIndicator Codes)http://hl7.org/fhir/tools/ValueSet/CDSIndicator From this IG | |
CDSHooksResponse.cards.suggestions.actions.type | required | CDSActionTypeCodesVS(a valid code from CDSActionType Codes)http://hl7.org/fhir/tools/ValueSet/CDSActionType From this IG | |
CDSHooksResponse.cards.selectionBehavior | required | CDSSelectionBehaviorCodesVS(a valid code from CDSSelectionBehavior Codes)http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior From this IG | |
CDSHooksResponse.cards.links.type | required | CDSLinkTypeCodesVS(a valid code from CDSLinkType Codes)http://hl7.org/fhir/tools/ValueSet/CDSLinkType From this IG |
Id | Grade | Path(s) | Details | Requirements |
cds-resp-1 | error | CDSHooksResponse.cards | only one action can be suggested if selectionBehavior = at-most-one : (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1 | |
cds-resp-2 | warning | CDSHooksResponse.cards.suggestions.actions | A resourceId not a resource must be provided when type = delete : (type = 'delete') implies (resourceId.exists() and resource.empty()) | |
cds-resp-3 | error | CDSHooksResponse.cards.links | AppContext only for smart Apps : (type != 'smart') implies (appContext.empty()) | |
cds-resp-4 | error | CDSHooksResponse.cards.overrideReasons | the CDS Service MUST populate a display value for each reason's Coding : all(display.exists()) | |
cds-resp-5 | error | CDSHooksResponse.cards.suggestions | All suggestion actions must have a description : actions.all(description.exists()) | |
cds-resp-6 | error | CDSHooksResponse.cards | If suggestions are present, selectionBehavior MUST also be provided. : suggestions.exists() implies selectionBehavior.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CDSHooksElement | Elements defined in Ancestors:extension The response to the discovery endpoint | |
![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() |
C | 0..* | 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 |
![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() |
0..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read urn:uuid: is prefixed to the value before validation | |
![]() ![]() ![]() ![]() |
1..1 | string | Summary message for display to the user (<140 char) | |
![]() ![]() ![]() ![]() |
0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown) | |
![]() ![]() ![]() ![]() |
0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required) | |
![]() ![]() ![]() ![]() |
1..1 | CDSHooksElement | The primary source of guidance for the content the card represents. | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Short, human-readable label to display for the source. | |
![]() ![]() ![]() ![]() ![]() |
0..1 | url | Link for when user clicks for more information about the source | |
![]() ![]() ![]() ![]() ![]() |
0..1 | url | absolute URL to an icon for the source (<100x100 PNG)) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Describes the content of the card | |
![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5 |
![]() ![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Human-readable label to display for this suggestion | |
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Which suggestion is most preferred of a set | |
![]() ![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required) | |
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Human-readable description of the suggested action |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Resource | FHIR resource to create/update | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | url | A relative reference to the relevant resource. | |
![]() ![]() ![]() ![]() |
C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required) |
![]() ![]() ![]() ![]() |
C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4 |
![]() ![]() ![]() ![]() |
C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3 |
![]() ![]() ![]() ![]() ![]() |
0..1 | CDSHooksExtensions | Object that has Named Extension Properties | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Human-readable label to display for this link | |
![]() ![]() ![]() ![]() ![]() |
1..1 | url | URL to load | |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Information to share when launching SMART app | |
![]() ![]() ![]() |
0..* | See actions | Actions to auto-apply JSON: This element may be present as a JSON Array even when there are no items in the instance | |
![]() |
Path | Conformance | ValueSet | URI |
CDSHooksResponse.cards.indicator | required | CDSIndicatorCodesVS(a valid code from CDSIndicator Codes)http://hl7.org/fhir/tools/ValueSet/CDSIndicator From this IG | |
CDSHooksResponse.cards.suggestions.actions.type | required | CDSActionTypeCodesVS(a valid code from CDSActionType Codes)http://hl7.org/fhir/tools/ValueSet/CDSActionType From this IG | |
CDSHooksResponse.cards.selectionBehavior | required | CDSSelectionBehaviorCodesVS(a valid code from CDSSelectionBehavior Codes)http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior From this IG | |
CDSHooksResponse.cards.links.type | required | CDSLinkTypeCodesVS(a valid code from CDSLinkType Codes)http://hl7.org/fhir/tools/ValueSet/CDSLinkType From this IG |
Id | Grade | Path(s) | Details | Requirements |
cds-resp-1 | error | CDSHooksResponse.cards | only one action can be suggested if selectionBehavior = at-most-one : (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1 | |
cds-resp-2 | warning | CDSHooksResponse.cards.suggestions.actions | A resourceId not a resource must be provided when type = delete : (type = 'delete') implies (resourceId.exists() and resource.empty()) | |
cds-resp-3 | error | CDSHooksResponse.cards.links | AppContext only for smart Apps : (type != 'smart') implies (appContext.empty()) | |
cds-resp-4 | error | CDSHooksResponse.cards.overrideReasons | the CDS Service MUST populate a display value for each reason's Coding : all(display.exists()) | |
cds-resp-5 | error | CDSHooksResponse.cards.suggestions | All suggestion actions must have a description : actions.all(description.exists()) | |
cds-resp-6 | error | CDSHooksResponse.cards | If suggestions are present, selectionBehavior MUST also be provided. : suggestions.exists() implies selectionBehavior.exists() |
This structure is derived from CDSHooksElement