Encounter Search by PHN with Date Filters
FHIR Interaction: ?
HTTP Method: GET
URL: [base]/Encounter?Patient=[BC PHN]&date=[date prefix][date1]&date=[date prefix][date2]
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| Patient | 1..1 | id | Patient's BC PHN |
| date | 0..2 | date | FHIR date with a date prefix |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| bundle | 1..1 | Bundle | A Bundle consists of a list of Encounter resources and/or an OperationOutcome. |
This transaction performs the FHIR search interaction using the patient's BC PHN and optional one or two date filter(s). The query response is a Bundle containing one or more Encounter resources and/or an OperationOutcome. Each Encounter resource contains patient encounter details in the eHealth clinical data repository.
Supported FHIR date prefixes
| Prefix | Single Date | Range |
|---|---|---|
| eq | the value for the parameter in the resource is equal to the provided value | the range of the search value fully contains the range of the target value |
| gt | the value for the parameter in the resource is greater than the provided value | the range above the search value intersects (i.e. overlaps) with the range of the target value |
| lt | the value for the parameter in the resource is less than the provided value | the range below the search value intersects (i.e. overlaps) with the range of the target value |
| ge | the value for the parameter in the resource is greater or equal to the provided value | the range above the search value intersects (i.e. overlaps) with the range of the target value, or the range of the search value fully contains the range of the target value |
| le | the value for the parameter in the resource is less or equal to the provided value | the range below the search value intersects (i.e. overlaps) with the range of the target value or the range of the search value fully contains the range of the target value |
Note. If one date was supplied, the service would auto fill in the end date with the max date time value which is 9999-12-3123:59:59.9999999. When there is no date prefix provided for a date filter, “eq” is used.
An example of read request and responses:
[base]/Encounter?Patient=9698656164&date=gt2021-04-01&date=lt2021-04-30