FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.us.davinci-crd
Resource TypeCapabilityStatement
IdCapabilityStatement-crd-client7.0.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/HL7/davinci-crd/CapabilityStatement-crd-client7.0.html
URLhttp://hl7.org/fhir/us/davinci-crd/CapabilityStatement/crd-client7.0
Version2.2.0-snapshot
Statusactive
Date2022-11-25
NameCRDClient7_0
TitleCRD Client USCDI 4
Realmus
Authorityhl7
DescriptionThis statement defines the expected capabilities of systems wishing to conform to the ''CRD Client'' role for USCDI 4 (US-Core 7.9.0). This role is responsible for initiating CDS Hooks calls and consuming received decision support. It is *also* responsible for returning the data requested by the CRD Server needed to provide that decision support. This capability statement does not define the CDS Hooks capabilities as there is no standard way to do that yet. Instead, it focuses on the 'server' capabilities needed to respond to CRD Server queries. These capabilities are based on US Core.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

CapabilityStatement
us-core-serverUS Core Server CapabilityStatement
StructureDefinition
us-core-practitionerUS Core Practitioner Profile
profile-appointment-no-orderCRD Appointment without Order
profile-appointment-with-orderCRD Appointment with Order
profile-communicationrequestCRD Communication Request
profile-coverageCRD Coverage
profile-deviceCRD Device
profile-devicerequestCRD Device Request
profile-encounterCRD Encounter
profile-locationCRD Location
profile-medicationrequestCRD Medication Request
profile-nutritionorderCRD Nutrition Order
profile-organizationCRD Organization
profile-patientCRD Patient
profile-servicerequestCRD Service Request
profile-visionprescriptionCRD Vision Prescription
hrex-practitionerroleHRex PractitionerRole Profile

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement crd-client7.0

CRD Client USCDI 4

  • Implementation Guide Version: 2.2.0-snapshot
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Published on: 2022-11-25
  • Published by: HL7 International / Financial Management

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: 7.0.0)

FHIR RESTful Capabilities

Mode: 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.

Security

Implementations SHALL meet the general security requirements documented in the [[http://hl7.org/fhir/us/davinci-hrex/STU1.2.0-snapshot/security.html|HRex implementation guide]].

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
AppointmentSupported Profiles
  CRD Appointment with Order
  CRD Appointment without Order
y?
CommunicationRequestSupported Profiles
  CRD Communication Request
y?
DeviceRequestSupported Profiles
  CRD Device Request
y?
EncounterSupported Profiles
  CRD Encounter
Y
MedicationRequestSupported Profiles
  CRD Medication Request
y?
NutritionOrderSupported Profiles
  CRD Nutrition Order
y?
ServiceRequestSupported Profiles
  CRD Service Request
y?
VisionPrescriptionSupported Profiles
  CRD Vision Prescription
y?
CoverageSupported Profiles
  CRD Coverage
Y
DeviceSupported Profiles
  CRD Device
Y
LocationSupported Profiles
  CRD Location
Y
OrganizationSupported Profiles
  CRD Organization
Y
PatientSupported Profiles
  CRD Patient
Y
PractitionerSupported Profiles
  US Core Practitioner Profileversion: 7.0.0)
Y
PractitionerRoleSupported Profiles
  HRex PractitionerRole Profile
Y

Resource Conformance: MAY Appointment

Core FHIR Resource
Appointment
Reference Policy
Interaction summary
  • MAY support
    update

    Allows annotating the appointment in response to a card. (CRD Clients SHALL support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)

Resource Conformance: MAY CommunicationRequest

Core FHIR Resource
CommunicationRequest
Reference Policy
Interaction summary
  • MAY support
    update

    Allows annotating the communication request in response to a card. (CRD Clients SHALL support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)

Supported Profiles

CRD Communication Request

Resource Conformance: MAY DeviceRequest

Core FHIR Resource
DeviceRequest
Reference Policy
Interaction summary
  • MAY support
    update

    Allows annotating the device request in response to a card. (CRD Clients SHALL support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)

Supported Profiles

CRD Device Request

Resource Conformance: SHOULD Encounter

Core FHIR Resource
Encounter
Reference Policy
Interaction summary
  • SHOULD support
    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.)

Supported Profiles

CRD Encounter

Resource Conformance: MAY MedicationRequest

