search

redguava / cliniko-api

The API for Cliniko
74 stars 39 forks source link

Update patients.md #335

Closed Paperpotato closed 3 years ago

Paperpotato commented 3 years ago

Add resource to Get Patient to include ability to get multiple specified patients.

hagen commented 3 years ago

@Paperpotato is this a feature request? PRs here are for changes to our documentation, to match what's in the API - i.e. where the doco isn't quite up to date with the actual API. Feature requests are probably best dropped into the Google Group 😊

Separately, you are able to request patients via a list of IDs, using the id filter. e.g. /v1/patients?q[]=id:=1,2,3,4,5. Check out Filter String Format in the filtering guide :+1:

The filter string format is [FIELDNAME]:[OPERATOR][VALUE] The integer = operator also accepts a list of integers in the format: [FIELDNAME]:=[VALUE],[VALUE],[VALUE],[VALUE]. For example, practitioner_id:=1,2,3.

Closing.

Paperpotato commented 3 years ago

Hay Hagen!

Woop - I was looking to add that in the Patients.md because I couldn't find it in the section; but clearly I didn't look hard enough in the filtering guide! Thank you for the tip :)