Skip to main content
POST
Create a new caregap.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

quality_program
string
required

Body

application/json
definition_id
string
required

Definition id this caregap is associated with.

patient_id
string
required

Patient id this caregap is associated with.

practice_id
string
required

Practice id this caregap is associated with.

created_date
string<date>
required

ISO timestamp for when this caregap was created.

status
enum<string>
required

Current status of the caregap

Available options:
open,
closed
detail
string

Extra detail about the caregap.

closed_date
string<date>

ISO timestamp for when the caregap was closed.

closed_by
enum<string>

Who or what action closed the caregap.

Available options:
API,
condition-saved,
feedback

Response

Successful Response

definition_id
string
required

Definition id this caregap is associated with.

patient_id
string
required

Patient id this caregap is associated with.

practice_id
string
required

Practice id this caregap is associated with.

created_date
string<date>
required

ISO timestamp for when this caregap was created.

status
enum<string>
required

Current status of the caregap

Available options:
open,
closed
id
string
required

UUID to identify the caregap

quality_program
string
required

Quality program this caregap is associated with.

detail
string

Extra detail about the caregap.

closed_date
string<date>

ISO timestamp for when the caregap was closed.

closed_by
enum<string>

Who or what action closed the caregap.

Available options:
API,
condition-saved,
feedback