R6 Ballot (3rd Draft) FHIR CI-Build

Publish-box (todo) This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Example OperationDefinition/Measure-care-gaps (Narrative)

Maturity Level : N/A
Responsible Owner: Clinical Quality Information Work Group Standards Status : Informative Compartments : No defined compartments

This is the narrative for the resource. See also the XML , JSON or Turtle format.

Note that this is the formal definition for the care-gaps operation as an OperationDefinition on Measure. See the Operation documentation


Generated Narrative: OperationDefinition Measure-care-gaps

URL: [base]/Measure/$care-gaps

Parameters

Use Name Scope Cardinality Type Binding Documentation
IN periodStart measureUrl 1..1 1..* date canonical

The start URL of a measure for which the measurement period. In keeping with gaps in care report will be created. A measure URL is specified in the semantics url element of the date parameter used in Measure resource. The measure URL remains the FHIR search operation, same when the period will measure is stored on different servers.

IN periodStart 1..1 date

The start at of a gaps through period. This may be the beginning start of the measurement period implied defined by the supplied timestamp. E.g. a value of 2014 would set the measure, or a customized desired performance period s start date determined by a payer, a provider, a measure program, and etc.

IN periodEnd 1..1 date

The end of the measurement period. The a gaps through period (the gaps through date). The gaps through date could be a past date or a future date. For example, today's date is 2020-06-18, 1) if periodEnd date is 2020-09-30, it returns gaps through 2020-09-30, and 2) if the periodEnd date is 2020-05-31, it returns gaps through 2020-05-31.

IN subject 0..1 string
( reference )

Subject(s) for which the care gaps report will end at be produced. The subject may be a Patient, Practitioner, PractitionerRole, Organization, Location, Device, or Group. Subjects provided in this parameter SHALL match the end subjectType of the period implied by measure being evaluated (e.g. if the supplied timestamp. E.g. Measure.group.subjectType is Patient, the subject SHALL be a value reference to a Patient or a Group of 2014 would set Patients). If no subject is provided, what subjects are evaluated is up to the period end server. This parameter cannot be used with the subjectGroup parameter.

IN subjectGroup 0..1 Group

Subject for which the gaps in care report will be created is provided as a Group resource. Subjects provided in this parameter SHALL match the subjectType of the measure being evaluated. (e.g. if the Measure.group.subjectType is Patient, the subject SHALL be a reference to a Patient or a Group of Patients). If no subject is provided, what subjects are evaluated is up to the server. This parameter cannot be 2014-12-31T23:59:59 inclusive used with the subject parameter.

IN topic practitioner 1..1 0..1 string
( reference )

The topic Reference to a Practitioner for which the gaps in care report will be used created. For a practitioner focused gaps in care report, this is a required In Parameter. The Server needs to determine which make sure that practitioner is authorized to get the gaps in care report for and know what measures the practitioner are considered eligible or qualified.

IN organization 0..1 string
( reference )

Reference to an Organization for which the care gaps report. Any measure with in care report will be created. Either 'organization' or 'organizationResource' SHALL be provided, but not both.

IN organizationResource 0..1 Organization

Organization for which the given topic gaps in care report will be included created is provided as an Organization resource. This is intended to support the use case in which the report organization information is not on the server performing the evaluation, for example an ad-hoc group of practitioners that are part of a provider group. Either 'organization' or 'organizationResource' SHALL be provided, but not both.

IN subject location 1..1 0..* string
( reference )

Subject The location(s) for which the care gaps in care report will be produced run. This parameter is reflected in the location element of the resulting MeasureReport(s).

OUT IN return status 1..1 1..* Bundle code

Indicates status of a care gap. For all [open, closed, and prospective gaps], three seperate status parameters must be provided. For a positive proportion measure, gap means the patient is not in the numerator. For an inverse (negative) proportion measure (e.g., Diabetes: Hemoglobin A1c (HbA1c) Poor Control (> 9%)), gap means the patient is in the numerator.

IN isDocument 0..1 boolean

The result isDocument parameter controls whether a Gaps in Care Composition is returned in the Bundle (i.e. if the Bundle is of type 'Document'). When 'true,' the care gaps report returned Bundles contain the Gaps in Care Composition. This parameter defaults to 'true.'

IN parameters 0..1 Parameters

Any input parameters for the evaluation. Parameters defined in this input will be returned made available by name to the CQL expression. Parameter types are mapped to CQL as specified in the Using CQL with FHIR implementation guide. If a parameter appears more than once in the input Parameters resource, it is represented with a List in the input CQL. If a parameter has parts, it is represented as a Tuple in the input CQL.

IN manifest 0..1 canonical ( Library )

Specifies an asset-collection library that provides dependency version resolution and expansion rules for the operation. See the version manifest discussion in the Canonical Resource Management Infrastructure IG for a complete description of how manifest values are used to provide defaults for dependency version resolution and expansion parameters. Parameters specified directly in the operation override behaviors specified by the manifest parameter. In general, if this parameter is supplied, it is expected to be used in nested operation calls. For example, in evaluating a measure, if the expansion of a value set is required, this parameter SHALL be supplied to that expansion.

OUT return 0..* Bundle

The $care-gaps operation returns zero or more document bundle Bundles, one for each input subject. Consistent with FHIR Documents generally, each Bundle SHALL have a MeasureReport Composition as the first entry in the document Bundle, and that Composition SHALL be limited to a single subject. See the guidance on Bundle structure for each included measure discussion about the Bundle content and organization.\n\nNote that even though there is a single parameter named return of type Bundle, it is a multi-cardinality parameter, and so will still be returned using a Parameters resource, as described in the general operations framework response .

The effect of invoking this operation is to calculate a set of measures for a particular topic (e.g. Preventive Care and Screening) and return a document describing the results of each measure for the given subject. Note that it is up to the server to determine whether or not the generated care gaps report is persisted. If the server does not persist the results, the operation does not affect state and can be invoked with a GET


 

 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.