FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Patient Administration icon Work GroupMaturity Level: N/AStandards Status: InformativeSecurity Category: Patient Compartments: Encounter, Patient, Practitioner, RelatedPerson

Search Parameter Registry for the encounter resource

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

Parameter account:reference

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

ResourceEncounter
ExpressionEncounter.account
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
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
Target ResourcesCarePlan, MedicationRequest, DeviceRequest, ServiceRequest
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
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
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Encounter-date

Parameter date:date

A date within the actualPeriod the Encounter lasted

Resources
ExpressionEncounter.actualPeriod
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-date-start

Parameter date-start:date

The actual start date of the Encounter

ResourceEncounter
ExpressionEncounter.actualPeriod.start
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

Parameter diagnosis:reference

The diagnosis or procedure relevant to the encounter

ResourceEncounter
ExpressionEncounter.diagnosis.condition
Target ResourcesCondition, Procedure
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
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
Target ResourcesEpisodeOfCare
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Encounter-identifier

Parameter identifier:token

Identifier(s) by which this encounter is known

Resources
ExpressionEncounter.identifier
UsageNormal
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
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
Target ResourcesLocation
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-location-period

Parameter location-period:date

Time period during which the patient was present at the location

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

Parameter part-of:reference

Another Encounter this encounter is part of

ResourceEncounter
ExpressionEncounter.partOf
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
Target ResourcesPractitioner, Group, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson
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
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Encounter-patient

Parameter patient:reference

The patient present at the encounter

Resources
ExpressionEncounter.subject.where(resolve() is Patient)
UsageNormal
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)
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 (by class)

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

Parameter reason-reference:reference

Reference to a resource (by instance)

ResourceEncounter
ExpressionEncounter.reason.reference
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
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.admission.specialArrangement
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
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
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
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Encounter-type

Parameter type:token

Specific type of encounter

Resources
ExpressionEncounter.type
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values