Date Filtering
A few of the API Search endpoints support date search parameters. You have the ability to filter a Resources query result by a specific date or a date range. For more details, see https://hl7.org/fhir/search.html#prefix
We support the following date search modifiers:
ge
Greater than or equal to the date.
Example:"?date=ge2021-01-01"`gtStrictly greater than the date.
Example:"?date=gt2021-01-01"leLess than or equal to the date.
Example:"?date=le2021-01-01"ltStrictly less than the date.
Example:"?date=lt2021-01-01"eqStrictly equal to the date.
Example:"?date=eq2021-01-01"neNot equal to the date.
Example:"?date=ne2021-01-01"
You can supply multiple date search parameters to search in a range. For example if we want to find all the records within 2024-04-11 and 2024-04-20, we can pass ?date=ge2024-04-11&date=le2024-04-20
The API endpoints that support date search parameters include:
- AllergyIntolerance (/AllergyIntolerance) - Filter by recorded date
- Appointment (/Appointment) - Filter by appointment date
- CarePlan (/CarePlan) - Filter by care plan date/period
- CareTeam (/CareTeam) - Filter by care team period
- Consent (/Consent) - Filter by consent date
- DiagnosticReport (/DiagnosticReport) - Filter by report date
- DocumentReference (/DocumentReference) - Filter by document date
- Encounter (/Encounter) - Filter by encounter date/period
- Immunization (/Immunization) - Filter by immunization date
- Observation (/Observation) - Filter by observation date/time
- Procedure (/Procedure) - Filter by procedure date