measure reports
Create Measure Report
post
/organizations/{organizationId}/fhir/3/MeasureReport
The MeasureReport resource contains the results of evaluating a measure.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | MeasureReport | This is a MeasureReport resource |
| identifier | Identifier | A formal identifier that is used to identify this report when it is represented in other formats, or referenced in a specification, model, design or an instance. | |
| status | string | complete|pending|error | The report status. No data will be available until the report status is complete. |
| type | string | individual|patient-list|summary | The type of measure report. This may be an individual report, which provides a single patient's score for the measure; a patient listing, which returns the list of patients that meet the various criteria in the measure; or a summary report, which returns a population count for each of the criteria in the measure. |
| measure* | Reference | A reference to the Measure that was evaluated to produce this report. | |
| patient | Reference | Optional Patient if the report was requested for a single patient. | |
| date | string | The date this measure report was generated. | |
| reportingOrganization | Reference | Reporting Organization. | |
| period* | Period | The reporting period for which the report was calculated. | |
| group | array(MeasureReport_Group) | The results of the calculation, one for each population group in the measure. | |
| evaluatedResources | Reference | A reference to a Bundle containing the Resources that were used in the evaluation of this report. |
Response
keyboard_arrow_down
Patch Measure Report
patch
/organizations/{organizationId}/fhir/3/MeasureReport/{resourceId}
The MeasureReport resource contains the results of evaluating a measure.
Request
Headers
| content-type* | string | application/json-patch+json | application/json-patch+json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | MeasureReport | This is a MeasureReport resource |
| identifier | Identifier | A formal identifier that is used to identify this report when it is represented in other formats, or referenced in a specification, model, design or an instance. | |
| status | string | complete|pending|error | The report status. No data will be available until the report status is complete. |
| type | string | individual|patient-list|summary | The type of measure report. This may be an individual report, which provides a single patient's score for the measure; a patient listing, which returns the list of patients that meet the various criteria in the measure; or a summary report, which returns a population count for each of the criteria in the measure. |
| measure* | Reference | A reference to the Measure that was evaluated to produce this report. | |
| patient | Reference | Optional Patient if the report was requested for a single patient. | |
| date | string | The date this measure report was generated. | |
| reportingOrganization | Reference | Reporting Organization. | |
| period* | Period | The reporting period for which the report was calculated. | |
| group | array(MeasureReport_Group) | The results of the calculation, one for each population group in the measure. | |
| evaluatedResources | Reference | A reference to a Bundle containing the Resources that were used in the evaluation of this report. |
Response
keyboard_arrow_down
Read Measure Report
get
/organizations/{organizationId}/fhir/3/MeasureReport/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read History Measure Report
get
/organizations/{organizationId}/fhir/3/MeasureReport/{resourceId}/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read Version Measure Report
get
/organizations/{organizationId}/fhir/3/MeasureReport/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* | |||
| versionId* |
Response
keyboard_arrow_down
Remove Measure Report
delete
/organizations/{organizationId}/fhir/3/MeasureReport/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Search Get Measure Report
get
/organizations/{organizationId}/fhir/3/MeasureReport
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| identifier | string | ||
| patient | string | ||
| status | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Measure Report
get
/organizations/{organizationId}/fhir/3/MeasureReport/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search Post Measure Report
post
/organizations/{organizationId}/fhir/3/MeasureReport/_search
The MeasureReport resource contains the results of evaluating a measure.
Request
Headers
| content-type* | string | application/json|application/x-www-form-urlencoded | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| identifier | string | ||
| patient | string | ||
| status | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | MeasureReport | This is a MeasureReport resource |
| identifier | Identifier | A formal identifier that is used to identify this report when it is represented in other formats, or referenced in a specification, model, design or an instance. | |
| status | string | complete|pending|error | The report status. No data will be available until the report status is complete. |
| type | string | individual|patient-list|summary | The type of measure report. This may be an individual report, which provides a single patient's score for the measure; a patient listing, which returns the list of patients that meet the various criteria in the measure; or a summary report, which returns a population count for each of the criteria in the measure. |
| measure* | Reference | A reference to the Measure that was evaluated to produce this report. | |
| patient | Reference | Optional Patient if the report was requested for a single patient. | |
| date | string | The date this measure report was generated. | |
| reportingOrganization | Reference | Reporting Organization. | |
| period* | Period | The reporting period for which the report was calculated. | |
| group | array(MeasureReport_Group) | The results of the calculation, one for each population group in the measure. | |
| evaluatedResources | Reference | A reference to a Bundle containing the Resources that were used in the evaluation of this report. |
Response
keyboard_arrow_down
Update Measure Report
put
/organizations/{organizationId}/fhir/3/MeasureReport/{resourceId}
The MeasureReport resource contains the results of evaluating a measure.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | MeasureReport | This is a MeasureReport resource |
| identifier | Identifier | A formal identifier that is used to identify this report when it is represented in other formats, or referenced in a specification, model, design or an instance. | |
| status | string | complete|pending|error | The report status. No data will be available until the report status is complete. |
| type | string | individual|patient-list|summary | The type of measure report. This may be an individual report, which provides a single patient's score for the measure; a patient listing, which returns the list of patients that meet the various criteria in the measure; or a summary report, which returns a population count for each of the criteria in the measure. |
| measure* | Reference | A reference to the Measure that was evaluated to produce this report. | |
| patient | Reference | Optional Patient if the report was requested for a single patient. | |
| date | string | The date this measure report was generated. | |
| reportingOrganization | Reference | Reporting Organization. | |
| period* | Period | The reporting period for which the report was calculated. | |
| group | array(MeasureReport_Group) | The results of the calculation, one for each population group in the measure. | |
| evaluatedResources | Reference | A reference to a Bundle containing the Resources that were used in the evaluation of this report. |
Response
keyboard_arrow_down