XIG: CapabilityStatement/light-dtr-ehr-700

FHIR IG Statistics: CapabilityStatement/light-dtr-ehr-700

Package	hl7.fhir.us.davinci-dtr
Resource Type	CapabilityStatement
Id	light-dtr-ehr-700
FHIR Version	R4
Source	http://hl7.org/fhir/us/davinci-dtr/https://build.fhir.org/ig/HL7/davinci-dtr/CapabilityStatement-light-dtr-ehr-700.html
URL	http://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/light-dtr-ehr-700
Version	2.2.0-ballot
Status	active
Date	2024-08-02
Name	LightDTREHR
Title	Light DTR EHR
Realm	us
Authority	hl7
Description	This statement defines the expected capabilities of EHRs that rely on a SMART on FHIR application for USCDI 3 (US-Core 6.1) and USCDI 4 (US-Core 7.0) to handle the form filling function of DTR. This requires the server to provide access to the specified resources to allow such an app to retrieve and edit QuestionnaireResponses and related resources.
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

CapabilityStatement
us-core-server	US Core Server CapabilityStatement

SearchParameter
qr-context	QRcontext

StructureDefinition
profile-task	PAS Task
profile-communicationrequest	CRD Communication Request
profile-devicerequest	CRD Device Request
profile-encounter	CRD Encounter
profile-medicationrequest	CRD Medication Request
profile-nutritionorder	CRD Nutrition Order
profile-servicerequest	CRD Service Request
profile-visionprescription	CRD Vision Prescription
dtr-questionnaireresponse	DTR Questionnaire Response

Narrative

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

Light DTR EHR

Official URL:http://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/light-dtr-ehr-700
Implementation Guide Version: 2.1.0-preview
FHIR Version: 4.0.1
Intended Use: Requirements
Supported Formats: JSON
Published: 2024-08-02
Published by: HL7 International / Clinical Decision Support
Status: Active

This statement defines the expected capabilities of EHRs that rely on a SMART on FHIR application for USCDI 3 (US-Core 6.1) and USCDI 4 (US-Core 7.0) to handle the form filling function of DTR. This requires the server to provide access to the specified resources to allow such an app to retrieve and edit QuestionnaireResponses and related resources.

Include And Support Everything In The Following CapabilityStatements:

US Core Server CapabilityStatement

FHIR Server RESTful Capabilities

EHR systems which leverage a SMART app to manage data capture and rules execution, but which must be able to launch the SMART app.

Security:

Implementations SHALL meet the general security requirements documented in the HRex implementation guide.

RESTful Capabilities by Resource/Profile:

Summary

♦ = SHALL expectation;⋄ = SHOULD expectation;▿ = MAY expectation;

Resource Type Supported Interactions Supported Profiles Supported Searches Supported _includes Supported _revincludes Supported Operations

QuestionnaireResponse read^♦, create^♦, update^♦, search-type^♦ DTR Questionnaire Response context^♦, patient^♦

Encounter read^⋄ CRD Encounter

DeviceRequest read^⋄ CRD Device Request

MedicationRequest read^⋄ CRD Medication Request

NutritionOrder read^⋄ CRD Nutrition Order

CommunicationRequest read^⋄ CRD Communication Request

ServiceRequest read^⋄ CRD Service Request

VisionPrescription read^⋄ CRD Vision Prescription

Task read^⋄, create^⋄, update^⋄ PAS Task Profile

QuestionnaireResponse

Supported Profiles:

DTR Questionnaire Response

Profile Interaction Summary:

SHALL support read, create, update, search-type.

Modify Criteria:

A Server SHALL be capable of creating a QuestionnaireResponse resource using:POST [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}
A Server SHALL be capable of updating an existing QuestionnaireResponse resource using:PUT [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}

Fetch and Search Criteria:

A Server SHALL be capable of returning a QuestionnaireResponse resource using:GET [base]/QuestionnaireResponse/[id]
A Server SHALL be capable of returning resources matching a search query using:GET [base]/QuestionnaireResponse/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance Parameter Type Example

SHALL context reference GET [base]/QuestionnaireResponse?context=[type]/[id]

SHALL patient reference GET [base]/QuestionnaireResponse?patient=[type]/[id]

Conformance	Parameter	Type	Example
SHALL	context	reference	`GET [base]/QuestionnaireResponse?context=[type]/[id]`
SHALL	patient	reference	`GET [base]/QuestionnaireResponse?patient=[type]/[id]`

Search Parameter Requirements (When Used Alone or in Combination):

context (reference):
Allows retrieving QuestionnaireResponse for a context
patient (reference):
Allows retrieving QuestionnaireResponse for a patient

Encounter

Supported Profiles:

CRD Encounter

Profile Interaction Summary:

SHOULD support read.

Fetch and Search Criteria:

