Interface / 3.0.1 (STU3) / Encounter

Encounter

An Encounter represents interactions between a healthcare provider and patient.

Sample Query

Find encounters on a given date:

https://fhir.careevolution.com/Master.Adapter1.WebClient/api/fhir-stu3/Encounter?date=2017-03-21

Overview

See the FHIR documentation for more information about Encounter resources.

Mapped Concepts in HIEBus

  • Encounter
  • Problem

Supported Interactions

Encounter resources support the following interactions.

Search Parameters

When searching for Encounter resources, the following search parameters are supported.

Name Type Prefixes
Modifiers
Can be Chained? Description
_count Special The maximum number of resources to return in a result page.
_elements Special Used to request a specific set of elements be returned as part of a resource.
_id Token Resource id.
_lastUpdated Date lt  le  gt  ge  When the resource last changed.
_source Uri :missing  Where the resource comes from.
_summary Special Used to return only a portion of the resouces. Defaults to 'false', which returns the whole resource.
_total Special Use the value 'estimate' to populate the result bundle's 'total' element with an estimate of the matching number of resources.
admitdate Date ne  lt  le  gt  ge  sa  eb  ap  :missing  Searches for encounters by admit date.
class Token :not  :in  :notin  :missing  inpatient | outpatient | ambulatory | emergency +.
date Date ne  lt  le  gt  ge  sa  eb  ap  :missing  A date within the period the Encounter lasted.
diagnosis Reference :missing  yes Reason the encounter takes place (resource).
dischargedate Date ne  lt  le  gt  ge  sa  eb  ap  :missing  Searches for encounters by discharge date.
identifier Token :missing  Identifier(s) by which this encounter is known.
location Reference :missing  yes Location the encounter takes place.
participant-type Token :not  :in  :notin  :missing  Role of participant in encounter.
patient Reference :missing  yes The patient the Encounter is about.
practitioner Reference :missing  yes Persons involved in the encounter other than the patient.
provenance-agent Reference :missing  yes Search by provenance, specified by its author (aka originator) Organization.
reason Token :not  :in  :notin  :missing  Reason the encounter takes place (code).
status Token :missing  planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
subject Reference :missing  yes The patient the Encounter is about. Functionally identical to the "patient" search parameter.
type Token :not  :in  :notin  :missing  Specific type of encounter.

Sortable Parameters

When searching Encounter resources, it is possible to sort the returned values by the following search parameters.

  • date
  • _id

Only one sort parameter may be specified.

Supported Includes

When searching Encounter resources, it is possible to include the resources referenced by the following field names.

  • Diagnosis
  • Location
  • Patient
  • Practitioner
  • Provenance Agent
  • Subject

Back to Resources