Encounters Search

get

Encounters Search

Returns Encounters based on filter criteria OR Provides provision for pagination (stateid, page, page_size, _pretty & _bundletype are query parameters used for Paging).

FHIR documentation for Encounter.

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Environment URL
Live

https://fhirsandbox-prod.apigee.net/fhir/v1/Encounter

Name Values Description
Authorization

Specify access token for API in the given format: Bearer [access_token].

Accept

The Accept request-header field can be used to specify certain media types which are acceptable for the response.

Name Values Description
_format

Format of data to be returned.

_content

Search the contents of the resource's data using a fulltext search

_id

The resource identity

_language

The resource language

_lastUpdated

Only return resources which were last updated as specified by the given range. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). The prefixes >, >=, <= and < may be used on the parameter value.

_lastUpdated

Only return resources which were last updated as specified by the given range. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). Two dates can be used to specify an interval. The prefixes >, >=, <= and < may be used on the parameter value.

_profile

Search for resources which have the given profile

_security

Search for resources which have the given security labels

_tag

Search for resources which have the given tag

_text

Search the contents of the resource's narrative using a fulltext search

appointment

The appointment that scheduled this encounter

condition

Reason the encounter takes place (resource)

date

A date within the period the Encounter lasted. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). The prefixes >, >=, <= and < may be used on the parameter value.

date

A date within the period the Encounter lasted. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). Two dates can be used to specify an interval. The prefixes >, >=, <= and < may be used on the parameter value.

episodeofcare

Episode(s) of care that this encounter should be recorded against

identifier

Identifier(s) by which this encounter is known

incomingreferral

The ReferralRequest that initiated this encounter

indication

Reason the encounter takes place (resource)

length

Length of encounter in days

location

Location the encounter takes place

location-period

Time period during which the patient was present at the location. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). The prefixes >, >=, <= and < may be used on the parameter value.

location-period

Time period during which the patient was present at the location. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). Two dates can be used to specify an interval. The prefixes >, >=, <= and < may be used on the parameter value.

part-of

Another Encounter this encounter is part of

participant

Persons involved in the encounter other than the patient

participant-type

Role of participant in encounter

patient

The patient present at the encounter

practitioner

Persons involved in the encounter other than the patient

procedure

Reason the encounter takes place (resource)

reason

Reason the encounter takes place (code)

special-arrangement

Wheelchair, translator, stretcher, etc.

status

planned | arrived | in-progress | onleave | finished | cancelled

type

Specific type of encounter

Working...