| Package | hl7.fhir.us.davinci-ra |
| Resource Type | OperationDefinition |
| Id | risk-gap |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/davinci-ra/https://build.fhir.org/ig/HL7/davinci-ra/OperationDefinition-risk-gap.html |
| URL | http://hl7.org/fhir/us/davinci-ra/OperationDefinition/risk-gap |
| Version | 2.1.0 |
| Status | draft |
| Date | 2025-07-24T18:33:11+00:00 |
| Name | Risk Gap |
| Title | Risk Gap |
| Realm | us |
| Authority | hl7 |
| Description | The risk-gap operation is used to determine condition Category (CC) gaps for a patient/member. |
| Type | true |
| Kind | operation |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: OperationDefinition risk-gap
URL: [base]/MeasureReport/$risk-gap
URL: [base]/MeasureReport/[id]/$risk-gap
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | periodStart | 1..1 | date | The start of a clinical evaluation period. | ||
| IN | periodEnd | 1..1 | date | The end of a clinical evaluation period. | ||
| IN | subject | 1..1 | Patient (US Core Patient Profile) | Patient resource as input parameter, which provides data such as patient's first name, last name, date of birth | ||
| IN | coverage | 1..1 | Coverage (US Core Coverage Profile) | This is a reference to the Coverage resource, which provides information such as the subscriberId | ||
| IN | TIN | 0..1 | string (token) | This is the provider rganization's TIN | ||
| IN | ccType | 0..* | code | Condition Category Type (Extensible) | This Condition Category (CC) gaps will be filterd based on the CC type code, whether it is suspected, historic, and/or net-new. | |
| IN | evidenceStatus | 0..* | code | Evidence Status (Extensible) | This Condition Category (CC) gaps will be filterd based on the evidence status, whether the gap is an open-gap, invalid-gap, closed-gap, and/or pending. | |
| IN | providerTaxonomy | 0..* | code | ProviderTaxonomy (Extensible) | This Condition Category (CC) gaps will be filterd based on provider taxonomy. | |
| IN | encounter | 0..1 | Encounter (US Core Encounter Profile) | This is a reference to the Encounter resource, which provides information such as the encounter id and date of service. | ||
| IN | contextId | 0..1 | string (token) | The contextId is intended to be used for 'non-standard' identifiers, for example, some systems may have an internally defined gap-request-id | ||
| IN | referenced | 0..* | Resource (reference) | Any resources that are referenced by other input parameters defined in this operation. For example, Coverage.payor that is an Organization resource referenced by Coverage , which can then be included here using this parameter 'referenced' | ||
| OUT | return | 0..1 | Bundle | This operation returns a Bundle of MeasureReports and associated resources |
{
"resourceType": "OperationDefinition",
"id": "risk-gap",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "cqi"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
}
],
"url": "http://hl7.org/fhir/us/davinci-ra/OperationDefinition/risk-gap",
"version": "2.1.0",
"name": "Risk Gap",
"title": "Risk Gap",
"status": "draft",
"kind": "operation",
"date": "2025-07-24T18:33:11+00:00",
"publisher": "HL7 International / Clinical Quality Information",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/cqi"
}
]
}
],
"description": "The risk-gap operation is used to determine condition Category (CC) gaps for a patient/member.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US",
"display": "United States of America"
}
]
}
],
"code": "risk-gap",
"resource": [
"MeasureReport"
],
"system": false,
"type": true,
"instance": true,
"parameter": [
{
"name": "periodStart",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The start of a clinical evaluation period.",
"type": "date"
},
{
"name": "periodEnd",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The end of a clinical evaluation period.",
"type": "date"
},
{
"name": "subject",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Patient resource as input parameter, which provides data such as patient's first name, last name, date of birth",
"type": "Patient",
"targetProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|7.0.0"
]
},
{
"name": "coverage",
"use": "in",
"min": 1,
"max": "1",
"documentation": "This is a reference to the Coverage resource, which provides information such as the subscriberId",
"type": "Coverage",
"targetProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-coverage|7.0.0"
]
},
{
"name": "TIN",
"use": "in",
"min": 0,
"max": "1",
"documentation": "This is the provider rganization's TIN",
"type": "string",
"searchType": "token"
},
{
"name": "ccType",
"use": "in",
"min": 0,
"max": "*",
"documentation": "This Condition Category (CC) gaps will be filterd based on the CC type code, whether it is suspected, historic, and/or net-new.",
"type": "code",
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/us/davinci-ra/ValueSet/cc-type"
}
},
{
"name": "evidenceStatus",
"use": "in",
"min": 0,
"max": "*",
"documentation": "This Condition Category (CC) gaps will be filterd based on the evidence status, whether the gap is an open-gap, invalid-gap, closed-gap, and/or pending.",
"type": "code",
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/us/davinci-ra/ValueSet/evidence-status"
}
},
{
"name": "providerTaxonomy",
"use": "in",
"min": 0,
"max": "*",
"documentation": "This Condition Category (CC) gaps will be filterd based on provider taxonomy.",
"type": "code",
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/provider-taxonomy"
}
},
{
"name": "encounter",
"use": "in",
"min": 0,
"max": "1",
"documentation": "This is a reference to the Encounter resource, which provides information such as the encounter id and date of service.",
"type": "Encounter",
"targetProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter|7.0.0"
]
},
{
"name": "contextId",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The contextId is intended to be used for 'non-standard' identifiers, for example, some systems may have an internally defined gap-request-id",
"type": "string",
"searchType": "token"
},
{
"name": "referenced",
"use": "in",
"min": 0,
"max": "*",
"documentation": "Any resources that are referenced by other input parameters defined in this operation. For example, Coverage.payor that is an Organization resource referenced by Coverage , which can then be included here using this parameter 'referenced'",
"type": "Resource",
"searchType": "reference"
},
{
"name": "return",
"use": "out",
"min": 0,
"max": "1",
"documentation": "This operation returns a Bundle of MeasureReports and associated resources",
"type": "Bundle"
}
]
}