This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Clinical Quality Information Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw JSON (canonical form + also see JSON Format Specification)
Operation Definition
{ "resourceType" : "OperationDefinition", "id" : "Measure-care-gaps", "text" : { "status" : "extensions", "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/Measure/$care-gaps</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>periodStart</td><td>1..1</td><td><a href=\"datatypes.html#date\">date</a></td><td/><td><div><p>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</p>\n</div></td></tr><tr><td>IN</td><td>periodEnd</td><td>1..1</td><td><a href=\"datatypes.html#date\">date</a></td><td/><td><div><p>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</p>\n</div></td></tr><tr><td>IN</td><td>topic</td><td>1..1</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>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</p>\n</div></td></tr><tr><td>IN</td><td>subject</td><td>1..1</td><td><a href=\"datatypes.html#string\">string</a><br/>(<a href=\"search.html#reference\">reference</a>)</td><td/><td><div><p>Subject for which the care gaps report will be produced</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td>1..1</td><td><a href=\"bundle.html\">Bundle</a></td><td/><td><div><p>The result of the care gaps report will be returned as a document bundle with a MeasureReport entry for each included measure</p>\n</div></td></tr></table><div><p>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</p>\n</div></div>" }, "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger" : 3 }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode" : "trial-use" }], "url" : "http://hl7.org/fhir/OperationDefinition/Measure-care-gaps", "version" : "5.0.0-ballot", "name" : "CareGaps", "title" : "Care Gaps", "status" : "draft", "kind" : "operation", "experimental" : false, "date" : "2022-09-10T04:52:37+10:00", "publisher" : "HL7 (FHIR Project)", "contact" : [{ "telecom" : [{ "system" : "url", "value" : "http://hl7.org/fhir" }, { "system" : "email", "value" : "fhir@lists.hl7.org" }] }], "description" : "The care-gaps operation is used to determine gaps-in-care based on the results of quality measures", "affectsState" : false, "code" : "care-gaps", "comment" : "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", "resource" : ["Measure"], "system" : false, "type" : true, "instance" : false, "parameter" : [{ "name" : "periodStart", "use" : "in", "min" : 1, "max" : "1", "documentation" : "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", "type" : "date" }, { "name" : "periodEnd", "use" : "in", "min" : 1, "max" : "1", "documentation" : "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", "type" : "date" }, { "name" : "topic", "use" : "in", "min" : 1, "max" : "1", "documentation" : "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", "type" : "string" }, { "name" : "subject", "use" : "in", "min" : 1, "max" : "1", "documentation" : "Subject for which the care gaps report will be produced", "type" : "string", "searchType" : "reference" }, { "name" : "return", "use" : "out", "min" : 1, "max" : "1", "documentation" : "The result of the care gaps report will be returned as a document bundle with a MeasureReport entry for each included measure", "type" : "Bundle" }] }
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.
FHIR ®© HL7.org 2011+. FHIR R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Sat, Sep 10, 2022 05:04+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4B |
Compare to R5 Draft |
|
Propose a change