Core FHIR Resource
MedicationRequest
Reference Policy
Interaction summary
  • MAY support
    update

    Allows annotating the medication request in response to a card. (CRD Clients SHALL support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)

Supported Profiles

CRD Medication Request

Resource Conformance: MAY NutritionOrder

Core FHIR Resource
NutritionOrder
Reference Policy
Interaction summary
  • MAY support
    update

    Allows annotating the nutrition order in response to a card. (CRD Clients SHALL support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)

Supported Profiles

CRD Nutrition Order

Resource Conformance: MAY ServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
Interaction summary
  • MAY support
    update

    Allows annotating the service requests in response to a card. (CRD Clients SHALL support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)

Supported Profiles

CRD Service Request

Resource Conformance: MAY VisionPrescription

Core FHIR Resource
VisionPrescription
Reference Policy
Interaction summary
  • MAY support
    update

    Allows annotating the vision prescription in response to a card. (CRD Clients SHALL support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)

Supported Profiles

CRD Vision Prescription

Resource Conformance: SHOULD Coverage

Core FHIR Resource
Coverage
Reference Policy
Interaction summary
  • SHOULD support
    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.

Supported Profiles

CRD Coverage

Resource Conformance: SHOULD Device

Core FHIR Resource
Device
Reference Policy
Interaction summary
  • SHOULD support
    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.)

Supported Profiles

CRD Device

Resource Conformance: SHOULD Location

Core FHIR Resource
Location
Reference Policy
Interaction summary
  • SHOULD support
    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.)

Supported Profiles

CRD Location

Resource Conformance: SHOULD Organization

Core FHIR Resource
Organization
Reference Policy
Interaction summary
  • SHOULD support
    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.)

Supported Profiles

CRD Organization

Resource Conformance: SHOULD Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • SHOULD support
    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.)

Supported Profiles

CRD Patient

Resource Conformance: SHOULD Practitioner

Core FHIR Resource
Practitioner
Reference Policy
Interaction summary
  • SHOULD support
    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.)

Resource Conformance: SHOULD PractitionerRole

Core FHIR Resource
PractitionerRole
Reference Policy
Interaction summary
  • SHOULD support
    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.)


Source1

{
  "resourceType": "CapabilityStatement",
  "id": "crd-client7.0",
  "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": 4,
      "_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-client7.0",
  "version": "2.2.0-snapshot",
  "name": "CRDClient7_0",
  "title": "CRD Client USCDI 4",
  "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 4 (US-Core 7.9.0).  This role is responsible for initiating CDS Hooks calls and consuming received decision support.  It is *also* responsible for returning the data requested by the CRD Server needed to provide that decision support.  This capability statement does not define the CDS Hooks capabilities as there is no standard way to do that yet.  Instead, it focuses on the 'server' capabilities needed to respond to CRD Server queries.  These capabilities are based on US Core.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]
    }
  ],
  "kind": "requirements",
  "imports": [
    "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server|7.0.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.2.0-snapshot/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": "MAY"
                }
              ],
              "code": "update",
              "documentation": "Allows annotating the appointment in response to a card.  (CRD Clients **SHALL** support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)"
            }
          ],
          "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": "MAY"
                }
              ],
              "code": "update",
              "documentation": "Allows annotating the communication request in response to a card.  (CRD Clients **SHALL** support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)"
            }
          ],
          "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": "MAY"
                }
              ],
              "code": "update",
              "documentation": "Allows annotating the device request in response to a card.  (CRD Clients **SHALL** support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)"
            }
          ],
          "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"
        },
        {
          "type": "MedicationRequest",
          "supportedProfile": [
            "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-medicationrequest"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "update",
              "documentation": "Allows annotating the medication request in response to a card.  (CRD Clients **SHALL** support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)"
            }
          ],
          "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": "MAY"
                }
              ],
              "code": "update",
              "documentation": "Allows annotating the nutrition order in response to a card.  (CRD Clients **SHALL** support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)"
            }
          ],
          "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": "MAY"
                }
              ],
              "code": "update",
              "documentation": "Allows annotating the service requests in response to a card.  (CRD Clients **SHALL** support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)"
            }
          ],
          "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": "MAY"
                }
              ],
              "code": "update",
              "documentation": "Allows annotating the vision prescription in response to a card.  (CRD Clients **SHALL** support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)"
            }
          ],
          "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."
            }
          ]
        },
        {
          "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.)"
            }
          ]
        }
      ]
    }
  ]
}