Clinical Practice Guidelines
3.0.0-ballot - STU 3 Ballot International flag

Clinical Practice Guidelines, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions

CapabilityStatement: CPG Interactive Client Capabilities

Official URL: http://hl7.org/fhir/uv/cpg/CapabilityStatement/cpg-interactive-client Version: 3.0.0-ballot
Active as of 2026-11-02 Computable Name: CPGInteractiveClientCapabilities
Other Identifiers: OID:2.16.840.1.113883.4.642.40.48.13.3

Expected capabilities of a CPG Interactive Client, which renders and completes questionnaires and presents the resulting case plan summary.

Raw OpenAPI-Swagger Definition file | Download

Language: en

CPG Interactive Client Capabilities

  • Implementation Guide Version: 3.0.0-ballot
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Published on: 2026-11-02
  • Published by: HL7 International / Clinical Decision Support

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.

FHIR RESTful Capabilities

Mode: client

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
PlanDefinition yy$apply, $questionnaire
StructureDefinition yy$questionnaire
Questionnaire $populate
QuestionnaireResponse $extract

Core FHIR Resource
PlanDefinition
Reference Policy
Interaction summary
  • Supports read, search-type.

Extended Operations
ConformanceOperationDocumentation
SHALL$apply
SHALL$questionnaire
Core FHIR Resource
StructureDefinition
Reference Policy
Interaction summary
  • Supports read, search-type.

Extended Operations
ConformanceOperationDocumentation
SHOULD$questionnaire

Supports adaptive questionnaires, returning only the questions relevant to the current state of the apply cycle.

Core FHIR Resource
Questionnaire
Reference Policy
Interaction summary

    Extended Operations
    ConformanceOperationDocumentation
    SHALL$populate

    Populates the questionnaire using expression-based population.

    Core FHIR Resource
    QuestionnaireResponse
    Reference Policy
    Interaction summary

      Extended Operations
      ConformanceOperationDocumentation
      SHALL$extract

      Extracts resources from the completed questionnaire response using definition-based extraction.