DSTU2 QA Preview

This page is part of the FHIR Specification (v1.0.0: DSTU 2 Ballot 3). The current version which supercedes this version is 4.0.1. For a full list of available versions, see the Directory of published versions

G.?? Basic CQIF Extensions

Defines common extensions used by the Clinical Quality Improvement Framework profiles.

G.??.1 Content

Extensions:
cqif-basic-moduleA reference to a knowledge module :

A reference to a knowledge module involved in an interaction.

cqif-basic-evaluationSupportedIndicates whether or not the service supports evaluation of the module :

Indicates whether or not the service supports evaluation of the module. If evaluation is supported, an evaluation operation must be exposed as defined by this implementation guide.

cqif-basic-inputParametersThe input parameters for a request, if any :

The input parameters for a request, if any. These parameters are used to provide patient-independent information to the evaluation. Patient-specific information is either accessed directly as part of the evaluation (because the evaluation engine and the patient-data are co-located) or provided as part of the operation input in the form of resources.

cqif-basic-outputParametersThe output parameters of the evaluation, if any :

The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.

cqif-basic-responseStatusThe status of the response :

The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.

cqif-basic-evaluationMessageMessages resulting from the evaluation of the artifact or artifacts :

Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.

cqif-basic-requestIdThe id of the request associated with this response, if any :

The id of the request associated with this response. If an id was provided as part of the request, it will be provided here to enable the requester to more easily identify the response in a multi-request scenario.

cqif-basic-requestDateTimeThe date and time of the request :

The date and time of the request, with respect to the initiator.

cqif-basic-evaluateAtDateTimeIndicates that the evaluation should be performed as though it was the given date and time :

Indicates that the evaluation should be performed as though it was the given date and time. The most direct implication of this is that references to "Now" within the evaluation logic of the module should result in this value. In addition, wherever possible, the data accessed by the module should appear as though it was accessed at this time. The evaluateAtDateTime value may be any time in the past or future, enabling both retrospective and prospective scenarios. If no value is provided, the requestDateTime is assumed.

cqif-basic-moduleVersionThe version of the module, if any :

The version of the module, if any. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge modules, refer to the Decision Support Service specification.

cqif-basic-titletitle :

A short, descriptive title for the module.

cqif-basic-descriptiondescription :

A description of the module from the consumer perspective.

cqif-basic-purposepurpose :

A brief description of the purpose of the module.

cqif-basic-usageusage :

Notes about usage of the module.

cqif-basic-publicationDatepublicationDate :

The date on which the module was published.

cqif-basic-lastReviewDatelastReviewDate :

The date on which the module content was last reviewed.

cqif-basic-effectivePeriodeffectivePeriod :

The period during which the module content is effective.

cqif-basic-moduleStatusstatus :

The status of the module.

cqif-basic-topictopic :

Clinical topics related to the content of the module.

cqif-basic-keywordkeyword :

Keywords associated with the module.

cqif-basic-contributorcontributor :

A contributor to the content of the module.

cqif-basic-publisherpublisher :

The organization responsible for publishing the module.

cqif-basic-stewardsteward :

The organization responsible for stewardship of the module content.

cqif-basic-rightsDeclarationrightsDeclaration :

The legal rights declaration for the module.

cqif-basic-relatedResourcerelatedResource :

Related resources such as additional documentation, supporting evidence, or bibliographic references.

cqif-basic-modelmodel :

A model reference used by the content.

cqif-basic-libraryA library referenced by the module :

A library referenced by the module. The reference must consist of either an id, or a document reference.

cqif-basic-codeSystemcodeSystem :

A code system definition used within the knowledge module.

cqif-basic-valueSetvalueSet :

A value set definition used by the knowledge module.

cqif-basic-parameterparameter :

Parameters to the module.

cqif-basic-dataDescribes a required data item :

Describes a required data item for evaluation in terms of the type of data, and optional code- or date-based filters of the data.

cqif-basic-contentThe content of the module :

The content of the module, if any. If this is a library, this would be the CQL or ELM representation of the library contents.

cqif-basic-expressionThe name of an expression in a referenced library :

The name of an expression in a referenced library that describes the logic for a particular context.

cqif-basic-qualityOfEvidenceThe quality of the evidence :

The quality of the evidence described. The code system used specifies the quality scale used to grade this evidence source while the code specifies the actual quality score (represented as a coded value) associated with this evidence reference.

cqif-basic-strengthOfRecommendationThe strength of the recommendation :

The strength of the recommendation assigned to this reference. The code system specifies the scale used to grade the evidence source, while the code specifies the actual score (represented as a coded value) for the strength of the evidence.