Encounter - FHIR v5.0.0-ballot

Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

8.11.16 Resource Encounter - Search Parameters

Patient Administration

Work Group

Maturity Level: N/A

Standards Status: Informative

Security Category: Patient

Compartments: Encounter, Patient, Practitioner, RelatedPerson

Search Parameter Registry for the encounter resource

8.11.17 Search Parameters

Search parameter list for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

http://hl7.org/fhir/SearchParameter/Encounter-account

8.11.18 account

Parameter account:reference

The set of accounts that may be used for billing for this Encounter

Resource Encounter

Expression Encounter.account

Target Resources Account

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-appointment

8.11.19 appointment

Parameter appointment:reference

The appointment that scheduled this encounter

Resource Encounter

Expression Encounter.appointment

Target Resources Appointment

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-based-on

8.11.20 based-on

Parameter based-on:reference

The ServiceRequest that initiated this encounter

Resource Encounter

Expression Encounter.basedOn

Target Resources CarePlan, MedicationRequest, DeviceRequest, ServiceRequest

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-careteam

8.11.21 careteam

Parameter careteam:reference

Careteam allocated to participate in the encounter

Resource Encounter

Expression Encounter.careTeam

Target Resources CareTeam

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-class

8.11.22 class

Parameter class:token

Classification of patient encounter

Resource Encounter

Expression Encounter.class

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/Encounter-date

8.11.23 date

Parameter date:date

A date within the actualPeriod the Encounter lasted

Resources

Expression Encounter.actualPeriod

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-date-start

8.11.24 date-start

Parameter date-start:date

The actual start date of the Encounter

Resource Encounter

Expression Encounter.actualPeriod.start

Multiples The parameter cannot repeat or have multiple values

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/Encounter-diagnosis

8.11.25 diagnosis

Parameter diagnosis:reference

The diagnosis or procedure relevant to the encounter

Resource Encounter

Expression Encounter.diagnosis.condition

Target Resources Condition, Procedure

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-end-date

8.11.26 end-date

Parameter end-date:date

The actual end date of the Encounter

Resource Encounter

Expression Encounter.actualPeriod.end

Multiples The parameter cannot repeat or have multiple values

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/Encounter-episode-of-care

8.11.27 episode-of-care

Parameter episode-of-care:reference

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

Resource Encounter

Expression Encounter.episodeOfCare

Target Resources EpisodeOfCare

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/Encounter-identifier

8.11.28 identifier

Parameter identifier:token

Identifier(s) by which this encounter is known

Resources

Expression Encounter.identifier

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-length

8.11.29 length

Parameter length:quantity

Length of encounter in days

Resource Encounter

Expression Encounter.length

Multiples The parameter cannot repeat or have multiple values

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/Encounter-location

8.11.30 location

Parameter location:reference

Location the encounter takes place

Resource Encounter

Expression Encounter.location.location

Target Resources Location

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-location-period

8.11.31 location-period

Parameter location-period:date

Time period during which the patient was present at the location

Resource Encounter

Expression Encounter.location.period

Multiples The parameter cannot repeat or have multiple values

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/Encounter-part-of

8.11.32 part-of

Parameter part-of:reference

Another Encounter this encounter is part of

Resource Encounter

Expression Encounter.partOf

Target Resources Encounter

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-participant

8.11.33 participant

Parameter participant:reference

Persons involved in the encounter other than the patient

Resource Encounter

Expression Encounter.participant.actor

Target Resources Practitioner, Group, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-participant-type

8.11.34 participant-type

Parameter participant-type:token

Role of participant in encounter

Resource Encounter

Expression Encounter.participant.type

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/Encounter-patient

8.11.35 patient

Parameter patient:reference

The patient present at the encounter

Resources

Expression Encounter.subject.where(resolve() is Patient)

Usage Normal

Target Resources Patient

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-practitioner

8.11.36 practitioner

Parameter practitioner:reference

Persons involved in the encounter other than the patient

Resource Encounter

Expression Encounter.participant.actor.where(resolve() is Practitioner)

Target Resources Practitioner

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-reason-code

8.11.37 reason-code

Parameter reason-code:token

Reference to a concept (by class)

Resource Encounter

Expression Encounter.reason.concept

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-reason-reference

8.11.38 reason-reference

Parameter reason-reference:reference

Reference to a resource (by instance)

Resource Encounter

Expression Encounter.reason.reference

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-service-provider

8.11.39 service-provider

Parameter service-provider:reference

The organization (facility) responsible for this encounter

Resource Encounter

Expression Encounter.serviceProvider

Target Resources Organization

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-special-arrangement

8.11.40 special-arrangement

Parameter special-arrangement:token

Wheelchair, translator, stretcher, etc.

Resource Encounter

Expression Encounter.admission.specialArrangement

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-status

8.11.41 status

Parameter status:token

Resource Encounter

Expression Encounter.status

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-subject

8.11.42 subject

Parameter subject:reference

The patient or group present at the encounter

Resource Encounter

Expression Encounter.subject

Target Resources Group, Patient

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Encounter-subject-status

8.11.43 subject-status

Parameter subject-status:token

The current status of the subject in relation to the Encounter

Resource Encounter

Expression Encounter.subjectStatus

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/Encounter-type

8.11.44 type

Parameter type:token

Specific type of encounter

Resources

Expression Encounter.type

Usage Normal

Multiples The parameter cannot repeat or have multiple values