v1

latestOpenAPI 3.1.02026-07-265074203.0 KB
Caregaps

Create a new caregap.

Create a new caregap.

post/caregaps/api/{quality_program}/caregap/

Path parameters

quality_programstring required

Request body

definition_idstring required

Definition id this caregap is associated with.

patient_idstring required

Patient id this caregap is associated with.

practice_idstring required

Practice id this caregap is associated with.

created_datestring date required

ISO timestamp for when this caregap was created.

status'open' | 'closed' required

An enumeration.

detailstring

Extra detail about the caregap.

closed_datestring date

ISO timestamp for when the caregap was closed.

closed_by'API' | 'condition-saved' | 'feedback'

An enumeration.

Response

Successful Response

definition_idstring required

Definition id this caregap is associated with.

patient_idstring required

Patient id this caregap is associated with.

practice_idstring required

Practice id this caregap is associated with.

created_datestring date required

ISO timestamp for when this caregap was created.

status'open' | 'closed' required

An enumeration.

detailstring

Extra detail about the caregap.

closed_datestring date

ISO timestamp for when the caregap was closed.

closed_by'API' | 'condition-saved' | 'feedback'

An enumeration.

idstring required

UUID to identify the caregap

quality_programstring required

Quality program this caregap is associated with.