latestOpenAPI 3.0.02026-08-232861531.0 MB
d3c75c2a2f1d
recalls
Show a list of recalls
get/recalls
Query parameters
patientstring
The ID of patient
providerstring
The ID of provider
facilitystring
The ID of facility
appointmentstring
The ID of appointment
appointmentTypestring
The ID of appointment type
{"stackTrail":"paths:/recalls:get:parameters:5:schema","oasType":"schema","type":"unknown"}
Date of recall
source'active' | 'pending' | 'scheduled'
Source of recall
status'active' | 'pending' | 'scheduled'
Status of recall
attemptstring
Attempt of recall
qstring
Patient name, provider name, appointment type name, facility name or status of Recall
userstring
The ID of the root account user.
deleted0 | 1
Flag for logical deletion where 1 means deleted.
createdBystring
The ID of the user who created this object.
updatedBystring
The ID of the user who updated this object.
createdAtstring date-time
The date/time when this object was created.
updatedAtstring date-time
The date/time when this object was updated.
pageinteger
limitinteger
How many items to fetch per page
_populatestring
Response properties which will be replaced by the referenced objects, separated by commas.
_selectstring
Response properties that should be returned, separated by commas.
Response
Returns a list of recalls