Encounter - FHIR v6.0.0-ballot3

This page is part of the FHIR Specification v6.0.0-ballot3: Release 6 Ballot (3rd Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

8.11.15 Resource Encounter - Search Parameters

Patient Administration icon

Work Group

Maturity Level: N/A

Trial Use

Security Category: Patient

Compartments: Encounter, Group, Patient, Practitioner, RelatedPerson

Search parameters for the Encounter resource. Also check the Extensions registry for search parameters on extensions related to 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

Generated Narrative: SearchParameter Encounter-account

8.11.16 account

Parameter account:reference

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

Resource Encounter

Expression Encounter.account

Processing Mode Normal

Target Resources Account

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: SearchParameter Encounter-appointment

8.11.17 appointment

Parameter appointment:reference

The appointment that scheduled this encounter

Resource Encounter

Expression Encounter.appointment

Processing Mode Normal

Target Resources Appointment

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: SearchParameter Encounter-based-on

8.11.18 based-on

Parameter based-on:reference

The ServiceRequest that initiated this encounter

Resource Encounter

Expression Encounter.basedOn

Processing Mode Normal

Target Resources RequestOrchestration, DeviceRequest, ServiceRequest, CarePlan, MedicationRequest, ImmunizationRecommendation, NutritionOrder, VisionPrescription

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: SearchParameter Encounter-careteam

8.11.19 careteam

Parameter careteam:reference

Careteam allocated to participate in the encounter

Resource Encounter

Expression Encounter.careTeam

Processing Mode Normal

Target Resources CareTeam

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: SearchParameter Encounter-class

8.11.20 class

Parameter class:token

Classification of patient encounter

Resource Encounter

Expression Encounter.class

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/clinical-date

This search parameter is part of the common search parameter clinical-date

Generated Narrative: SearchParameter clinical-date

8.11.21 date

Parameter date:date

Encounter: A date within the actualPeriod the Encounter lasted

Resource Encounter

Expression Encounter.actualPeriod

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

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

Generated Narrative: SearchParameter Encounter-date-start

8.11.22 date-start

Parameter date-start:date

The actual start date of the Encounter

Resource Encounter

Expression Encounter.actualPeriod.start

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

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

Generated Narrative: SearchParameter Encounter-diagnosis-code

8.11.23 diagnosis-code

Parameter diagnosis-code:token

The diagnosis or procedure relevant to the encounter (coded)

Resource Encounter

Expression Encounter.diagnosis.condition.concept

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: SearchParameter Encounter-diagnosis-reference

8.11.24 diagnosis-reference

Parameter diagnosis-reference:reference

The diagnosis or procedure relevant to the encounter (resource reference)

Resource Encounter

Expression Encounter.diagnosis.condition.reference

Processing Mode Normal

Target Resources Condition

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: SearchParameter Encounter-end-date

8.11.25 end-date

Parameter end-date:date

The actual end date of the Encounter

Resource Encounter

Expression Encounter.actualPeriod.end

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

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

Generated Narrative: SearchParameter Encounter-episode-of-care

8.11.26 episode-of-care

Parameter episode-of-care:reference

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

Resource Encounter

Expression Encounter.episodeOfCare

Processing Mode Normal

Target Resources EpisodeOfCare

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/clinical-identifier

This search parameter is part of the common search parameter clinical-identifier

Generated Narrative: SearchParameter clinical-identifier

8.11.27 identifier

Parameter identifier:token

Encounter: Identifier(s) by which this encounter is known

Resource Encounter

Expression Encounter.identifier

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: SearchParameter Encounter-length

8.11.28 length

Parameter length:quantity

Length of encounter in days

Resource Encounter

Expression Encounter.length

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

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

Generated Narrative: SearchParameter Encounter-location

8.11.29 location

Parameter location:reference

Location the encounter takes place

Resource Encounter

Expression Encounter.location.location

Processing Mode Normal

Target Resources Location

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: SearchParameter Encounter-location-period

8.11.30 location-period

Parameter location-period:date

Time period during which the patient was present at a location (generally used via composite location-period)

Resource Encounter

Expression Encounter.location.period

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

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

Generated Narrative: SearchParameter Encounter-location-value-period

8.11.31 location-value-period

Parameter location-value-period:composite

Time period during which the patient was present at the location

Resource Encounter

Expression Encounter.location

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: The parameter may only have one value (no comma separators)

Comparators

location location

location-period period

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

Generated Narrative: 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

Processing Mode Normal

Target Resources Encounter

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: 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

Processing Mode Normal

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

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: SearchParameter Encounter-participant-type

8.11.34 participant-type

Parameter participant-type:token

Role of participant in encounter

Resource Encounter

Expression Encounter.participant.type

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/clinical-patient

This search parameter is part of the common search parameter clinical-patient

Generated Narrative: SearchParameter clinical-patient

8.11.35 patient

Parameter patient:reference

Encounter: The patient present at the encounter

Resource Encounter

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

Processing Mode Normal

Target Resources Patient

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: 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)

Processing Mode Normal

Target Resources Practitioner

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: SearchParameter Encounter-reason-code

8.11.37 reason-code

Parameter reason-code:token

Reference to a concept (coded)

Resource Encounter

Expression Encounter.reason.value.concept

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: SearchParameter Encounter-reason-reference

8.11.38 reason-reference

Parameter reason-reference:reference

Reference to a resource (resource reference)

Resource Encounter

Expression Encounter.reason.value.reference

Processing Mode Normal

Target Resources Procedure, Observation, DiagnosticReport, ImmunizationRecommendation, Condition

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: 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

Processing Mode Normal

Target Resources Organization

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: SearchParameter Encounter-special-arrangement

8.11.40 special-arrangement

Parameter special-arrangement:token

Wheelchair, translator, stretcher, etc.

Resource Encounter

Expression Encounter.specialArrangement

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: SearchParameter Encounter-status

8.11.41 status

Parameter status:token

Resource Encounter

Expression Encounter.status

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: SearchParameter Encounter-subject

8.11.42 subject

Parameter subject:reference

The patient or group present at the encounter

Resource Encounter

Expression Encounter.subject

Processing Mode Normal

Target Resources Group, Patient

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: 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

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/clinical-type

This search parameter is part of the common search parameter clinical-type

Generated Narrative: SearchParameter clinical-type

8.11.44 type

Parameter type:token

Encounter: Specific type of encounter

Resource Encounter

Expression Encounter.type

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true