R5 Final QA

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

Patient Administration icon Work GroupMaturity Level: N/A  Trial UseSecurity Category: Patient Compartments: Encounter, Patient, Practitioner, RelatedPerson

Search parameters for the Resource Encounter - Search Parameters 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

Parameter account:reference

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

ResourceEncounter
ExpressionEncounter.account
Processing ModeNormal
Target ResourcesAccount
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-appointment

Parameter appointment:reference

The appointment that scheduled this encounter

ResourceEncounter
ExpressionEncounter.appointment
Processing ModeNormal
Target ResourcesAppointment
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-based-on

Parameter based-on:reference

The ServiceRequest that initiated this encounter

ResourceEncounter
ExpressionEncounter.basedOn
Processing ModeNormal
Target ResourcesDeviceRequest, ServiceRequest, CarePlan, MedicationRequest
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-careteam

Parameter careteam:reference

Careteam allocated to participate in the encounter

ResourceEncounter
ExpressionEncounter.careTeam
Processing ModeNormal
Target ResourcesCareTeam
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-class

Parameter class:token

Classification of patient encounter

ResourceEncounter
ExpressionEncounter.class
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-date
This search parameter is part of the common search parameter clinical-date

Parameter date:date

Encounter: A date within the actualPeriod the Encounter lasted

ResourceEncounter
ExpressionEncounter.actualPeriod
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Encounter-date-start

Parameter date-start:date

The actual start date of the Encounter

ResourceEncounter
ExpressionEncounter.actualPeriod.start
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Encounter-diagnosis-code

Parameter diagnosis-code:token

The diagnosis or procedure relevant to the encounter (coded)

ResourceEncounter
ExpressionEncounter.diagnosis.condition.concept
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-diagnosis-reference

Parameter diagnosis-reference:reference

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

ResourceEncounter
ExpressionEncounter.diagnosis.condition.reference
Processing ModeNormal
Target ResourcesCondition
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-end-date

Parameter end-date:date

The actual end date of the Encounter

ResourceEncounter
ExpressionEncounter.actualPeriod.end
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Encounter-episode-of-care

Parameter episode-of-care:reference

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

ResourceEncounter
ExpressionEncounter.episodeOfCare
Processing ModeNormal
Target ResourcesEpisodeOfCare
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-identifier
This search parameter is part of the common search parameter clinical-identifier

Parameter identifier:token

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

ResourceEncounter
ExpressionEncounter.identifier
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-length

Parameter length:quantity

Length of encounter in days

ResourceEncounter
ExpressionEncounter.length
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Encounter-location

Parameter location:reference

Location the encounter takes place

ResourceEncounter
ExpressionEncounter.location.location
Processing ModeNormal
Target ResourcesLocation
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-location-period

Parameter location-period:composite

Time period during which the patient was present at the location

ResourceEncounter
ExpressionEncounter.location
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

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

Parameter part-of:reference

Another Encounter this encounter is part of

ResourceEncounter
ExpressionEncounter.partOf
Processing ModeNormal
Target ResourcesEncounter
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-participant

Parameter participant:reference

Persons involved in the encounter other than the patient

ResourceEncounter
ExpressionEncounter.participant.actor
Processing ModeNormal
Target ResourcesHealthcareService, Device, RelatedPerson, PractitionerRole, Group, Practitioner, Patient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-participant-type

Parameter participant-type:token

Role of participant in encounter

ResourceEncounter
ExpressionEncounter.participant.type
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-patient
This search parameter is part of the common search parameter clinical-patient

Parameter patient:reference

Encounter: The patient present at the encounter

ResourceEncounter
ExpressionEncounter.subject.where(resolve() is Patient)
Processing ModeNormal
Target ResourcesPatient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-practitioner

Parameter practitioner:reference

Persons involved in the encounter other than the patient

ResourceEncounter
ExpressionEncounter.participant.actor.where(resolve() is Practitioner)
Processing ModeNormal
Target ResourcesPractitioner
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-reason-code

Parameter reason-code:token

Reference to a concept (coded)

ResourceEncounter
ExpressionEncounter.reason.value.concept
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-reason-reference

Parameter reason-reference:reference

Reference to a resource (resource reference)

ResourceEncounter
ExpressionEncounter.reason.value.reference
Processing ModeNormal
Target ResourcesProcedure, Observation, DiagnosticReport, ImmunizationRecommendation, Condition
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-service-provider

Parameter service-provider:reference

The organization (facility) responsible for this encounter

ResourceEncounter
ExpressionEncounter.serviceProvider
Processing ModeNormal
Target ResourcesOrganization
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-special-arrangement

Parameter special-arrangement:token

Wheelchair, translator, stretcher, etc.

ResourceEncounter
ExpressionEncounter.specialArrangement
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-status

Parameter status:token

planned | in-progress | on-hold | completed | cancelled | entered-in-error | unknown

ResourceEncounter
ExpressionEncounter.status
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-subject

Parameter subject:reference

The patient or group present at the encounter

ResourceEncounter
ExpressionEncounter.subject
Processing ModeNormal
Target ResourcesGroup, Patient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-subject-status

Parameter subject-status:token

The current status of the subject in relation to the Encounter

ResourceEncounter
ExpressionEncounter.subjectStatus
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-type
This search parameter is part of the common search parameter clinical-type

Parameter type:token

Encounter: Specific type of encounter

ResourceEncounter
ExpressionEncounter.type
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values