Beyond the Console and Portal, the API lets you patch individual evaluation fields, send many evaluation changes in one request, and look up evaluations by team membership or program. This reference covers those operations. Portal members can only read and update their own evaluations by submitting them; Rhythm refuses direct create, patch, and delete requests from Portal members.
Changing One or Two Fields with a Patch
Use a patch when you need to change one or two fields on an evaluation, such as correcting a score that was imported with the wrong scale. Rhythm applies the patch to the existing evaluation and checks it against the same save rules as any other write. That includes the rule that you cannot change the people-and-visit pairing on an evaluation, so Rhythm refuses any patch that tries to change who evaluated whom or which visit the evaluation belongs to.
Sending Many Changes in One Batch
You can send up to 100 patch or delete operations for evaluations, evaluation processes, or evaluation types in a single batch request. Rhythm runs the operations together and reports the outcome of each one separately.
Listing Evaluations by Team Membership
You can list the evaluations one team membership gave, or the evaluations one team membership received, one page at a time. Use this when you already know which person’s role on which visit you need, and you want that person’s evaluations without loading the full visit list.
Searching a Program's Evaluations
You can search one program’s evaluations and narrow the results by any combination of these filters:
| Filter | What it narrows by |
|---|---|
| Evaluation identifiers | A specific list of evaluations |
| Evaluator team memberships | Evaluations given by specific people in their role on a visit |
| Evaluated team memberships | Evaluations given about specific people |
| Date range | Exactly two dates that mark the start and end of the range |
Warning
You must choose a program for this search, and the search cannot include more than one program at a time. If you need evaluations across several programs, search each program separately and combine the results yourself.
Related
- Accreditation Console and API Addresses
- Review Evaluations on a Visit or Contact
- Submit, Correct, or Delete an Evaluation as Staff
- How Evaluations Work