java.lang.Object
- org.hl7.fhir.r5.model.Base
- - org.hl7.fhir.r5.model.BaseResource
  - - org.hl7.fhir.r5.model.Resource
    - - org.hl7.fhir.r5.model.DomainResource
      - org.hl7.fhir.r5.model.Encounter

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
```
public class Encounter
extends DomainResource
```
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Encounter.ClassHistoryComponent`
`static class`	`Encounter.DiagnosisComponent`
`static class`	`Encounter.EncounterHospitalizationComponent`
`static class`	`Encounter.EncounterLocationComponent`
`static class`	`Encounter.EncounterLocationStatus`
`static class`	`Encounter.EncounterLocationStatusEnumFactory`
`static class`	`Encounter.EncounterParticipantComponent`
`static class`	`Encounter.EncounterStatus`
`static class`	`Encounter.EncounterStatusEnumFactory`
`static class`	`Encounter.StatusHistoryComponent`

Field Summary

Fields
Modifier and Type	Field	Description
`protected List<Reference>`	`account`	The set of accounts that may be used for billing for this Encounter.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ACCOUNT`	Fluent Client search parameter constant for account
`protected Period`	`actualPeriod`	The actual start and end time of the encounter.
`protected List<Reference>`	`appointment`	The appointment that scheduled this encounter.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`APPOINTMENT`	Fluent Client search parameter constant for appointment
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`BASED_ON`	Fluent Client search parameter constant for based-on
`protected List<Reference>`	`basedOn`	The request this encounter satisfies (e.g.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`CLASS`	Fluent Client search parameter constant for class
`protected Coding`	`class_`	Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
`protected List<Encounter.ClassHistoryComponent>`	`classHistory`	The class history permits the tracking of the encounters transitions without needing to go through the resource history.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`DATE`	Fluent Client search parameter constant for date
`protected List<Encounter.DiagnosisComponent>`	`diagnosis`	The list of diagnosis relevant to this encounter.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`DIAGNOSIS`	Fluent Client search parameter constant for diagnosis
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`EPISODE_OF_CARE`	Fluent Client search parameter constant for episode-of-care
`protected List<Reference>`	`episodeOfCare`	Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used.
`protected Encounter.EncounterHospitalizationComponent`	`hospitalization`	Details about the admission to a healthcare service.
`protected List<Identifier>`	`identifier`	Identifier(s) by which this encounter is known.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER`	Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ACCOUNT`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_APPOINTMENT`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_BASED_ON`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_DIAGNOSIS`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_EPISODE_OF_CARE`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_LOCATION`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PART_OF`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PARTICIPANT`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PRACTITIONER`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_REASON_REFERENCE`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SERVICE_PROVIDER`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SUBJECT`	Constant for fluent queries to be used to add include statements.
`protected Duration`	`length`	Quantity of time the encounter lasted.
`static ca.uhn.fhir.rest.gclient.QuantityClientParam`	`LENGTH`	Fluent Client search parameter constant for length
`protected List<Encounter.EncounterLocationComponent>`	`location`	List of locations where the patient has been during this encounter.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`LOCATION`	Fluent Client search parameter constant for location
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`LOCATION_PERIOD`	Fluent Client search parameter constant for location-period
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PART_OF`	Fluent Client search parameter constant for part-of
`protected List<Encounter.EncounterParticipantComponent>`	`participant`	The list of people responsible for providing the service.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PARTICIPANT`	Fluent Client search parameter constant for participant
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`PARTICIPANT_TYPE`	Fluent Client search parameter constant for participant-type
`protected Reference`	`partOf`	Another Encounter of which this encounter is a part of (administratively or in time).
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT`	Fluent Client search parameter constant for patient
`protected DateTimeType`	`plannedEndDate`	The planned end date/time (or discharge date) of the encounter.
`protected DateTimeType`	`plannedStartDate`	The planned start date/time (or admission date) of the encounter.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PRACTITIONER`	Fluent Client search parameter constant for practitioner
`protected CodeableConcept`	`priority`	Indicates the urgency of the encounter.
`protected List<CodeableReference>`	`reason`	Reason the encounter takes place, expressed as a code or a reference to another resource.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`REASON_CODE`	Fluent Client search parameter constant for reason-code
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`REASON_REFERENCE`	Fluent Client search parameter constant for reason-reference
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SERVICE_PROVIDER`	Fluent Client search parameter constant for service-provider
`protected Reference`	`serviceProvider`	The organization that is primarily responsible for this Encounter's services.
`protected CodeableConcept`	`serviceType`	Broad categorization of the service that is to be provided (e.g.
`static String`	`SP_ACCOUNT`	Search parameter: account
`static String`	`SP_APPOINTMENT`	Search parameter: appointment
`static String`	`SP_BASED_ON`	Search parameter: based-on
`static String`	`SP_CLASS`	Search parameter: class
`static String`	`SP_DATE`	Search parameter: date
`static String`	`SP_DIAGNOSIS`	Search parameter: diagnosis
`static String`	`SP_EPISODE_OF_CARE`	Search parameter: episode-of-care
`static String`	`SP_IDENTIFIER`	Search parameter: identifier
`static String`	`SP_LENGTH`	Search parameter: length
`static String`	`SP_LOCATION`	Search parameter: location
`static String`	`SP_LOCATION_PERIOD`	Search parameter: location-period
`static String`	`SP_PART_OF`	Search parameter: part-of
`static String`	`SP_PARTICIPANT`	Search parameter: participant
`static String`	`SP_PARTICIPANT_TYPE`	Search parameter: participant-type
`static String`	`SP_PATIENT`	Search parameter: patient
`static String`	`SP_PRACTITIONER`	Search parameter: practitioner
`static String`	`SP_REASON_CODE`	Search parameter: reason-code
`static String`	`SP_REASON_REFERENCE`	Search parameter: reason-reference
`static String`	`SP_SERVICE_PROVIDER`	Search parameter: service-provider
`static String`	`SP_SPECIAL_ARRANGEMENT`	Search parameter: special-arrangement
`static String`	`SP_STATUS`	Search parameter: status
`static String`	`SP_SUBJECT`	Search parameter: subject
`static String`	`SP_SUBJECT_STATUS`	Search parameter: subject-status
`static String`	`SP_TYPE`	Search parameter: type
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`SPECIAL_ARRANGEMENT`	Fluent Client search parameter constant for special-arrangement
`protected Enumeration<Encounter.EncounterStatus>`	`status`	planned \| in-progress \| onhold \| completed \| cancelled \| entered-in-error \| unknown.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS`	Fluent Client search parameter constant for status
`protected List<Encounter.StatusHistoryComponent>`	`statusHistory`	The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
`protected Reference`	`subject`	The patient or group present at the encounter.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUBJECT`	Fluent Client search parameter constant for subject
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`SUBJECT_STATUS`	Fluent Client search parameter constant for subject-status
`protected CodeableConcept`	`subjectStatus`	The subjectStatus value can be used to track the patient's status within the encounter.
`protected List<CodeableConcept>`	`type`	Specific type of encounter (e.g.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`TYPE`	Fluent Client search parameter constant for type

Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT

Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor Description

Encounter()
Constructor

Encounter(Encounter.EncounterStatus status, Coding class_)
Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Reference`	`addAccount()`
`Encounter`	`addAccount(Reference t)`
`Reference`	`addAppointment()`
`Encounter`	`addAppointment(Reference t)`
`Reference`	`addBasedOn()`
`Encounter`	`addBasedOn(Reference t)`
`Base`	`addChild(String name)`
`Encounter.ClassHistoryComponent`	`addClassHistory()`
`Encounter`	`addClassHistory(Encounter.ClassHistoryComponent t)`
`Encounter.DiagnosisComponent`	`addDiagnosis()`
`Encounter`	`addDiagnosis(Encounter.DiagnosisComponent t)`
`Reference`	`addEpisodeOfCare()`
`Encounter`	`addEpisodeOfCare(Reference t)`
`Identifier`	`addIdentifier()`
`Encounter`	`addIdentifier(Identifier t)`
`Encounter.EncounterLocationComponent`	`addLocation()`
`Encounter`	`addLocation(Encounter.EncounterLocationComponent t)`
`Encounter.EncounterParticipantComponent`	`addParticipant()`
`Encounter`	`addParticipant(Encounter.EncounterParticipantComponent t)`
`CodeableReference`	`addReason()`
`Encounter`	`addReason(CodeableReference t)`
`Encounter.StatusHistoryComponent`	`addStatusHistory()`
`Encounter`	`addStatusHistory(Encounter.StatusHistoryComponent t)`
`CodeableConcept`	`addType()`
`Encounter`	`addType(CodeableConcept t)`
`Encounter`	`copy()`
`void`	`copyValues(Encounter dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`List<Reference>`	`getAccount()`
`Reference`	`getAccountFirstRep()`
`Period`	`getActualPeriod()`
`List<Reference>`	`getAppointment()`
`Reference`	`getAppointmentFirstRep()`
`List<Reference>`	`getBasedOn()`
`Reference`	`getBasedOnFirstRep()`
`Coding`	`getClass_()`
`List<Encounter.ClassHistoryComponent>`	`getClassHistory()`
`Encounter.ClassHistoryComponent`	`getClassHistoryFirstRep()`
`List<Encounter.DiagnosisComponent>`	`getDiagnosis()`
`Encounter.DiagnosisComponent`	`getDiagnosisFirstRep()`
`List<Reference>`	`getEpisodeOfCare()`
`Reference`	`getEpisodeOfCareFirstRep()`
`Encounter.EncounterHospitalizationComponent`	`getHospitalization()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`Duration`	`getLength()`
`List<Encounter.EncounterLocationComponent>`	`getLocation()`
`Encounter.EncounterLocationComponent`	`getLocationFirstRep()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`List<Encounter.EncounterParticipantComponent>`	`getParticipant()`
`Encounter.EncounterParticipantComponent`	`getParticipantFirstRep()`
`Reference`	`getPartOf()`
`Date`	`getPlannedEndDate()`
`DateTimeType`	`getPlannedEndDateElement()`
`Date`	`getPlannedStartDate()`
`DateTimeType`	`getPlannedStartDateElement()`
`CodeableConcept`	`getPriority()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<CodeableReference>`	`getReason()`
`CodeableReference`	`getReasonFirstRep()`
`ResourceType`	`getResourceType()`
`Reference`	`getServiceProvider()`
`CodeableConcept`	`getServiceType()`
`Encounter.EncounterStatus`	`getStatus()`
`Enumeration<Encounter.EncounterStatus>`	`getStatusElement()`
`List<Encounter.StatusHistoryComponent>`	`getStatusHistory()`
`Encounter.StatusHistoryComponent`	`getStatusHistoryFirstRep()`
`Reference`	`getSubject()`
`CodeableConcept`	`getSubjectStatus()`
`List<CodeableConcept>`	`getType()`
`CodeableConcept`	`getTypeFirstRep()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasAccount()`
`boolean`	`hasActualPeriod()`
`boolean`	`hasAppointment()`
`boolean`	`hasBasedOn()`
`boolean`	`hasClass_()`
`boolean`	`hasClassHistory()`
`boolean`	`hasDiagnosis()`
`boolean`	`hasEpisodeOfCare()`
`boolean`	`hasHospitalization()`
`boolean`	`hasIdentifier()`
`boolean`	`hasLength()`
`boolean`	`hasLocation()`
`boolean`	`hasParticipant()`
`boolean`	`hasPartOf()`
`boolean`	`hasPlannedEndDate()`
`boolean`	`hasPlannedEndDateElement()`
`boolean`	`hasPlannedStartDate()`
`boolean`	`hasPlannedStartDateElement()`
`boolean`	`hasPriority()`
`boolean`	`hasReason()`
`boolean`	`hasServiceProvider()`
`boolean`	`hasServiceType()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasStatusHistory()`
`boolean`	`hasSubject()`
`boolean`	`hasSubjectStatus()`
`boolean`	`hasType()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`Encounter`	`setAccount(List<Reference> theAccount)`
`Encounter`	`setActualPeriod(Period value)`
`Encounter`	`setAppointment(List<Reference> theAppointment)`
`Encounter`	`setBasedOn(List<Reference> theBasedOn)`
`Encounter`	`setClass_(Coding value)`
`Encounter`	`setClassHistory(List<Encounter.ClassHistoryComponent> theClassHistory)`
`Encounter`	`setDiagnosis(List<Encounter.DiagnosisComponent> theDiagnosis)`
`Encounter`	`setEpisodeOfCare(List<Reference> theEpisodeOfCare)`
`Encounter`	`setHospitalization(Encounter.EncounterHospitalizationComponent value)`
`Encounter`	`setIdentifier(List<Identifier> theIdentifier)`
`Encounter`	`setLength(Duration value)`
`Encounter`	`setLocation(List<Encounter.EncounterLocationComponent> theLocation)`
`Encounter`	`setParticipant(List<Encounter.EncounterParticipantComponent> theParticipant)`
`Encounter`	`setPartOf(Reference value)`
`Encounter`	`setPlannedEndDate(Date value)`
`Encounter`	`setPlannedEndDateElement(DateTimeType value)`
`Encounter`	`setPlannedStartDate(Date value)`
`Encounter`	`setPlannedStartDateElement(DateTimeType value)`
`Encounter`	`setPriority(CodeableConcept value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Encounter`	`setReason(List<CodeableReference> theReason)`
`Encounter`	`setServiceProvider(Reference value)`
`Encounter`	`setServiceType(CodeableConcept value)`
`Encounter`	`setStatus(Encounter.EncounterStatus value)`
`Encounter`	`setStatusElement(Enumeration<Encounter.EncounterStatus> value)`
`Encounter`	`setStatusHistory(List<Encounter.StatusHistoryComponent> theStatusHistory)`
`Encounter`	`setSubject(Reference value)`
`Encounter`	`setSubjectStatus(CodeableConcept value)`
`Encounter`	`setType(List<CodeableConcept> theType)`
`protected Encounter`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    Identifier(s) by which this encounter is known.
  - status
```
protected Enumeration<Encounter.EncounterStatus> status
```
    planned | in-progress | onhold | completed | cancelled | entered-in-error | unknown.
  - statusHistory
```
protected List<Encounter.StatusHistoryComponent> statusHistory
```
    The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
  - class_
```
protected Coding class_
```
    Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
  - classHistory
```
protected List<Encounter.ClassHistoryComponent> classHistory
```
    The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.
  - type
```
protected List<CodeableConcept> type
```
    Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
  - serviceType
```
protected CodeableConcept serviceType
```
    Broad categorization of the service that is to be provided (e.g. cardiology).
  - priority
```
protected CodeableConcept priority
```
    Indicates the urgency of the encounter.
  - subject
```
protected Reference subject
```
    The patient or group present at the encounter.
  - subjectStatus
```
protected CodeableConcept subjectStatus
```
    The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.
  - episodeOfCare
```
protected List<Reference> episodeOfCare
```
    Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
  - basedOn
```
protected List<Reference> basedOn
```
    The request this encounter satisfies (e.g. incoming referral or procedure request).
  - participant
```
protected List<Encounter.EncounterParticipantComponent> participant
```
    The list of people responsible for providing the service.
  - appointment
```
protected List<Reference> appointment
```
    The appointment that scheduled this encounter.
  - actualPeriod
```
protected Period actualPeriod
```
    The actual start and end time of the encounter.
  - plannedStartDate
```
protected DateTimeType plannedStartDate
```
    The planned start date/time (or admission date) of the encounter.
  - plannedEndDate
```
protected DateTimeType plannedEndDate
```
    The planned end date/time (or discharge date) of the encounter.
  - length
```
protected Duration length
```
    Quantity of time the encounter lasted. This excludes the time during leaves of absence.
  - reason
```
protected List<CodeableReference> reason
```
    Reason the encounter takes place, expressed as a code or a reference to another resource. For admissions, this can be used for a coded admission diagnosis.
  - diagnosis
```
protected List<Encounter.DiagnosisComponent> diagnosis
```
    The list of diagnosis relevant to this encounter.
  - account
```
protected List<Reference> account
```
    The set of accounts that may be used for billing for this Encounter.
  - hospitalization
```
protected Encounter.EncounterHospitalizationComponent hospitalization
```
    Details about the admission to a healthcare service.
  - location
```
protected List<Encounter.EncounterLocationComponent> location
```
    List of locations where the patient has been during this encounter.
  - serviceProvider
```
protected Reference serviceProvider
```
    The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.
  - partOf
```
protected Reference partOf
```
    Another Encounter of which this encounter is a part of (administratively or in time).
  - SP_ACCOUNT
```
public static final String SP_ACCOUNT
```
    Search parameter: account
    Description: The set of accounts that may be used for billing for this Encounter
    Type: reference
    Path: Encounter.account
    
    See Also:
    
    Constant Field Values
  - ACCOUNT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ACCOUNT
```
    Fluent Client search parameter constant for account
    Description: The set of accounts that may be used for billing for this Encounter
    Type: reference
    Path: Encounter.account
  - INCLUDE_ACCOUNT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_ACCOUNT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:account".
  - SP_APPOINTMENT
```
public static final String SP_APPOINTMENT
```
    Search parameter: appointment
    Description: The appointment that scheduled this encounter
    Type: reference
    Path: Encounter.appointment
    
    See Also:
    
    Constant Field Values
  - APPOINTMENT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam APPOINTMENT
```
    Fluent Client search parameter constant for appointment
    Description: The appointment that scheduled this encounter
    Type: reference
    Path: Encounter.appointment
  - INCLUDE_APPOINTMENT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_APPOINTMENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:appointment".
  - SP_BASED_ON
```
public static final String SP_BASED_ON
```
    Search parameter: based-on
    Description: The ServiceRequest that initiated this encounter
    Type: reference
    Path: Encounter.basedOn
    
    See Also:
    
    Constant Field Values
  - BASED_ON
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON
```
    Fluent Client search parameter constant for based-on
    Description: The ServiceRequest that initiated this encounter
    Type: reference
    Path: Encounter.basedOn
  - INCLUDE_BASED_ON
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:based-on".
  - SP_CLASS
```
public static final String SP_CLASS
```
    Search parameter: class
    Description: Classification of patient encounter
    Type: token
    Path: Encounter.class
    
    See Also:
    
    Constant Field Values
  - CLASS
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CLASS
```
    Fluent Client search parameter constant for class
    Description: Classification of patient encounter
    Type: token
    Path: Encounter.class
  - SP_DIAGNOSIS
```
public static final String SP_DIAGNOSIS
```
    Search parameter: diagnosis
    Description: The diagnosis or procedure relevant to the encounter
    Type: reference
    Path: Encounter.diagnosis.condition
    
    See Also:
    
    Constant Field Values
  - DIAGNOSIS
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DIAGNOSIS
```
    Fluent Client search parameter constant for diagnosis
    Description: The diagnosis or procedure relevant to the encounter
    Type: reference
    Path: Encounter.diagnosis.condition
  - INCLUDE_DIAGNOSIS
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_DIAGNOSIS
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:diagnosis".
  - SP_EPISODE_OF_CARE
```
public static final String SP_EPISODE_OF_CARE
```
    Search parameter: episode-of-care
    Description: Episode(s) of care that this encounter should be recorded against
    Type: reference
    Path: Encounter.episodeOfCare
    
    See Also:
    
    Constant Field Values
  - EPISODE_OF_CARE
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam EPISODE_OF_CARE
```
    Fluent Client search parameter constant for episode-of-care
    Description: Episode(s) of care that this encounter should be recorded against
    Type: reference
    Path: Encounter.episodeOfCare
  - INCLUDE_EPISODE_OF_CARE
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_EPISODE_OF_CARE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:episode-of-care".
  - SP_LENGTH
```
public static final String SP_LENGTH
```
    Search parameter: length
    Description: Length of encounter in days
    Type: quantity
    Path: Encounter.length
    
    See Also:
    
    Constant Field Values
  - LENGTH
```
public static final ca.uhn.fhir.rest.gclient.QuantityClientParam LENGTH
```
    Fluent Client search parameter constant for length
    Description: Length of encounter in days
    Type: quantity
    Path: Encounter.length
  - SP_LOCATION_PERIOD
```
public static final String SP_LOCATION_PERIOD
```
    Search parameter: location-period
    Description: Time period during which the patient was present at the location
    Type: date
    Path: Encounter.location.period
    
    See Also:
    
    Constant Field Values
  - LOCATION_PERIOD
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam LOCATION_PERIOD
```
    Fluent Client search parameter constant for location-period
    Description: Time period during which the patient was present at the location
    Type: date
    Path: Encounter.location.period
  - SP_LOCATION
```
public static final String SP_LOCATION
```
    Search parameter: location
    Description: Location the encounter takes place
    Type: reference
    Path: Encounter.location.location
    
    See Also:
    
    Constant Field Values
  - LOCATION
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam LOCATION
```
    Fluent Client search parameter constant for location
    Description: Location the encounter takes place
    Type: reference
    Path: Encounter.location.location
  - INCLUDE_LOCATION
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:location".
  - SP_PART_OF
```
public static final String SP_PART_OF
```
    Search parameter: part-of
    Description: Another Encounter this encounter is part of
    Type: reference
    Path: Encounter.partOf
    
    See Also:
    
    Constant Field Values
  - PART_OF
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PART_OF
```
    Fluent Client search parameter constant for part-of
    Description: Another Encounter this encounter is part of
    Type: reference
    Path: Encounter.partOf
  - INCLUDE_PART_OF
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PART_OF
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:part-of".
  - SP_PARTICIPANT_TYPE
```
public static final String SP_PARTICIPANT_TYPE
```
    Search parameter: participant-type
    Description: Role of participant in encounter
    Type: token
    Path: Encounter.participant.type
    
    See Also:
    
    Constant Field Values
  - PARTICIPANT_TYPE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam PARTICIPANT_TYPE
```
    Fluent Client search parameter constant for participant-type
    Description: Role of participant in encounter
    Type: token
    Path: Encounter.participant.type
  - SP_PARTICIPANT
```
public static final String SP_PARTICIPANT
```
    Search parameter: participant
    Description: Persons involved in the encounter other than the patient
    Type: reference
    Path: Encounter.participant.actor
    
    See Also:
    
    Constant Field Values
  - PARTICIPANT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARTICIPANT
```
    Fluent Client search parameter constant for participant
    Description: Persons involved in the encounter other than the patient
    Type: reference
    Path: Encounter.participant.actor
  - INCLUDE_PARTICIPANT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PARTICIPANT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:participant".
  - SP_PRACTITIONER
```
public static final String SP_PRACTITIONER
```
    Search parameter: practitioner
    Description: Persons involved in the encounter other than the patient
    Type: reference
    Path: Encounter.participant.actor.where(resolve() is Practitioner)
    
    See Also:
    
    Constant Field Values
  - PRACTITIONER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRACTITIONER
```
    Fluent Client search parameter constant for practitioner
    Description: Persons involved in the encounter other than the patient
    Type: reference
    Path: Encounter.participant.actor.where(resolve() is Practitioner)
  - INCLUDE_PRACTITIONER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PRACTITIONER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:practitioner".
  - SP_REASON_CODE
```
public static final String SP_REASON_CODE
```
    Search parameter: reason-code
    Description: Reference to a concept (by class)
    Type: token
    Path: Encounter.reason.concept
    
    See Also:
    
    Constant Field Values
  - REASON_CODE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam REASON_CODE
```
    Fluent Client search parameter constant for reason-code
    Description: Reference to a concept (by class)
    Type: token
    Path: Encounter.reason.concept
  - SP_REASON_REFERENCE
```
public static final String SP_REASON_REFERENCE
```
    Search parameter: reason-reference
    Description: Reference to a resource (by instance)
    Type: reference
    Path: Encounter.reason.reference
    
    See Also:
    
    Constant Field Values
  - REASON_REFERENCE
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REASON_REFERENCE
```
    Fluent Client search parameter constant for reason-reference
    Description: Reference to a resource (by instance)
    Type: reference
    Path: Encounter.reason.reference
  - INCLUDE_REASON_REFERENCE
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_REASON_REFERENCE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:reason-reference".
  - SP_SERVICE_PROVIDER
```
public static final String SP_SERVICE_PROVIDER
```
    Search parameter: service-provider
    Description: The organization (facility) responsible for this encounter
    Type: reference
    Path: Encounter.serviceProvider
    
    See Also:
    
    Constant Field Values
  - SERVICE_PROVIDER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SERVICE_PROVIDER
```
    Fluent Client search parameter constant for service-provider
    Description: The organization (facility) responsible for this encounter
    Type: reference
    Path: Encounter.serviceProvider
  - INCLUDE_SERVICE_PROVIDER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_SERVICE_PROVIDER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:service-provider".
  - SP_SPECIAL_ARRANGEMENT
```
public static final String SP_SPECIAL_ARRANGEMENT
```
    Search parameter: special-arrangement
    Description: Wheelchair, translator, stretcher, etc.
    Type: token
    Path: Encounter.hospitalization.specialArrangement
    
    See Also:
    
    Constant Field Values
  - SPECIAL_ARRANGEMENT
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SPECIAL_ARRANGEMENT
```
    Fluent Client search parameter constant for special-arrangement
    Description: Wheelchair, translator, stretcher, etc.
    Type: token
    Path: Encounter.hospitalization.specialArrangement
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter: status
    Description: planned | in-progress | onhold | completed | cancelled | entered-in-error | unknown
    Type: token
    Path: Encounter.status
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description: planned | in-progress | onhold | completed | cancelled | entered-in-error | unknown
    Type: token
    Path: Encounter.status
  - SP_SUBJECT_STATUS
```
public static final String SP_SUBJECT_STATUS
```
    Search parameter: subject-status
    Description: The current status of the subject in relation to the Encounter
    Type: token
    Path: Encounter.subjectStatus
    
    See Also:
    
    Constant Field Values
  - SUBJECT_STATUS
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SUBJECT_STATUS
```
    Fluent Client search parameter constant for subject-status
    Description: The current status of the subject in relation to the Encounter
    Type: token
    Path: Encounter.subjectStatus
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter: subject
    Description: The patient or group present at the encounter
    Type: reference
    Path: Encounter.subject
    
    See Also:
    
    Constant Field Values
  - SUBJECT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description: The patient or group present at the encounter
    Type: reference
    Path: Encounter.subject
  - INCLUDE_SUBJECT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:subject".
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter: date
    Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [List](list.html): When the list was prepared [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period [Procedure](procedure.html): When the procedure occurred or is occurring [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
    Type: date
    Path: AllergyIntolerance.recordedDate | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.dateTime | DiagnosticReport.effective | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence as dateTime) | List.date | Observation.effective | Procedure.occurrence | (RiskAssessment.occurrence as dateTime) | SupplyRequest.authoredOn
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [List](list.html): When the list was prepared [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period [Procedure](procedure.html): When the procedure occurred or is occurring [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
    Type: date
    Path: AllergyIntolerance.recordedDate | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.dateTime | DiagnosticReport.effective | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence as dateTime) | List.date | Observation.effective | Procedure.occurrence | (RiskAssessment.occurrence as dateTime) | SupplyRequest.authoredOn
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
    Type: token
    Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.content.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
    Type: token
    Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.content.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: patient
    Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
    Type: reference
    Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.patient | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | VisionPrescription.patient
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
    Type: reference
    Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.patient | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | VisionPrescription.patient
  - INCLUDE_PATIENT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:patient".
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter: type
    Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known) [Composition](composition.html): Kind of composition (LOINC if possible) [DocumentManifest](documentmanifest.html): Kind of document set [DocumentReference](documentreference.html): Kind of document (LOINC if possible) [Encounter](encounter.html): Specific type of encounter [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management
    Type: token
    Path: AllergyIntolerance.type | Composition.type | DocumentManifest.type | DocumentReference.type | Encounter.type | EpisodeOfCare.type
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
```
    Fluent Client search parameter constant for type
    Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known) [Composition](composition.html): Kind of composition (LOINC if possible) [DocumentManifest](documentmanifest.html): Kind of document set [DocumentReference](documentreference.html): Kind of document (LOINC if possible) [Encounter](encounter.html): Specific type of encounter [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management
    Type: token
    Path: AllergyIntolerance.type | Composition.type | DocumentManifest.type | DocumentReference.type | Encounter.type | EpisodeOfCare.type
- Constructor Detail
  - Encounter
```
public Encounter()
```
    Constructor
  - Encounter
```
public Encounter(Encounter.EncounterStatus status,
                 Coding class_)
```
    Constructor
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (Identifier(s) by which this encounter is known.)
  - setIdentifier
```
public Encounter setIdentifier(List<Identifier> theIdentifier)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
  - addIdentifier
```
public Encounter addIdentifier(Identifier t)
```
  - getIdentifierFirstRep
```
public Identifier getIdentifierFirstRep()
```
    Returns:
    
    The first repetition of repeating field identifier, creating it if it does not already exist {3}
  - getStatusElement
```
public Enumeration<Encounter.EncounterStatus> getStatusElement()
```
    Returns:
    
    status (planned | in-progress | onhold | completed | cancelled | entered-in-error | unknown.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - setStatusElement
```
public Encounter setStatusElement(Enumeration<Encounter.EncounterStatus> value)
```
    Parameters:
    
    value - status (planned | in-progress | onhold | completed | cancelled | entered-in-error | unknown.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public Encounter.EncounterStatus getStatus()
```
    Returns:
    
    planned | in-progress | onhold | completed | cancelled | entered-in-error | unknown.
  - setStatus
```
public Encounter setStatus(Encounter.EncounterStatus value)
```
    Parameters:
    
    value - planned | in-progress | onhold | completed | cancelled | entered-in-error | unknown.
  - getStatusHistory
```
public List<Encounter.StatusHistoryComponent> getStatusHistory()
```
    Returns:
    
    statusHistory (The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.)
  - setStatusHistory
```
public Encounter setStatusHistory(List<Encounter.StatusHistoryComponent> theStatusHistory)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasStatusHistory
```
public boolean hasStatusHistory()
```
  - addStatusHistory
```
public Encounter.StatusHistoryComponent addStatusHistory()
```
  - addStatusHistory
```
public Encounter addStatusHistory(Encounter.StatusHistoryComponent t)
```
  - getStatusHistoryFirstRep
```
public Encounter.StatusHistoryComponent getStatusHistoryFirstRep()
```
    Returns:
    
    The first repetition of repeating field statusHistory, creating it if it does not already exist {3}
  - getClass_
```
public Coding getClass_()
```
    Returns:
    
    class_ (Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.)
  - hasClass_
```
public boolean hasClass_()
```
  - setClass_
```
public Encounter setClass_(Coding value)
```
    Parameters:
    
    value - class_ (Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.)
  - getClassHistory
```
public List<Encounter.ClassHistoryComponent> getClassHistory()
```
    Returns:
    
    classHistory (The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.)
  - setClassHistory
```
public Encounter setClassHistory(List<Encounter.ClassHistoryComponent> theClassHistory)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasClassHistory
```
public boolean hasClassHistory()
```
  - addClassHistory
```
public Encounter.ClassHistoryComponent addClassHistory()
```
  - addClassHistory
```
public Encounter addClassHistory(Encounter.ClassHistoryComponent t)
```
  - getClassHistoryFirstRep
```
public Encounter.ClassHistoryComponent getClassHistoryFirstRep()
```
    Returns:
    
    The first repetition of repeating field classHistory, creating it if it does not already exist {3}
  - getType
```
public List<CodeableConcept> getType()
```
    Returns:
    
    type (Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).)
  - setType
```
public Encounter setType(List<CodeableConcept> theType)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasType
```
public boolean hasType()
```
  - addType
```
public CodeableConcept addType()
```
  - addType
```
public Encounter addType(CodeableConcept t)
```
  - getTypeFirstRep
```
public CodeableConcept getTypeFirstRep()
```
    Returns:
    
    The first repetition of repeating field type, creating it if it does not already exist {3}
  - getServiceType
```
public CodeableConcept getServiceType()
```
    Returns:
    
    serviceType (Broad categorization of the service that is to be provided (e.g. cardiology).)
  - hasServiceType
```
public boolean hasServiceType()
```
  - setServiceType
```
public Encounter setServiceType(CodeableConcept value)
```
    Parameters:
    
    value - serviceType (Broad categorization of the service that is to be provided (e.g. cardiology).)
  - getPriority
```
public CodeableConcept getPriority()
```
    Returns:
    
    priority (Indicates the urgency of the encounter.)
  - hasPriority
```
public boolean hasPriority()
```
  - setPriority
```
public Encounter setPriority(CodeableConcept value)
```
    Parameters:
    
    value - priority (Indicates the urgency of the encounter.)
  - getSubject
```
public Reference getSubject()
```
    Returns:
    
    subject (The patient or group present at the encounter.)
  - hasSubject
```
public boolean hasSubject()
```
  - setSubject
```
public Encounter setSubject(Reference value)
```
    Parameters:
    
    value - subject (The patient or group present at the encounter.)
  - getSubjectStatus
```
public CodeableConcept getSubjectStatus()
```
    Returns:
    
    subjectStatus (The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.)
  - hasSubjectStatus
```
public boolean hasSubjectStatus()
```
  - setSubjectStatus
```
public Encounter setSubjectStatus(CodeableConcept value)
```
    Parameters:
    
    value - subjectStatus (The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.)
  - getEpisodeOfCare
```
public List<Reference> getEpisodeOfCare()
```
    Returns:
    
    episodeOfCare (Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).)
  - setEpisodeOfCare
```
public Encounter setEpisodeOfCare(List<Reference> theEpisodeOfCare)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasEpisodeOfCare
```
public boolean hasEpisodeOfCare()
```
  - addEpisodeOfCare
```
public Reference addEpisodeOfCare()
```
  - addEpisodeOfCare
```
public Encounter addEpisodeOfCare(Reference t)
```
  - getEpisodeOfCareFirstRep
```
public Reference getEpisodeOfCareFirstRep()
```
    Returns:
    
    The first repetition of repeating field episodeOfCare, creating it if it does not already exist {3}
  - getBasedOn
```
public List<Reference> getBasedOn()
```
    Returns:
    
    basedOn (The request this encounter satisfies (e.g. incoming referral or procedure request).)
  - setBasedOn
```
public Encounter setBasedOn(List<Reference> theBasedOn)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasBasedOn
```
public boolean hasBasedOn()
```
  - addBasedOn
```
public Reference addBasedOn()
```
  - addBasedOn
```
public Encounter addBasedOn(Reference t)
```
  - getBasedOnFirstRep
```
public Reference getBasedOnFirstRep()
```
    Returns:
    
    The first repetition of repeating field basedOn, creating it if it does not already exist {3}
  - getParticipant
```
public List<Encounter.EncounterParticipantComponent> getParticipant()
```
    Returns:
    
    participant (The list of people responsible for providing the service.)
  - setParticipant
```
public Encounter setParticipant(List<Encounter.EncounterParticipantComponent> theParticipant)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasParticipant
```
public boolean hasParticipant()
```
  - addParticipant
```
public Encounter.EncounterParticipantComponent addParticipant()
```
  - addParticipant
```
public Encounter addParticipant(Encounter.EncounterParticipantComponent t)
```
  - getParticipantFirstRep
```
public Encounter.EncounterParticipantComponent getParticipantFirstRep()
```
    Returns:
    
    The first repetition of repeating field participant, creating it if it does not already exist {3}
  - getAppointment
```
public List<Reference> getAppointment()
```
    Returns:
    
    appointment (The appointment that scheduled this encounter.)
  - setAppointment
```
public Encounter setAppointment(List<Reference> theAppointment)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasAppointment
```
public boolean hasAppointment()
```
  - addAppointment
```
public Reference addAppointment()
```
  - addAppointment
```
public Encounter addAppointment(Reference t)
```
  - getAppointmentFirstRep
```
public Reference getAppointmentFirstRep()
```
    Returns:
    
    The first repetition of repeating field appointment, creating it if it does not already exist {3}
  - getActualPeriod
```
public Period getActualPeriod()
```
    Returns:
    
    actualPeriod (The actual start and end time of the encounter.)
  - hasActualPeriod
```
public boolean hasActualPeriod()
```
  - setActualPeriod
```
public Encounter setActualPeriod(Period value)
```
    Parameters:
    
    value - actualPeriod (The actual start and end time of the encounter.)
  - getPlannedStartDateElement
```
public DateTimeType getPlannedStartDateElement()
```
    Returns:
    
    plannedStartDate (The planned start date/time (or admission date) of the encounter.). This is the underlying object with id, value and extensions. The accessor "getPlannedStartDate" gives direct access to the value
  - hasPlannedStartDateElement
```
public boolean hasPlannedStartDateElement()
```
  - hasPlannedStartDate
```
public boolean hasPlannedStartDate()
```
  - setPlannedStartDateElement
```
public Encounter setPlannedStartDateElement(DateTimeType value)
```
    Parameters:
    
    value - plannedStartDate (The planned start date/time (or admission date) of the encounter.). This is the underlying object with id, value and extensions. The accessor "getPlannedStartDate" gives direct access to the value
  - getPlannedStartDate
```
public Date getPlannedStartDate()
```
    Returns:
    
    The planned start date/time (or admission date) of the encounter.
  - setPlannedStartDate
```
public Encounter setPlannedStartDate(Date value)
```
    Parameters:
    
    value - The planned start date/time (or admission date) of the encounter.
  - getPlannedEndDateElement
```
public DateTimeType getPlannedEndDateElement()
```
    Returns:
    
    plannedEndDate (The planned end date/time (or discharge date) of the encounter.). This is the underlying object with id, value and extensions. The accessor "getPlannedEndDate" gives direct access to the value
  - hasPlannedEndDateElement
```
public boolean hasPlannedEndDateElement()
```
  - hasPlannedEndDate
```
public boolean hasPlannedEndDate()
```
  - setPlannedEndDateElement
```
public Encounter setPlannedEndDateElement(DateTimeType value)
```
    Parameters:
    
    value - plannedEndDate (The planned end date/time (or discharge date) of the encounter.). This is the underlying object with id, value and extensions. The accessor "getPlannedEndDate" gives direct access to the value
  - getPlannedEndDate
```
public Date getPlannedEndDate()
```
    Returns:
    
    The planned end date/time (or discharge date) of the encounter.
  - setPlannedEndDate
```
public Encounter setPlannedEndDate(Date value)
```
    Parameters:
    
    value - The planned end date/time (or discharge date) of the encounter.
  - getLength
```
public Duration getLength()
```
    Returns:
    
    length (Quantity of time the encounter lasted. This excludes the time during leaves of absence.)
  - hasLength
```
public boolean hasLength()
```
  - setLength
```
public Encounter setLength(Duration value)
```
    Parameters:
    
    value - length (Quantity of time the encounter lasted. This excludes the time during leaves of absence.)
  - getReason
```
public List<CodeableReference> getReason()
```
    Returns:
    
    reason (Reason the encounter takes place, expressed as a code or a reference to another resource. For admissions, this can be used for a coded admission diagnosis.)
  - setReason
```
public Encounter setReason(List<CodeableReference> theReason)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasReason
```
public boolean hasReason()
```
  - addReason
```
public CodeableReference addReason()
```
  - addReason
```
public Encounter addReason(CodeableReference t)
```
  - getReasonFirstRep
```
public CodeableReference getReasonFirstRep()
```
    Returns:
    
    The first repetition of repeating field reason, creating it if it does not already exist {3}
  - getDiagnosis
```
public List<Encounter.DiagnosisComponent> getDiagnosis()
```
    Returns:
    
    diagnosis (The list of diagnosis relevant to this encounter.)
  - setDiagnosis
```
public Encounter setDiagnosis(List<Encounter.DiagnosisComponent> theDiagnosis)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasDiagnosis
```
public boolean hasDiagnosis()
```
  - addDiagnosis
```
public Encounter.DiagnosisComponent addDiagnosis()
```
  - addDiagnosis
```
public Encounter addDiagnosis(Encounter.DiagnosisComponent t)
```
  - getDiagnosisFirstRep
```
public Encounter.DiagnosisComponent getDiagnosisFirstRep()
```
    Returns:
    
    The first repetition of repeating field diagnosis, creating it if it does not already exist {3}
  - getAccount
```
public List<Reference> getAccount()
```
    Returns:
    
    account (The set of accounts that may be used for billing for this Encounter.)
  - setAccount
```
public Encounter setAccount(List<Reference> theAccount)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasAccount
```
public boolean hasAccount()
```
  - addAccount
```
public Reference addAccount()
```
  - addAccount
```
public Encounter addAccount(Reference t)
```
  - getAccountFirstRep
```
public Reference getAccountFirstRep()
```
    Returns:
    
    The first repetition of repeating field account, creating it if it does not already exist {3}
  - getHospitalization
```
public Encounter.EncounterHospitalizationComponent getHospitalization()
```
    Returns:
    
    hospitalization (Details about the admission to a healthcare service.)
  - hasHospitalization
```
public boolean hasHospitalization()
```
  - setHospitalization
```
public Encounter setHospitalization(Encounter.EncounterHospitalizationComponent value)
```
    Parameters:
    
    value - hospitalization (Details about the admission to a healthcare service.)
  - getLocation
```
public List<Encounter.EncounterLocationComponent> getLocation()
```
    Returns:
    
    location (List of locations where the patient has been during this encounter.)
  - setLocation
```
public Encounter setLocation(List<Encounter.EncounterLocationComponent> theLocation)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasLocation
```
public boolean hasLocation()
```
  - addLocation
```
public Encounter.EncounterLocationComponent addLocation()
```
  - addLocation
```
public Encounter addLocation(Encounter.EncounterLocationComponent t)
```
  - getLocationFirstRep
```
public Encounter.EncounterLocationComponent getLocationFirstRep()
```
    Returns:
    
    The first repetition of repeating field location, creating it if it does not already exist {3}
  - getServiceProvider
```
public Reference getServiceProvider()
```
    Returns:
    
    serviceProvider (The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.)
  - hasServiceProvider
```
public boolean hasServiceProvider()
```
  - setServiceProvider
```
public Encounter setServiceProvider(Reference value)
```
    Parameters:
    
    value - serviceProvider (The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.)
  - getPartOf
```
public Reference getPartOf()
```
    Returns:
    
    partOf (Another Encounter of which this encounter is a part of (administratively or in time).)
  - hasPartOf
```
public boolean hasPartOf()
```
  - setPartOf
```
public Encounter setPartOf(Reference value)
```
    Parameters:
    
    value - partOf (Another Encounter of which this encounter is a part of (administratively or in time).)
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class DomainResource
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Encounter copy()
```
    Specified by:
    
    copy in class DomainResource
  - copyValues
```
public void copyValues(Encounter dst)
```
  - typedCopy
```
protected Encounter typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other_)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other_)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Constructor	Description
`Encounter()`	Constructor
`Encounter(Encounter.EncounterStatus status, Coding class_)`	Constructor

Class Encounter

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.r5.model.DomainResource

Fields inherited from class org.hl7.fhir.r5.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.r5.model.DomainResource

Methods inherited from class org.hl7.fhir.r5.model.Resource

Methods inherited from class org.hl7.fhir.r5.model.BaseResource

Methods inherited from class org.hl7.fhir.r5.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Field Detail

identifier

status

statusHistory

class_

classHistory

type

serviceType

priority

subject

subjectStatus

episodeOfCare

basedOn

participant

appointment

actualPeriod

plannedStartDate

plannedEndDate

length

reason

diagnosis

account

hospitalization

location

serviceProvider

partOf

SP_ACCOUNT

ACCOUNT

INCLUDE_ACCOUNT

SP_APPOINTMENT

APPOINTMENT

INCLUDE_APPOINTMENT

SP_BASED_ON

BASED_ON

INCLUDE_BASED_ON

SP_CLASS

CLASS

SP_DIAGNOSIS

DIAGNOSIS

INCLUDE_DIAGNOSIS

SP_EPISODE_OF_CARE

EPISODE_OF_CARE

INCLUDE_EPISODE_OF_CARE

SP_LENGTH

LENGTH

SP_LOCATION_PERIOD

LOCATION_PERIOD

SP_LOCATION

LOCATION

INCLUDE_LOCATION

SP_PART_OF

PART_OF

INCLUDE_PART_OF

SP_PARTICIPANT_TYPE

PARTICIPANT_TYPE

SP_PARTICIPANT

PARTICIPANT

INCLUDE_PARTICIPANT

SP_PRACTITIONER

PRACTITIONER

INCLUDE_PRACTITIONER

SP_REASON_CODE

REASON_CODE