Current Build
Clinical Quality Information Work Group Maturity Level: 2Trial Use Compartments: N/A

The care-gaps operation is used to determine gaps-in-care based on the results of quality measures.

The official URL for this operation definition is

 http://hl7.org/fhir/OperationDefinition/Measure-care-gaps

Formal Definition (as a OperationDefinition).

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

This is not an idempotent operation

In Parameters:
NameCardinalityTypeBindingProfileDocumentation
periodStart1..1date

The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period s

periodEnd1..1date

The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive

topic1..1string

The topic to be used to determine which measures are considered for the care gaps report. Any measure with the given topic will be included in the report

subject1..1string
(reference)

Subject for which the care gaps report will be produced

Out Parameters:
NameCardinalityTypeBindingProfileDocumentation
return1..1Bundle

The result of the care gaps report will be returned as a document bundle with a MeasureReport entry for each included measure

Note: as this is the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource

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

Request: Request a care gaps report for a patient for all Preventive Care and Screening measures

GET [base]/Measure/$care-gaps?periodStart=2014&periodEnd=2014&topic=Preventive%20Care%20and%20Screening&patient=Patient/123

Response: Returned on successful evaluation

HTTP/1.1 200 OK

<Bundle xmlns="http://hl7.org/fhir">
    <type value="document"/>
    <entry>
        <resource>
            <Composition xmlns="http://hl7.org/fhir">
                <status value="final"/>
                <type>
                    <coding>
                        <system value="http://loinc.org"/>
                        <code value="57024-2"/>
                    </coding>
                </type>
                <subject>
                    <reference value="Patient/Patient-1153"/>
                </subject>
                <date value="2018-07-22"/>
                <author>
					<reference value="Organization/123"/>
                </author>
                <title value="Preventive Care and Screening Care Gap Report"/>
                <section>
                    <title value="Breast Cancer Screening Cohort Definition"/>
                    <entry>
                        <reference value="MeasureReport/be224ee3-20aa-4058-bf41-52a6be342d81"/>
                    </entry>
                </section>
                <section>
                  <title value="Cervical Cancer Screening Cohort Definition"/>
                  <entry>
                      <reference value="MeasureReport/86fa5aed-8193-4f55-835b-5bbafbd1e7d6"/>
                  </entry>
                </section>
            </Composition>
        </resource>
    </entry>
    <entry>
        <resource>
            <MeasureReport xmlns="http://hl7.org/fhir">
                <id value="be224ee3-20aa-4058-bf41-52a6be342d81"/>
                <contained>
                    <Bundle xmlns="http://hl7.org/fhir">
                        <id value="3eb57f94-7b33-48b1-9673-3b18634dca04"/>
                        <type value="collection"/>
                    </Bundle>
                </contained>
                <status value="complete"/>
                <type value="individual"/>
                <measure value="Measure/measure-bcs"/>
                <subject>
                    <reference value="Patient/Patient-1153"/>
                </subject>
                <period>
                    <start value="2017-01-01T00:00:00+00:00"/>
                    <end value="2017-12-31T00:00:00+00:00"/>
                </period>
                <group>
                    <population>
                        <code>
                            <coding>
                                <code value="initial-population"/>
                            </coding>
                        </code>
                        <count value="1"/>
                    </population>
                    <population>
                        <code>
                            <coding>
                                <code value="numerator"/>
                            </coding>
                        </code>
                        <count value="0"/>
                    </population>
                    <population>
                        <code>
                            <coding>
                                <code value="denominator"/>
                            </coding>
                        </code>
                        <count value="1"/>
                    </population>
                </group>
                <evaluatedResource>
                    <reference value="#3eb57f94-7b33-48b1-9673-3b18634dca04"/>
                </evaluatedResource>
            </MeasureReport>
        </resource>
    </entry>
    <entry>
      <resource>
        <MeasureReport xmlns="http://hl7.org/fhir">
            <id value="86fa5aed-8193-4f55-835b-5bbafbd1e7d6"/>
            <contained>
                <Bundle xmlns="http://hl7.org/fhir">
                    <id value="8e6e9224-59b6-4edd-b17f-58981a754e57"/>
                    <type value="collection"/>
                </Bundle>
            </contained>
            <status value="complete"/>
            <type value="individual"/>
            <measure value="Measure/measure-ccs"/>
            <subject>
                <reference value="Patient/Patient-1153"/>
            </subject>
            <period>
                <start value="2017-01-01T00:00:00+00:00"/>
                <end value="2017-12-31T00:00:00+00:00"/>
            </period>
            <group>
                <population>
                    <code>
                        <coding>
                            <code value="initial-population"/>
                        </coding>
                    </code>
                    <count value="1"/>
                </population>
                <population>
                    <code>
                        <coding>
                            <code value="numerator"/>
                        </coding>
                    </code>
                    <count value="1"/>
                </population>
                <population>
                    <code>
                        <coding>
                            <code value="denominator"/>
                        </coding>
                    </code>
                    <count value="1"/>
                </population>
            </group>
            <evaluatedResource>
                <reference value="#8e6e9224-59b6-4edd-b17f-58981a754e57"/>
            </evaluatedResource>
        </MeasureReport>
      </resource>
    </entry>
</Bundle>

 

For more information about operations, including how they are invoked, see Operations.