Mock DMRP
Overview
An externally developed NHSN application is responsible for managing facility digital monthly reporting plans (DMRP). These plans track which NHSN measures (example: Hypo and RPS) a facility is enrolled in reporting for. Link Cloud interfaces with a deployed DMRP Rest API to manage the scheduled reporting plan for a facility. Because the DMRP API is exclusively available within the CDC environment, a version of the API has been developed to test external dependencies needed for scheduled reporting workflows.
OpenAPI Operations
Health check endpoint
Route Parameters
None
Query Parameters
None
Monthly medicine reporting plan. Placeholder shape.
Route Parameters
None
Query Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| nhsnorgid | string | No | |
| name | string | No | |
| year | string | No | |
| month | string | No |
Annual patient-safety reporting plan. Placeholder shape.
Route Parameters
None
Query Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| nhsnorgid | string | No | |
| name | string | No | |
| year | string | No | |
| month | string | No |
Gets one entry by identifier.
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| id | string | Yes |
Query Parameters
None
Updates an existing entry. Never creates one.
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| id | string | Yes |
Query Parameters
None
Deletes one entry.
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| id | string | Yes |
Query Parameters
None
Gets a facility's entries, paged. Answers an empty page when it has none.
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| facilityId | string | Yes |
Query Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| pageSize | integer (int32) | No | |
| pageNumber | integer (int32) | No |
Deletes a facility's entries. Idempotent.
Route Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| facilityId | string | Yes |
Query Parameters
None
Searches entries. Every filter is optional; answers an empty page when nothing matches.
Route Parameters
None
Query Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| facilityId | string | No | |
| component | string | No | |
| measure | string | No | |
| reportingMonth | integer (int32) | No | |
| reportingYear | integer (int32) | No | |
| isReporting | string | No | |
| sortBy | object | No | Fields a reporting plan entry search may be sorted by. |
| sortOrder | object | No | |
| pageSize | integer (int32) | No | |
| pageNumber | integer (int32) | No |
Creates an entry.
Route Parameters
None
Query Parameters
None
Deletes every entry.
Route Parameters
None
Query Parameters
None
Gets the artificial delay currently applied to the contract endpoints.
Route Parameters
None
Query Parameters
None
Sets an artificial delay on the contract endpoints, for exercising a caller's timeout and retry behaviour against a slow upstream.
Route Parameters
None
Query Parameters
None
Removes any artificial delay. Idempotent.
Route Parameters
None
Query Parameters
None
Issues the token the contract endpoints accept, standing in for the reporting system's authorization server.
Route Parameters
None
Query Parameters
None
Route Parameters
None
Query Parameters
None
Relationships
flowchart LR nmock_dmrp_90E935E["Service: Mock DMRP"]