FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon . Page versions: R4 R3 R2

4.2.13.201 8.11.15 HL7 Version 2 Table 0201 Resource Encounter - Search Parameters

Vocabulary Responsible Owner: Patient Administration icon Work Group   Maturity Level Normative Security Category : N/A 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 External 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
Use Context : Any
 
http://hl7.org/fhir/SearchParameter/Encounter-appointment

Generated Narrative: SearchParameter Encounter-appointment

8.11.17 appointment

This is a table defined as part of HL7 v2 Parameter appointment : reference . Related FHIR content: v2 Telecommunication Use Code .

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

Summary Generated Narrative: SearchParameter Encounter-based-on

8.11.18 based-on

Parameter based-on : reference

The ServiceRequest that initiated this encounter

Name: Resource v2 Telecommunication Use Code Encounter
Definition: Expression Encounter.basedOn
FHIR Value set/code system definition for HL7 v2 table 0201 ( Telecommunication Use Code) Processing Mode Normal
Code System URL: Target Resources RequestOrchestration , DeviceRequest , ServiceRequest , CarePlan , MedicationRequest , 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/v2/0201 http://hl7.org/fhir/SearchParameter/Encounter-business-status

Generated Narrative: SearchParameter Encounter-business-status

8.11.19 business-status

Parameter business-status : token

The current business status of the Encounter

Value Set URL: Resource Encounter
Expression http://hl7.org/fhir/ValueSet/v2-0201 Encounter.businessStatus.code
OID: 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-careteam

Generated Narrative: SearchParameter Encounter-careteam

8.11.20 careteam

Parameter careteam : reference

Careteam allocated to participate in the encounter

CodeSystem Resource XML Encounter / JSON
Expression Encounter.careTeam
Processing Mode Normal
Target Resources CareTeam
ValueSet 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.21 class

Parameter class : token

Classification of patient encounter

Resource XML / JSON 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.22 date

Concept Maps for this value set: Parameter date : date

Encounter : A date within the actualPeriod the Encounter lasted

v2 map for ContactPointUse
from ContactPointUse 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.23 date-start

Parameter date-start : date

The actual start date of the Encounter

JSON
Resource XML 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.24 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.25 diagnosis-reference

This value set is used 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 following places: 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.26 end-date

Parameter end-date : date

The actual end date of the Encounter

Resource Encounter
Expression Encounter.actualPeriod.end
Processing Mode Normal
Multiples
  • This value set is multipleAnd: It's up to the designated 'entire code system' value set for v2 Telecommunication Use Code 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.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
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 value set search parameter is the target part of translations in the ConceptMap v2 map for ContactPointUse common search parameter clinical-identifier

Generated Narrative: SearchParameter clinical-identifier

8.11.28 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

4.2.13.201.1 8.11.29 Code System Content length

Telecommunication Use Code 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

Code Generated Narrative: SearchParameter Encounter-location

8.11.30 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

Description Generated Narrative: SearchParameter Encounter-location-period

8.11.31 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

Deutsch (German) Generated Narrative: SearchParameter Encounter-location-value-period

8.11.32 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)

Nederlands (Dutch) Comparators

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

Comment Generated Narrative: SearchParameter Encounter-part-of

8.11.33 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

Version Generated Narrative: SearchParameter Encounter-participant

8.11.34 participant

Parameter participant : reference

Persons involved in the encounter other than the patient

Resource Encounter
Expression Encounter.participant.actor
ASN Processing Mode Normal
Target Resources HealthcareService , Device , RelatedPerson , PractitionerRole , Group , Practitioner , Patient
Answering Service Number 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.35 participant-type

Parameter participant-type : token

Role of participant in encounter

Auftragsdienst Resource Antwoorddienstnummer Encounter
added v2.3 Expression Encounter.participant.type
Processing Mode Normal
BPN 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
Beeper Number This search parameter is part of the common search parameter clinical-patient

Generated Narrative: SearchParameter clinical-patient

8.11.36 patient

Parameter patient : reference

Encounter : The patient present at the encounter

Pagernummer (Cityruf o.ä.) Resource Beeper-nummer Encounter
Retained for backward compatibility as of v 2.6 Expression Encounter.subject.where(resolve() is Patient)
added v2.3.1 Processing Mode Normal
Target Resources Patient
EMR 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.37 practitioner

Parameter practitioner : reference

Persons involved in the encounter other than the patient

Emergency Number Resource Notfallnummer Encounter
Noodnummer Expression Encounter.participant.actor.where(resolve() is Practitioner)
added v2.3 Processing Mode Normal
Target Resources Practitioner
NET 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.38 reason-code

Parameter reason-code : token

Reference to a concept (coded)

Network (email) Address Resource Netzwerkadresse (E-Mail) Encounter
Netwerk (e-mail)adres Expression Encounter.reason.value.concept
Retained for backward compatibility as of v 2.6 Processing Mode Normal
added v2.3 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.39 reason-reference

Parameter reason-reference : reference

Reference to a resource (resource reference)

ORN Resource Encounter
Other Residence Number Expression Encounter.reason.value.reference
Nebenwohnsitznummer Processing Mode Normal
Ander privénummer Target Resources Procedure , Observation , DiagnosticReport , Condition
added v2.3 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.40 service-provider

Parameter service-provider : reference

The organization (facility) responsible for this encounter

PRN Resource Encounter
Primary Residence Number Expression Encounter.serviceProvider
Hauptwohnsitznummer Processing Mode Normal
Primair privénummer Target Resources Organization
added v2.3 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.41 special-arrangement

Parameter special-arrangement : token

Wheelchair, translator, stretcher, etc.

PRS Resource Encounter
Personal Expression Encounter.specialArrangement
Persoonlijk Processing Mode Normal
Not tied Multiples
  • multipleAnd: It's up to a location 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.42 status

Parameter status : token

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

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.43 subject

Parameter subject : reference

The patient or role group present at the encounter

Resource added v2.6 Encounter
Expression Encounter.subject
VHN Processing Mode Normal
Target Resources Group , Patient
Vacation Home Number 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.44 subject-status

Parameter subject-status : token

The current status of the subject in relation to the Encounter

Ferienwohnsitznummer Resource Vakantie privénummer Encounter
added v2.3 Expression Encounter.subjectStatus
Processing Mode Normal
WPN 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
Work Number This search parameter is part of the common search parameter clinical-type

Generated Narrative: SearchParameter clinical-type

8.11.45 type

Parameter type : token

Encounter : Specific type of encounter

Dienstnummer Resource Zakelijk nummer Encounter
added v2.3 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