Package | hl7.fhir.us.davinci-crd |
Type | CapabilityStatement |
Id | crd-client6.1 |
FHIR Version | R4 |
Source | http://hl7.org/fhir/us/davinci-crd/https://build.fhir.org/ig/HL7/davinci-crd/CapabilityStatement-crd-client6.1.html |
URL | http://hl7.org/fhir/us/davinci-crd/CapabilityStatement/crd-client6.1 |
Version | 2.2.0-cibuild |
Status | active |
Date | 2022-11-25 |
Name | CRDClient6_1 |
Title | CRD Client USCDI 3 |
Realm | us |
Authority | hl7 |
Description | This statement defines the expected capabilities of systems wishing to conform to the ''CRD Client'' role for USCDI 3 (US-Core 6.1.0). This role is responsible for initiating CDS Hooks calls and consuming received decision support. It is *also* responsible for returning data requested by the CRD Server needed to provide that decision support. This capability statement doesn't define the CDS Hooks capabilities as there is no standard way to do that as yet. Instead, it focuses on the 'server' capabilities needed to respond to CRD Server queries. These capabilities are based on US Core. In addition to the U.S. core expectations, the CRD Client **SHALL** support all 'SHOULD' 'read' and 'search' capabilities listed below for resources referenced in supported hooks and order types if it does not support returning the associated resources as part of CDS Hooks pre-fetch. The CRD Client **SHALL** also support 'update' functionality for all resources listed below where the client allows invoking hooks based on the resource. |
Kind | requirements |
No resources found
CapabilityStatement | |
us-core-server | US Core Server CapabilityStatement |
StructureDefinition | |
hrex-practitionerrole | HRex PractitionerRole Profile |
profile-appointment-no-order | CRD Appointment without Order |
profile-appointment-with-order | CRD Appointment with Order |
profile-communicationrequest | CRD Communication Request |
profile-coverage | CRD Coverage |
profile-device | CRD Device |
profile-devicerequest | CRD Device Request |
profile-encounter | CRD Encounter |
profile-location | CRD Location |
profile-medicationrequest | CRD Medication Request |
profile-nutritionorder | CRD Nutrition Order |
profile-organization | CRD Organization |
profile-patient | CRD Patient |
profile-servicerequest | CRD Service Request |
profile-visionprescription | CRD Vision Prescription |
us-core-practitioner | US Core Practitioner Profile |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement crd-client6.1
json
Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
This CapabilityStatement imports the CapabilityStatement US Core Server CapabilityStatementversion: null6.1.0)
server
A CRD Client provides a FHIR server endpoint, returning patient information to the CRD server, ensuring it has the needed information to perform decision support.
Implementations SHALL meet the general security requirements documented in the [[http://hl7.org/fhir/us/davinci-hrex/STU1/security.html|HRex implementation guide]].
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|
Appointment | Supported Profiles CRD Appointment with Order CRD Appointment without Order | y | |||||||
CommunicationRequest | Supported Profiles CRD Communication Request | y | |||||||
DeviceRequest | Supported Profiles CRD Device Request | y | |||||||
Encounter | Supported Profiles CRD Encounter | y | organization | Encounter:location | |||||
MedicationRequest | Supported Profiles CRD Medication Request | y | |||||||
NutritionOrder | Supported Profiles CRD Nutrition Order | y | |||||||
ServiceRequest | Supported Profiles CRD Service Request | y | |||||||
VisionPrescription | Supported Profiles CRD Vision Prescription | y | |||||||
Coverage | Supported Profiles CRD Coverage | y | status | ||||||
Device | Supported Profiles CRD Device | y | |||||||
Location | Supported Profiles CRD Location | y | |||||||
Organization | Supported Profiles CRD Organization | y | |||||||
Patient | Supported Profiles CRD Patient | y | |||||||
Practitioner | Supported Profiles US Core Practitioner Profileversion: null7.0.0) | y | |||||||
PractitionerRole | Supported Profiles HRex PractitionerRole Profile | y | practitioner | PractitionerRole:organization , PractitionerRole:practitioner |
update
Allows annotating the appointment in response to a card. (Support is mandatory if the system supports Appointments)
update
Allows annotating the communication request in response to a card. (Support is mandatory if the system supports CommunicationRequests)
update
Allows annotating the device request in response to a card. (Support is mandatory if the system supports DeviceRequests.)
search-type
Allows retrieval of the encounter for a nutrition order (including referenced location) if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | organization | reference | Allows performing an _include on Location when retrieving an Encounter |
update
Allows annotating the medication request in response to a card. (Support is mandatory if the system supports MedicationRequests)
update
Allows annotating the nutrition order in response to a card. (Support is mandatory if the system supports NutritionOrders.)
update
Allows annotating the service requests in response to a card. (Support is mandatory if the system supports ServiceRequests.)
update
Allows annotating the vision prescription in response to a card. (Support is mandatory if the system supports VisionPrescriptions)
search-type
Allows retrieval of the patient's coverage information if it is not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.) Note that only coverages relevant to the payer(s) associated with the requesting CRD Server are allowed to be returned.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | status | token | Allows filtering to only active coverages |
read
Allows retrieval of the device requested in a DeviceRequest if it is not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)
read
Allows retrieval of the location associated with an order or appointment if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)
read
Allows retrieval of ordering and/or performing organization's information if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)
read
Allows retrieval of the patient demographics if patient is not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)
read
Allows retrieval of ordering and/or performing provider's information if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)
search-type
Allows retrieval of ordering and/or performing provider's (including associated Practitioners and Organizations) if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | practitioner | reference | Allows performing an _include on Practitioner when retrieving a PractitionerRole |
{ "resourceType": "CapabilityStatement", "id": "crd-client6.1", "text": { "status": "extensions", "div": "<!-- snip (see above) -->" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "fm" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 3, "_valueInteger": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://hl7.org/fhir/us/davinci-crd/ImplementationGuide/davinci-crd" } ] } }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use", "_valueCode": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://hl7.org/fhir/us/davinci-crd/ImplementationGuide/davinci-crd" } ] } } ], "url": "http://hl7.org/fhir/us/davinci-crd/CapabilityStatement/crd-client6.1", "version": "2.2.0-cibuild", "name": "CRDClient6_1", "title": "CRD Client USCDI 3", "status": "active", "experimental": false, "date": "2022-11-25", "publisher": "HL7 International / Financial Management", "contact": [ { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/fm" } ] } ], "description": "This statement defines the expected capabilities of systems wishing to conform to the ''CRD Client'' role for USCDI 3 (US-Core 6.1.0). This role is responsible for initiating CDS Hooks calls and consuming received decision support. It is *also* responsible for returning data requested by the CRD Server needed to provide that decision support. This capability statement doesn't define the CDS Hooks capabilities as there is no standard way to do that as yet. Instead, it focuses on the 'server' capabilities needed to respond to CRD Server queries. These capabilities are based on US Core.\n\nIn addition to the U.S. core expectations, the CRD Client **SHALL** support all 'SHOULD' 'read' and 'search' capabilities listed below for resources referenced in supported hooks and order types if it does not support returning the associated resources as part of CDS Hooks pre-fetch. The CRD Client **SHALL** also support 'update' functionality for all resources listed below where the client allows invoking hooks based on the resource.", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "US" } ] } ], "kind": "requirements", "imports": [ "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server|6.1.0" ], "fhirVersion": "4.0.1", "format": [ "json" ], "rest": [ { "mode": "server", "documentation": "A CRD Client provides a FHIR server endpoint, returning patient information to the CRD server, ensuring it has the needed information to perform decision support.", "security": { "description": "Implementations **SHALL** meet the general security requirements documented in the [[http://hl7.org/fhir/us/davinci-hrex/STU1/security.html|HRex implementation guide]]." }, "resource": [ { "type": "Appointment", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-appointment-with-order", "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-appointment-no-order" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "update", "documentation": "Allows annotating the appointment in response to a card. (Support is mandatory if the system supports Appointments)" } ], "versioning": "versioned-update" }, { "type": "CommunicationRequest", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "update", "documentation": "Allows annotating the communication request in response to a card. (Support is mandatory if the system supports CommunicationRequests)" } ], "versioning": "versioned-update" }, { "type": "DeviceRequest", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-devicerequest" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "update", "documentation": "Allows annotating the device request in response to a card. (Support is mandatory if the system supports DeviceRequests.)" } ], "versioning": "versioned-update" }, { "type": "Encounter", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-encounter" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "search-type", "documentation": "Allows retrieval of the encounter for a nutrition order (including referenced location) if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)" } ], "versioning": "versioned-update", "searchInclude": [ "Encounter:location" ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "organization", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-location", "type": "reference", "documentation": "Allows performing an _include on Location when retrieving an Encounter" } ] }, { "type": "MedicationRequest", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-medicationrequest" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "update", "documentation": "Allows annotating the medication request in response to a card. (Support is mandatory if the system supports MedicationRequests)" } ], "versioning": "versioned-update" }, { "type": "NutritionOrder", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-nutritionorder" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "update", "documentation": "Allows annotating the nutrition order in response to a card. (Support is mandatory if the system supports NutritionOrders.)" } ], "versioning": "versioned-update" }, { "type": "ServiceRequest", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "update", "documentation": "Allows annotating the service requests in response to a card. (Support is mandatory if the system supports ServiceRequests.)" } ], "versioning": "versioned-update" }, { "type": "VisionPrescription", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-visionprescription" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "update", "documentation": "Allows annotating the vision prescription in response to a card. (Support is mandatory if the system supports VisionPrescriptions)" } ], "versioning": "versioned-update" }, { "type": "Coverage", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-coverage" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "search-type", "documentation": "Allows retrieval of the patient's coverage information if it is not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.) Note that only coverages relevant to the payer(s) associated with the requesting CRD Server are allowed to be returned." } ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "status", "definition": "http://hl7.org/fhir/SearchParameter/Coverage-status", "type": "token", "documentation": "Allows filtering to only active coverages" } ] }, { "type": "Device", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-device" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "read", "documentation": "Allows retrieval of the device requested in a DeviceRequest if it is not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)" } ] }, { "type": "Location", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-location" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "read", "documentation": "Allows retrieval of the location associated with an order or appointment if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)" } ] }, { "type": "Organization", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-organization" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "read", "documentation": "Allows retrieval of ordering and/or performing organization's information if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)" } ] }, { "type": "Patient", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-patient" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "read", "documentation": "Allows retrieval of the patient demographics if patient is not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)" } ] }, { "type": "Practitioner", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|7.0.0" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "read", "documentation": "Allows retrieval of ordering and/or performing provider's information if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)" } ] }, { "type": "PractitionerRole", "supportedProfile": [ "http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-practitionerrole" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "search-type", "documentation": "Allows retrieval of ordering and/or performing provider's (including associated Practitioners and Organizations) if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)" } ], "searchInclude": [ "PractitionerRole:organization", "PractitionerRole:practitioner" ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "practitioner", "definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner", "type": "reference", "documentation": "Allows performing an _include on Practitioner when retrieving a PractitionerRole" } ] } ] } ] }