{ "openapi": "3.0.2", "info": { "title": "CPG Interactive Service Capabilities", "description": "Expected capabilities of a CPG Interactive Service, which generates questionnaires for missing case features and re-evaluates recommendations as data is captured, as described in Interactive Clinical Decision Support.", "license": { "name": "Creative Commons Zero v1.0 Universal", "url": "http://spdx.org/licenses/CC0-1.0.html" }, "version": "3.0.0-ballot", "contact": { "name": "HL7 International / Clinical Decision Support", "url": "http://www.hl7.org/Special/committees/dss" } }, "externalDocs": { "url": "http://hl7.org/fhir/uv/cpg/CapabilityStatement/cpg-interactive-service", "description": "FHIR CapabilityStatement" }, "paths": { "/metadata": { "summary": "Access to the Server\u0027s Capability Statement", "description": "All FHIR Servers return a CapabilityStatement that describes what services they perform", "get": { "summary": "Return the server\u0027s capability statement", "operationId": "metadata", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the capbility statement", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/CapabilityStatement" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/CapabilityStatement.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" } ] } }, "/PlanDefinition": { "summary": "manage the collection of resources of type PlanDefinition", "description": "Access to services to manage the collection of all resources of type PlanDefinition", "get": { "summary": "Search all resources of type PlanDefinition based on a set of criteria", "operationId": "searchPlanDefinition", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Bundle" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Bundle.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" } ] } }, "/PlanDefinition/{rid}": { "summary": "Read/Write/etc resource instance of type PlanDefinition", "description": "Access to services to manage the state of a single resource of type PlanDefinition", "get": { "summary": "Read the current state of the resource", "operationId": "readPlanDefinition", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/PlanDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/PlanDefinition.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/StructureDefinition": { "summary": "manage the collection of resources of type StructureDefinition", "description": "Access to services to manage the collection of all resources of type StructureDefinition", "get": { "summary": "Search all resources of type StructureDefinition based on a set of criteria", "operationId": "searchStructureDefinition", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Bundle" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Bundle.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" } ] } }, "/StructureDefinition/{rid}": { "summary": "Read/Write/etc resource instance of type StructureDefinition", "description": "Access to services to manage the state of a single resource of type StructureDefinition", "get": { "summary": "Read the current state of the resource", "operationId": "readStructureDefinition", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/StructureDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/StructureDefinition.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/PlanDefinition/$apply": { "summary": "Operation $apply on type PlanDefinition", "description": "Operation $apply on type PlanDefinition", "get": { "summary": "$apply on type PlanDefinition", "description": "The apply operation applies a PlanDefinition to a given context", "operationId": "op-apply-PlanDefinition", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/PlanDefinition/{rid}/$apply": { "summary": "Operation $apply on instance of PlanDefinition", "description": "Operation $apply on an instance of PlanDefinition", "get": { "summary": "$apply on PlanDefinition instance", "description": "The apply operation applies a PlanDefinition to a given context", "operationId": "op-apply-PlanDefinition-instance", "parameters": [ { "$ref": "#/components/parameters/rid" } ], "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/PlanDefinition/$questionnaire": { "summary": "Operation $questionnaire on type PlanDefinition", "description": "Operation $questionnaire on type PlanDefinition", "get": { "summary": "$questionnaire on type PlanDefinition", "description": "Generates a Questionnaire instance based on a specified PlanDefinition, creating questionnaire group items for each data requirement (StructureDefinition) referenced by action.input. A child questionnaire item is generated for each of the StructureDefinition elements.", "operationId": "op-questionnaire-PlanDefinition", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/PlanDefinition/{rid}/$questionnaire": { "summary": "Operation $questionnaire on instance of PlanDefinition", "description": "Operation $questionnaire on an instance of PlanDefinition", "get": { "summary": "$questionnaire on PlanDefinition instance", "description": "Generates a Questionnaire instance based on a specified PlanDefinition, creating questionnaire group items for each data requirement (StructureDefinition) referenced by action.input. A child questionnaire item is generated for each of the StructureDefinition elements.", "operationId": "op-questionnaire-PlanDefinition-instance", "parameters": [ { "$ref": "#/components/parameters/rid" } ], "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/StructureDefinition/$questionnaire": { "summary": "Operation $questionnaire on type StructureDefinition", "description": "Operation $questionnaire on type StructureDefinition", "get": { "summary": "$questionnaire on type StructureDefinition", "description": "Generates a Questionnaire instance based on a specified StructureDefinition, creating questions for a minimal set of elements or extension elements found in the Structure Definition.", "operationId": "op-questionnaire-StructureDefinition", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/StructureDefinition/{rid}/$questionnaire": { "summary": "Operation $questionnaire on instance of StructureDefinition", "description": "Operation $questionnaire on an instance of StructureDefinition", "get": { "summary": "$questionnaire on StructureDefinition instance", "description": "Generates a Questionnaire instance based on a specified StructureDefinition, creating questions for a minimal set of elements or extension elements found in the Structure Definition.", "operationId": "op-questionnaire-StructureDefinition-instance", "parameters": [ { "$ref": "#/components/parameters/rid" } ], "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Questionnaire/$populate": { "summary": "Operation $populate on type Questionnaire", "description": "Operation $populate on type Questionnaire", "get": { "summary": "$populate on type Questionnaire", "description": "Generates a [QuestionnaireResponse](http://hl7.org/fhir/R4/questionnaireresponse.html) instance based on a specified [Questionnaire](http://hl7.org/fhir/R4/questionnaire.html), filling in answers to questions where possible based on information provided as part of the operation or already known by the server about the subject of the [Questionnaire](http://hl7.org/fhir/R4/questionnaire.html).\n\nIf the operation is not called at the instance level, one and only one of the identifier, questionnaire or questionnaireRef `in` parameters must be provided.\n\nIf called at the instance level, these parameters will be ignored.\nThe response will contain a [QuestionnaireResponse](http://hl7.org/fhir/R4/questionnaireresponse.html) instance based on the specified [Questionnaire](http://hl7.org/fhir/R4/questionnaire.html) and/or an [OperationOutcome](http://hl7.org/fhir/R4/operationoutcome.html) resource with errors or warnings.\n\nThe [QuestionnaireResponse](http://hl7.org/fhir/R4/questionnaireresponse.html) instance will be populated with an unanswered set of questions following the group and question structure of the specified [Questionnaire](http://hl7.org/fhir/R4/questionnaire.html).\n\nIf *content* parameters were specified or the *local* parameter was set to true, some of the questions may have answers filled in as well. In the case of repeating questions or groups, typically only one repetition will be provided unless answer values exist that would support populating multiple repetitions. \n\nPopulation of the [QuestionnaireResponse](http://hl7.org/fhir/R4/questionnaireresponse.html) with appropriate data is dependent on the questions and/or groups in the [Questionnaire](http://hl7.org/fhir/R4/questionnaire.html) having metadata that allows the server to recognize the questions. Guidance on mechanisms to perform population can be found [here](populate.html). \nRegardless of the mechanism used to link the questions in a questionnaire to a \\\"known\\\" mappable concept, solutions using this operation should ensure that the details of the question and associated linkage element are sufficiently similar as to safely allow auto-population; i.e. the question text and context must be sufficiently the same, the value set for the question must fall within the value set for the mapped element, the data types must be the same or convertible, etc.\"\n", "operationId": "op-populate-Questionnaire", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Questionnaire/{rid}/$populate": { "summary": "Operation $populate on instance of Questionnaire", "description": "Operation $populate on an instance of Questionnaire", "get": { "summary": "$populate on Questionnaire instance", "description": "Generates a [QuestionnaireResponse](http://hl7.org/fhir/R4/questionnaireresponse.html) instance based on a specified [Questionnaire](http://hl7.org/fhir/R4/questionnaire.html), filling in answers to questions where possible based on information provided as part of the operation or already known by the server about the subject of the [Questionnaire](http://hl7.org/fhir/R4/questionnaire.html).\n\nIf the operation is not called at the instance level, one and only one of the identifier, questionnaire or questionnaireRef `in` parameters must be provided.\n\nIf called at the instance level, these parameters will be ignored.\nThe response will contain a [QuestionnaireResponse](http://hl7.org/fhir/R4/questionnaireresponse.html) instance based on the specified [Questionnaire](http://hl7.org/fhir/R4/questionnaire.html) and/or an [OperationOutcome](http://hl7.org/fhir/R4/operationoutcome.html) resource with errors or warnings.\n\nThe [QuestionnaireResponse](http://hl7.org/fhir/R4/questionnaireresponse.html) instance will be populated with an unanswered set of questions following the group and question structure of the specified [Questionnaire](http://hl7.org/fhir/R4/questionnaire.html).\n\nIf *content* parameters were specified or the *local* parameter was set to true, some of the questions may have answers filled in as well. In the case of repeating questions or groups, typically only one repetition will be provided unless answer values exist that would support populating multiple repetitions. \n\nPopulation of the [QuestionnaireResponse](http://hl7.org/fhir/R4/questionnaireresponse.html) with appropriate data is dependent on the questions and/or groups in the [Questionnaire](http://hl7.org/fhir/R4/questionnaire.html) having metadata that allows the server to recognize the questions. Guidance on mechanisms to perform population can be found [here](populate.html). \nRegardless of the mechanism used to link the questions in a questionnaire to a \\\"known\\\" mappable concept, solutions using this operation should ensure that the details of the question and associated linkage element are sufficiently similar as to safely allow auto-population; i.e. the question text and context must be sufficiently the same, the value set for the question must fall within the value set for the mapped element, the data types must be the same or convertible, etc.\"\n", "operationId": "op-populate-Questionnaire-instance", "parameters": [ { "$ref": "#/components/parameters/rid" } ], "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/QuestionnaireResponse/$extract": { "summary": "Operation $extract on type QuestionnaireResponse", "description": "Operation $extract on type QuestionnaireResponse", "get": { "summary": "$extract on type QuestionnaireResponse", "description": "The Extract operation takes a completed QuestionnaireResponse and converts it to a FHIR resource or Bundle of resources by using metadata embedded in the Questionnaire the QuestionnaireResponse is based on. \r\n The extracted resources might include Observations, MedicationStatements and other standard FHIR resources which can then be shared and manipulated.\r\n When invoking the $extract operation, care should be taken that the submitted QuestionnaireResponse is itself valid. If not, the extract operation could fail (with appropriate OperationOutcomes)\r\n or, more problematic, might succeed but provide incorrect output.", "operationId": "op-extract-QuestionnaireResponse", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/QuestionnaireResponse/{rid}/$extract": { "summary": "Operation $extract on instance of QuestionnaireResponse", "description": "Operation $extract on an instance of QuestionnaireResponse", "get": { "summary": "$extract on QuestionnaireResponse instance", "description": "The Extract operation takes a completed QuestionnaireResponse and converts it to a FHIR resource or Bundle of resources by using metadata embedded in the Questionnaire the QuestionnaireResponse is based on. \r\n The extracted resources might include Observations, MedicationStatements and other standard FHIR resources which can then be shared and manipulated.\r\n When invoking the $extract operation, care should be taken that the submitted QuestionnaireResponse is itself valid. If not, the extract operation could fail (with appropriate OperationOutcomes)\r\n or, more problematic, might succeed but provide incorrect output.", "operationId": "op-extract-QuestionnaireResponse-instance", "parameters": [ { "$ref": "#/components/parameters/rid" } ], "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } } }, "components": { "parameters": { "rid": { "name": "rid", "in": "path", "description": "id of the resource (\u003dResource.id)", "required": true, "allowEmptyValue": false, "style": "simple", "schema": { "type": "string" } }, "hid": { "name": "hid", "in": "path", "description": "id of the history entry (\u003dResource.meta.versionId)", "required": true, "allowEmptyValue": false, "style": "simple", "schema": { "type": "string" } }, "summary": { "name": "_summary", "in": "query", "description": "Requests the server to return a designated subset of the resource", "allowEmptyValue": true, "style": "form", "schema": { "type": "string", "enum": [ "true", "text", "data", "count", "false" ] } }, "format": { "name": "_format", "in": "query", "description": "Specify alternative response formats by their MIME-types (when a client is unable acccess accept: header)", "allowEmptyValue": true, "style": "form", "schema": { "type": "string", "format": "mime-type" } }, "pretty": { "name": "_pretty", "in": "query", "description": "Ask for a pretty printed response for human convenience", "allowEmptyValue": true, "style": "form", "schema": { "type": "boolean" } }, "elements": { "name": "_elements", "in": "query", "description": "Requests the server to return a collection of elements from the resource", "allowEmptyValue": true, "style": "form", "explode": false, "schema": { "type": "array", "format": "string", "items": { "format": "string" } } }, "count": { "name": "_count", "in": "query", "description": "The maximum number of search results on a page. The server is not bound to return the number requested, but cannot return more", "schema": { "type": "number" } } } } }