API documentation for HeyDonto API users
Sort the results by a given field, e.g. _sort=family
or _sort=-date
.
Restrict returned fields, e.g. _elements=identifier,name
.
Filter by resource date, e.g. date=ge2024-01-01
. date=ge2025-01-20&date=le2025-01-29
Filter by resource telecom, e.g. date=[SYSTEM]|[VALUE]
.
Filter by last update time, e.g. _lastUpdated=ge2024-01-01
.
Search for resources by identifier token, e.g. identifier=http://hospital.org|12345
.
Include related resources, e.g. _include=Appointment:patient
.
Reverse include related resources, e.g. _revinclude=Observation:subject
.
Reverse chaining, e.g. _has:Observation:subject:code=http://loinc.org|1234-5
.
Search by tag on the resource meta, e.g. _tag=http://example.org/tags|sample-tag
.
Search by security label on resource meta, e.g. _security=RBAC|CONFIDENTIAL
.
Search by profile in resource meta, e.g. _profile=http://example.org/fhir/StructureDefinition/custom-profile
.
Search Patients by birthdate, e.g. birthdate=ge2000-01-01
or birthdate=lt2010-01-01
.
Partial match on Patient name, e.g. name:contains=lic
.