A Server SHOULD be capable of returning an Encounter resource using:GET [base]/Encounter/[id]

DeviceRequest

Supported Profiles:

CRD Device Request

Profile Interaction Summary:

SHOULD support read.

Fetch and Search Criteria:

A Server SHOULD be capable of returning a DeviceRequest resource using:GET [base]/DeviceRequest/[id]

MedicationRequest

Supported Profiles:

CRD Medication Request

Profile Interaction Summary:

SHOULD support read.

Fetch and Search Criteria:

A Server SHOULD be capable of returning a MedicationRequest resource using:GET [base]/MedicationRequest/[id]

NutritionOrder

Supported Profiles:

CRD Nutrition Order

Profile Interaction Summary:

SHOULD support read.

Fetch and Search Criteria:

A Server SHOULD be capable of returning a NutritionOrder resource using:GET [base]/NutritionOrder/[id]

CommunicationRequest

Supported Profiles:

CRD Communication Request

Profile Interaction Summary:

SHOULD support read.

Fetch and Search Criteria:

A Server SHOULD be capable of returning a CommunicationRequest resource using:GET [base]/CommunicationRequest/[id]

ServiceRequest

Supported Profiles:

CRD Service Request

Profile Interaction Summary:

SHOULD support read.

Fetch and Search Criteria:

A Server SHOULD be capable of returning a ServiceRequest resource using:GET [base]/ServiceRequest/[id]

VisionPrescription

Supported Profiles:

CRD Vision Prescription

Profile Interaction Summary:

SHOULD support read.

Fetch and Search Criteria:

A Server SHOULD be capable of returning a VisionPrescription resource using:GET [base]/VisionPrescription/[id]

Task

Supported Profiles:

PAS Task Profile

Profile Interaction Summary:

SHOULD support read, create, update.

Modify Criteria:

A Server SHOULD be capable of creating a Task resource using:POST [base]/Task/[id]{?_format=[mime-type]}
A Server SHOULD be capable of updating an existing Task resource using:PUT [base]/Task/[id]{?_format=[mime-type]}

Fetch and Search Criteria:

A Server SHOULD be capable of returning a Task resource using:GET [base]/Task/[id]

Source

{
  "resourceType": "CapabilityStatement",
  "id": "light-dtr-ehr-700",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cds"
    }
  ],
  "url": "http://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/light-dtr-ehr-700",
  "version": "2.2.0-ballot",
  "name": "LightDTREHR",
  "title": "Light DTR EHR",
  "status": "active",
  "experimental": false,
  "date": "2024-08-02",
  "publisher": "HL7 International / Clinical Decision Support",
  "contact": [
    {
      "name": "HL7 International / Clinical Decision Support",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description": "This statement defines the expected capabilities of EHRs that rely on a SMART on FHIR application for USCDI 3 (US-Core 6.1) and USCDI 4 (US-Core 7.0) to handle the form filling function of DTR. This requires the server to provide access to the specified resources to allow such an app to retrieve and edit QuestionnaireResponses and related resources.",
  "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": "EHR systems which leverage a SMART app to manage data capture and rules execution, but which must be able to launch the SMART app.",
      "security": {
        "description": "Implementations **SHALL** meet the general security requirements documented in the [HRex implementation guide](https://build.fhir.org/ig/HL7/davinci-ehrx)."
      },
      "resource": [
        {
          "type": "QuestionnaireResponse",
          "supportedProfile": [
            "http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-questionnaireresponse"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "context",
              "definition": "http://hl7.org/fhir/us/davinci-dtr/SearchParameter/qr-context",
              "type": "reference",
              "documentation": "Allows retrieving QuestionnaireResponse for a context"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "type": "reference",
              "documentation": "Allows retrieving QuestionnaireResponse for a patient"
            }
          ]
        },
        {
          "type": "Encounter",
          "supportedProfile": [
            "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-encounter|2.1.0"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            }
          ]
        },
        {
          "type": "DeviceRequest",
          "supportedProfile": [
            "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-devicerequest|2.1.0"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            }
          ]
        },
        {
          "type": "MedicationRequest",
          "supportedProfile": [
            "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-medicationrequest|2.1.0"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            }
          ]
        },
        {
          "type": "NutritionOrder",
          "supportedProfile": [
            "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-nutritionorder|2.1.0"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            }
          ]
        },
        {
          "type": "CommunicationRequest",
          "supportedProfile": [
            "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest|2.1.0"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            }
          ]
        },
        {
          "type": "ServiceRequest",
          "supportedProfile": [
            "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest|2.1.0"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            }
          ]
        },
        {
          "type": "VisionPrescription",
          "supportedProfile": [
            "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-visionprescription|2.1.0"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            }
          ]
        },
        {
          "type": "Task",
          "supportedProfile": [
            "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-task"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "update"
            }
          ]
        }
      ]
    }
  ]
}