Encounter (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 3.6.0 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.Encounter

All Implemented Interfaces:

ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource
```
public class Encounter
extends BaseResource
implements ca.uhn.fhir.model.api.IResource
```
HAPI/FHIR Encounter Resource (workflow.encounter)
Definition: 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.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/Encounter

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Encounter.Hospitalization` Block class for child element: Encounter.hospitalization ()
`static class`	`Encounter.Location` Block class for child element: Encounter.location ()
`static class`	`Encounter.Participant` Block class for child element: Encounter.participant ()
`static class`	`Encounter.StatusHistory` Block class for child element: Encounter.statusHistory ()

Field Summary

Fields
Modifier and Type	Field and Description
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`APPOINTMENT` Fluent Client search parameter constant for appointment
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`CONDITION` Fluent Client search parameter constant for condition
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`EPISODEOFCARE` Fluent Client search parameter constant for episodeofcare
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`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_CONDITION` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_EPISODEOFCARE` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_INCOMINGREFERRAL` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_INDICATION` 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_PROCEDURE` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`INCOMINGREFERRAL` Fluent Client search parameter constant for incomingreferral
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`INDICATION` Fluent Client search parameter constant for indication
`static ca.uhn.fhir.rest.gclient.NumberClientParam`	`LENGTH` Fluent Client search parameter constant for length
`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
`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
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PRACTITIONER` Fluent Client search parameter constant for practitioner
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PROCEDURE` Fluent Client search parameter constant for procedure
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`REASON` Fluent Client search parameter constant for reason
`static String`	`SP_APPOINTMENT` Search parameter constant for appointment
`static String`	`SP_CONDITION` Search parameter constant for condition
`static String`	`SP_DATE` Search parameter constant for date
`static String`	`SP_EPISODEOFCARE` Search parameter constant for episodeofcare
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_INCOMINGREFERRAL` Search parameter constant for incomingreferral
`static String`	`SP_INDICATION` Search parameter constant for indication
`static String`	`SP_LENGTH` Search parameter constant for length
`static String`	`SP_LOCATION` Search parameter constant for location
`static String`	`SP_LOCATION_PERIOD` Search parameter constant for location-period
`static String`	`SP_PART_OF` Search parameter constant for part-of
`static String`	`SP_PARTICIPANT` Search parameter constant for participant
`static String`	`SP_PARTICIPANT_TYPE` Search parameter constant for participant-type
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_PRACTITIONER` Search parameter constant for practitioner
`static String`	`SP_PROCEDURE` Search parameter constant for procedure
`static String`	`SP_REASON` Search parameter constant for reason
`static String`	`SP_SPECIAL_ARRANGEMENT` Search parameter constant for special-arrangement
`static String`	`SP_STATUS` Search parameter constant for status
`static String`	`SP_TYPE` Search parameter constant for type
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`SPECIAL_ARRANGEMENT` Fluent Client search parameter constant for special-arrangement
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`TYPE` Fluent Client search parameter constant for type

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
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 and Description

Encounter()

Constructors
Constructor and Description
`Encounter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResourceReferenceDt`	`addEpisodeOfCare()` Adds and returns a new value for episodeOfCare (context)
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (id)
`Encounter`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier (id)
`ResourceReferenceDt`	`addIncomingReferral()` Adds and returns a new value for incomingReferral ()
`ResourceReferenceDt`	`addIndication()` Adds and returns a new value for indication (why)
`Encounter.Location`	`addLocation()` Adds and returns a new value for location ()
`Encounter`	`addLocation(Encounter.Location theValue)` Adds a given new value for location ()
`Encounter.Participant`	`addParticipant()` Adds and returns a new value for participant ()
`Encounter`	`addParticipant(Encounter.Participant theValue)` Adds a given new value for participant ()
`CodeableConceptDt`	`addReason()` Adds and returns a new value for reason (why)
`Encounter`	`addReason(CodeableConceptDt theValue)` Adds a given new value for reason (why)
`Encounter.StatusHistory`	`addStatusHistory()` Adds and returns a new value for statusHistory ()
`Encounter`	`addStatusHistory(Encounter.StatusHistory theValue)` Adds a given new value for statusHistory ()
`CodeableConceptDt`	`addType()` Adds and returns a new value for type (class)
`Encounter`	`addType(CodeableConceptDt theValue)` Adds a given new value for type (class)
`<T extends ca.uhn.fhir.model.api.IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`ResourceReferenceDt`	`getAppointment()` Gets the value(s) for appointment ().
`String`	`getClassElement()` Gets the value(s) for class (class).
`ca.uhn.fhir.model.primitive.BoundCodeDt<EncounterClassEnum>`	`getClassElementElement()` Gets the value(s) for class (class).
`List<ResourceReferenceDt>`	`getEpisodeOfCare()` Gets the value(s) for episodeOfCare (context).
`Encounter.Hospitalization`	`getHospitalization()` Gets the value(s) for hospitalization ().
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (id).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (id), creating it if it does not already exist.
`List<ResourceReferenceDt>`	`getIncomingReferral()` Gets the value(s) for incomingReferral ().
`List<ResourceReferenceDt>`	`getIndication()` Gets the value(s) for indication (why).
`DurationDt`	`getLength()` Gets the value(s) for length ().
`List<Encounter.Location>`	`getLocation()` Gets the value(s) for location ().
`Encounter.Location`	`getLocationFirstRep()` Gets the first repetition for location (), creating it if it does not already exist.
`List<Encounter.Participant>`	`getParticipant()` Gets the value(s) for participant ().
`Encounter.Participant`	`getParticipantFirstRep()` Gets the first repetition for participant (), creating it if it does not already exist.
`ResourceReferenceDt`	`getPartOf()` Gets the value(s) for partOf ().
`ResourceReferenceDt`	`getPatient()` Gets the value(s) for patient (who.focus).
`PeriodDt`	`getPeriod()` Gets the value(s) for period (when.done).
`CodeableConceptDt`	`getPriority()` Gets the value(s) for priority (grade).
`List<CodeableConceptDt>`	`getReason()` Gets the value(s) for reason (why).
`CodeableConceptDt`	`getReasonFirstRep()` Gets the first repetition for reason (why), creating it if it does not already exist.
`String`	`getResourceName()`
`ResourceReferenceDt`	`getServiceProvider()` Gets the value(s) for serviceProvider ().
`String`	`getStatus()` Gets the value(s) for status (status).
`ca.uhn.fhir.model.primitive.BoundCodeDt<EncounterStateEnum>`	`getStatusElement()` Gets the value(s) for status (status).
`List<Encounter.StatusHistory>`	`getStatusHistory()` Gets the value(s) for statusHistory ().
`Encounter.StatusHistory`	`getStatusHistoryFirstRep()` Gets the first repetition for statusHistory (), creating it if it does not already exist.
`ca.uhn.fhir.context.FhirVersionEnum`	`getStructureFhirVersionEnum()`
`List<CodeableConceptDt>`	`getType()` Gets the value(s) for type (class).
`CodeableConceptDt`	`getTypeFirstRep()` Gets the first repetition for type (class), creating it if it does not already exist.
`boolean`	`isEmpty()`
`Encounter`	`setAppointment(ResourceReferenceDt theValue)` Sets the value(s) for appointment ()
`Encounter`	`setClassElement(ca.uhn.fhir.model.primitive.BoundCodeDt<EncounterClassEnum> theValue)` Sets the value(s) for class (class)
`Encounter`	`setClassElement(EncounterClassEnum theValue)` Sets the value(s) for class (class)
`Encounter`	`setEpisodeOfCare(List<ResourceReferenceDt> theValue)` Sets the value(s) for episodeOfCare (context)
`Encounter`	`setHospitalization(Encounter.Hospitalization theValue)` Sets the value(s) for hospitalization ()
`Encounter`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (id)
`Encounter`	`setIncomingReferral(List<ResourceReferenceDt> theValue)` Sets the value(s) for incomingReferral ()
`Encounter`	`setIndication(List<ResourceReferenceDt> theValue)` Sets the value(s) for indication (why)
`Encounter`	`setLength(DurationDt theValue)` Sets the value(s) for length ()
`Encounter`	`setLocation(List<Encounter.Location> theValue)` Sets the value(s) for location ()
`Encounter`	`setParticipant(List<Encounter.Participant> theValue)` Sets the value(s) for participant ()
`Encounter`	`setPartOf(ResourceReferenceDt theValue)` Sets the value(s) for partOf ()
`Encounter`	`setPatient(ResourceReferenceDt theValue)` Sets the value(s) for patient (who.focus)
`Encounter`	`setPeriod(PeriodDt theValue)` Sets the value(s) for period (when.done)
`Encounter`	`setPriority(CodeableConceptDt theValue)` Sets the value(s) for priority (grade)
`Encounter`	`setReason(List<CodeableConceptDt> theValue)` Sets the value(s) for reason (why)
`Encounter`	`setServiceProvider(ResourceReferenceDt theValue)` Sets the value(s) for serviceProvider ()
`Encounter`	`setStatus(ca.uhn.fhir.model.primitive.BoundCodeDt<EncounterStateEnum> theValue)` Sets the value(s) for status (status)
`Encounter`	`setStatus(EncounterStateEnum theValue)` Sets the value(s) for status (status)
`Encounter`	`setStatusHistory(List<Encounter.StatusHistory> theValue)` Sets the value(s) for statusHistory ()
`Encounter`	`setType(List<CodeableConceptDt> theValue)` Sets the value(s) for type (class)

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getMeta, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, hasFormatComment

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

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getMeta, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

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

- Field Detail
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description:
    Type: token
    Path: Encounter.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:
    Type: token
    Path: Encounter.identifier
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter constant for status
    Description:
    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:
    Type: token
    Path: Encounter.status
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter constant for date
    Description: A date within the period the Encounter lasted
    Type: date
    Path: Encounter.period
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: A date within the period the Encounter lasted
    Type: date
    Path: Encounter.period
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description:
    Type: reference
    Path: Encounter.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:
    Type: reference
    Path: Encounter.patient
  - SP_APPOINTMENT
```
public static final String SP_APPOINTMENT
```
    Search parameter constant for appointment
    Description:
    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:
    Type: reference
    Path: Encounter.appointment
  - SP_LENGTH
```
public static final String SP_LENGTH
```
    Search parameter constant for length
    Description: Length of encounter in days
    Type: number
    Path: Encounter.length
    
    See Also:
    
    Constant Field Values
  - LENGTH
```
public static final ca.uhn.fhir.rest.gclient.NumberClientParam LENGTH
```
    Fluent Client search parameter constant for length
    Description: Length of encounter in days
    Type: number
    Path: Encounter.length
  - SP_REASON
```
public static final String SP_REASON
```
    Search parameter constant for reason
    Description:
    Type: token
    Path: Encounter.reason
    
    See Also:
    
    Constant Field Values
  - REASON
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam REASON
```
    Fluent Client search parameter constant for reason
    Description:
    Type: token
    Path: Encounter.reason
  - SP_INDICATION
```
public static final String SP_INDICATION
```
    Search parameter constant for indication
    Description:
    Type: reference
    Path: Encounter.indication
    
    See Also:
    
    Constant Field Values
  - INDICATION
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INDICATION
```
    Fluent Client search parameter constant for indication
    Description:
    Type: reference
    Path: Encounter.indication
  - SP_CONDITION
```
public static final String SP_CONDITION
```
    Search parameter constant for condition
    Description:
    Type: reference
    Path: Encounter.indication
    
    See Also:
    
    Constant Field Values
  - CONDITION
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONDITION
```
    Fluent Client search parameter constant for condition
    Description:
    Type: reference
    Path: Encounter.indication
  - SP_PROCEDURE
```
public static final String SP_PROCEDURE
```
    Search parameter constant for procedure
    Description:
    Type: reference
    Path: Encounter.indication
    
    See Also:
    
    Constant Field Values
  - PROCEDURE
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PROCEDURE
```
    Fluent Client search parameter constant for procedure
    Description:
    Type: reference
    Path: Encounter.indication
  - SP_LOCATION
```
public static final String SP_LOCATION
```
    Search parameter constant for location
    Description:
    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:
    Type: reference
    Path: Encounter.location.location
  - SP_LOCATION_PERIOD
```
public static final String SP_LOCATION_PERIOD
```
    Search parameter constant for location-period
    Description:
    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:
    Type: date
    Path: Encounter.location.period
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter constant for type
    Description:
    Type: token
    Path: Encounter.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:
    Type: token
    Path: Encounter.type
  - SP_SPECIAL_ARRANGEMENT
```
public static final String SP_SPECIAL_ARRANGEMENT
```
    Search parameter constant for special-arrangement
    Description:
    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:
    Type: token
    Path: Encounter.hospitalization.specialArrangement
  - SP_PART_OF
```
public static final String SP_PART_OF
```
    Search parameter constant for part-of
    Description:
    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:
    Type: reference
    Path: Encounter.partOf
  - SP_PARTICIPANT
```
public static final String SP_PARTICIPANT
```
    Search parameter constant for participant
    Description:
    Type: reference
    Path: Encounter.participant.individual
    
    See Also:
    
    Constant Field Values
  - PARTICIPANT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARTICIPANT
```
    Fluent Client search parameter constant for participant
    Description:
    Type: reference
    Path: Encounter.participant.individual
  - SP_PARTICIPANT_TYPE
```
public static final String SP_PARTICIPANT_TYPE
```
    Search parameter constant for participant-type
    Description:
    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:
    Type: token
    Path: Encounter.participant.type
  - SP_EPISODEOFCARE
```
public static final String SP_EPISODEOFCARE
```
    Search parameter constant for episodeofcare
    Description:
    Type: reference
    Path: Encounter.episodeOfCare
    
    See Also:
    
    Constant Field Values
  - EPISODEOFCARE
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam EPISODEOFCARE
```
    Fluent Client search parameter constant for episodeofcare
    Description:
    Type: reference
    Path: Encounter.episodeOfCare
  - SP_INCOMINGREFERRAL
```
public static final String SP_INCOMINGREFERRAL
```
    Search parameter constant for incomingreferral
    Description:
    Type: reference
    Path: Encounter.incomingReferral
    
    See Also:
    
    Constant Field Values
  - INCOMINGREFERRAL
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INCOMINGREFERRAL
```
    Fluent Client search parameter constant for incomingreferral
    Description:
    Type: reference
    Path: Encounter.incomingReferral
  - SP_PRACTITIONER
```
public static final String SP_PRACTITIONER
```
    Search parameter constant for practitioner
    Description:
    Type: reference
    Path: Encounter.participant.individual
    
    See Also:
    
    Constant Field Values
  - PRACTITIONER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRACTITIONER
```
    Fluent Client search parameter constant for practitioner
    Description:
    Type: reference
    Path: Encounter.participant.individual
  - 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".
  - INCLUDE_CONDITION
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_CONDITION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:condition".
  - INCLUDE_EPISODEOFCARE
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_EPISODEOFCARE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:episodeofcare".
  - INCLUDE_INCOMINGREFERRAL
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_INCOMINGREFERRAL
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:incomingreferral".
  - INCLUDE_INDICATION
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_INDICATION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:indication".
  - 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".
  - 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".
  - 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".
  - 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".
  - 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".
  - INCLUDE_PROCEDURE
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PROCEDURE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:procedure".
- Constructor Detail
  - Encounter
```
public Encounter()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.
    Definition:
  - setIdentifier
```
public Encounter setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (id)
    Definition:
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (id)
    Definition:
  - addIdentifier
```
public Encounter addIdentifier(IdentifierDt theValue)
```
    Adds a given new value for identifier (id)
    Definition:
    
    Parameters:
    
    theValue - The identifier to add (must not be null)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (id), creating it if it does not already exist.
    Definition:
  - getStatusElement
```
public ca.uhn.fhir.model.primitive.BoundCodeDt<EncounterStateEnum> getStatusElement()
```
    Gets the value(s) for status (status). creating it if it does not exist. Will not return null.
    Definition:
  - getStatus
```
public String getStatus()
```
    Gets the value(s) for status (status). creating it if it does not exist. This method may return null.
    Definition:
  - setStatus
```
public Encounter setStatus(ca.uhn.fhir.model.primitive.BoundCodeDt<EncounterStateEnum> theValue)
```
    Sets the value(s) for status (status)
    Definition:
  - setStatus
```
public Encounter setStatus(EncounterStateEnum theValue)
```
    Sets the value(s) for status (status)
    Definition:
  - getStatusHistory
```
public List<Encounter.StatusHistory> getStatusHistory()
```
    Gets the value(s) for statusHistory (). creating it if it does not exist. Will not return null.
    Definition: 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.StatusHistory> theValue)
```
    Sets the value(s) for statusHistory ()
    Definition: 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
  - addStatusHistory
```
public Encounter.StatusHistory addStatusHistory()
```
    Adds and returns a new value for statusHistory ()
    Definition: 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
  - addStatusHistory
```
public Encounter addStatusHistory(Encounter.StatusHistory theValue)
```
    Adds a given new value for statusHistory ()
    Definition: 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
    
    Parameters:
    
    theValue - The statusHistory to add (must not be null)
  - getStatusHistoryFirstRep
```
public Encounter.StatusHistory getStatusHistoryFirstRep()
```
    Gets the first repetition for statusHistory (), creating it if it does not already exist.
    Definition: 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
  - getClassElementElement
```
public ca.uhn.fhir.model.primitive.BoundCodeDt<EncounterClassEnum> getClassElementElement()
```
    Gets the value(s) for class (class). creating it if it does not exist. Will not return null.
    Definition:
  - getClassElement
```
public String getClassElement()
```
    Gets the value(s) for class (class). creating it if it does not exist. This method may return null.
    Definition:
  - setClassElement
```
public Encounter setClassElement(ca.uhn.fhir.model.primitive.BoundCodeDt<EncounterClassEnum> theValue)
```
    Sets the value(s) for class (class)
    Definition:
  - setClassElement
```
public Encounter setClassElement(EncounterClassEnum theValue)
```
    Sets the value(s) for class (class)
    Definition:
  - getType
```
public List<CodeableConceptDt> getType()
```
    Gets the value(s) for type (class). creating it if it does not exist. Will not return null.
    Definition: Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)
  - setType
```
public Encounter setType(List<CodeableConceptDt> theValue)
```
    Sets the value(s) for type (class)
    Definition: Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)
  - addType
```
public CodeableConceptDt addType()
```
    Adds and returns a new value for type (class)
    Definition: Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)
  - addType
```
public Encounter addType(CodeableConceptDt theValue)
```
    Adds a given new value for type (class)
    Definition: Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)
    
    Parameters:
    
    theValue - The type to add (must not be null)
  - getTypeFirstRep
```
public CodeableConceptDt getTypeFirstRep()
```
    Gets the first repetition for type (class), creating it if it does not already exist.
    Definition: Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)
  - getPriority
```
public CodeableConceptDt getPriority()
```
    Gets the value(s) for priority (grade). creating it if it does not exist. Will not return null.
    Definition:
  - setPriority
```
public Encounter setPriority(CodeableConceptDt theValue)
```
    Sets the value(s) for priority (grade)
    Definition:
  - getPatient
```
public ResourceReferenceDt getPatient()
```
    Gets the value(s) for patient (who.focus). creating it if it does not exist. Will not return null.
    Definition:
  - setPatient
```
public Encounter setPatient(ResourceReferenceDt theValue)
```
    Sets the value(s) for patient (who.focus)
    Definition:
  - getEpisodeOfCare
```
public List<ResourceReferenceDt> getEpisodeOfCare()
```
    Gets the value(s) for episodeOfCare (context). creating it if it does not exist. Will not return null.
    Definition: 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<ResourceReferenceDt> theValue)
```
    Sets the value(s) for episodeOfCare (context)
    Definition: 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)
  - addEpisodeOfCare
```
public ResourceReferenceDt addEpisodeOfCare()
```
    Adds and returns a new value for episodeOfCare (context)
    Definition: 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)
  - getIncomingReferral
```
public List<ResourceReferenceDt> getIncomingReferral()
```
    Gets the value(s) for incomingReferral (). creating it if it does not exist. Will not return null.
    Definition: The referral request this encounter satisfies (incoming referral)
  - setIncomingReferral
```
public Encounter setIncomingReferral(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for incomingReferral ()
    Definition: The referral request this encounter satisfies (incoming referral)
  - addIncomingReferral
```
public ResourceReferenceDt addIncomingReferral()
```
    Adds and returns a new value for incomingReferral ()
    Definition: The referral request this encounter satisfies (incoming referral)
  - getParticipant
```
public List<Encounter.Participant> getParticipant()
```
    Gets the value(s) for participant (). creating it if it does not exist. Will not return null.
    Definition: The list of people responsible for providing the service
  - setParticipant
```
public Encounter setParticipant(List<Encounter.Participant> theValue)
```
    Sets the value(s) for participant ()
    Definition: The list of people responsible for providing the service
  - addParticipant
```
public Encounter.Participant addParticipant()
```
    Adds and returns a new value for participant ()
    Definition: The list of people responsible for providing the service
  - addParticipant
```
public Encounter addParticipant(Encounter.Participant theValue)
```
    Adds a given new value for participant ()
    Definition: The list of people responsible for providing the service
    
    Parameters:
    
    theValue - The participant to add (must not be null)
  - getParticipantFirstRep
```
public Encounter.Participant getParticipantFirstRep()
```
    Gets the first repetition for participant (), creating it if it does not already exist.
    Definition: The list of people responsible for providing the service
  - getAppointment
```
public ResourceReferenceDt getAppointment()
```
    Gets the value(s) for appointment (). creating it if it does not exist. Will not return null.
    Definition:
  - setAppointment
```
public Encounter setAppointment(ResourceReferenceDt theValue)
```
    Sets the value(s) for appointment ()
    Definition:
  - getPeriod
```
public PeriodDt getPeriod()
```
    Gets the value(s) for period (when.done). creating it if it does not exist. Will not return null.
    Definition: The start and end time of the encounter
  - setPeriod
```
public Encounter setPeriod(PeriodDt theValue)
```
    Sets the value(s) for period (when.done)
    Definition: The start and end time of the encounter
  - getLength
```
public DurationDt getLength()
```
    Gets the value(s) for length (). creating it if it does not exist. Will not return null.
    Definition: Quantity of time the encounter lasted. This excludes the time during leaves of absence.
  - setLength
```
public Encounter setLength(DurationDt theValue)
```
    Sets the value(s) for length ()
    Definition: Quantity of time the encounter lasted. This excludes the time during leaves of absence.
  - getReason
```
public List<CodeableConceptDt> getReason()
```
    Gets the value(s) for reason (why). creating it if it does not exist. Will not return null.
    Definition: Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis
  - setReason
```
public Encounter setReason(List<CodeableConceptDt> theValue)
```
    Sets the value(s) for reason (why)
    Definition: Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis
  - addReason
```
public CodeableConceptDt addReason()
```
    Adds and returns a new value for reason (why)
    Definition: Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis
  - addReason
```
public Encounter addReason(CodeableConceptDt theValue)
```
    Adds a given new value for reason (why)
    Definition: Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis
    
    Parameters:
    
    theValue - The reason to add (must not be null)
  - getReasonFirstRep
```
public CodeableConceptDt getReasonFirstRep()
```
    Gets the first repetition for reason (why), creating it if it does not already exist.
    Definition: Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis
  - getIndication
```
public List<ResourceReferenceDt> getIndication()
```
    Gets the value(s) for indication (why). creating it if it does not exist. Will not return null.
    Definition: Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure
  - setIndication
```
public Encounter setIndication(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for indication (why)
    Definition: Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure
  - addIndication
```
public ResourceReferenceDt addIndication()
```
    Adds and returns a new value for indication (why)
    Definition: Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure
  - getHospitalization
```
public Encounter.Hospitalization getHospitalization()
```
    Gets the value(s) for hospitalization (). creating it if it does not exist. Will not return null.
    Definition:
  - setHospitalization
```
public Encounter setHospitalization(Encounter.Hospitalization theValue)
```
    Sets the value(s) for hospitalization ()
    Definition:
  - getLocation
```
public List<Encounter.Location> getLocation()
```
    Gets the value(s) for location (). creating it if it does not exist. Will not return null.
    Definition: List of locations where the patient has been during this encounter
  - setLocation
```
public Encounter setLocation(List<Encounter.Location> theValue)
```
    Sets the value(s) for location ()
    Definition: List of locations where the patient has been during this encounter
  - addLocation
```
public Encounter.Location addLocation()
```
    Adds and returns a new value for location ()
    Definition: List of locations where the patient has been during this encounter
  - addLocation
```
public Encounter addLocation(Encounter.Location theValue)
```
    Adds a given new value for location ()
    Definition: List of locations where the patient has been during this encounter
    
    Parameters:
    
    theValue - The location to add (must not be null)
  - getLocationFirstRep
```
public Encounter.Location getLocationFirstRep()
```
    Gets the first repetition for location (), creating it if it does not already exist.
    Definition: List of locations where the patient has been during this encounter
  - getServiceProvider
```
public ResourceReferenceDt getServiceProvider()
```
    Gets the value(s) for serviceProvider (). creating it if it does not exist. Will not return null.
    Definition: An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.
  - setServiceProvider
```
public Encounter setServiceProvider(ResourceReferenceDt theValue)
```
    Sets the value(s) for serviceProvider ()
    Definition: An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.
  - getPartOf
```
public ResourceReferenceDt getPartOf()
```
    Gets the value(s) for partOf (). creating it if it does not exist. Will not return null.
    Definition: Another Encounter of which this encounter is a part of (administratively or in time).
  - setPartOf
```
public Encounter setPartOf(ResourceReferenceDt theValue)
```
    Sets the value(s) for partOf ()
    Definition: Another Encounter of which this encounter is a part of (administratively or in time).
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface ca.uhn.fhir.model.api.IResource
  - getStructureFhirVersionEnum
```
public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource

Class Encounter

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

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

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

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

Field Detail

SP_IDENTIFIER

IDENTIFIER

SP_STATUS

STATUS

SP_DATE

DATE

SP_PATIENT

PATIENT

SP_APPOINTMENT

APPOINTMENT

SP_LENGTH

LENGTH

SP_REASON

REASON

SP_INDICATION

INDICATION

SP_CONDITION

CONDITION

SP_PROCEDURE

PROCEDURE

SP_LOCATION

LOCATION

SP_LOCATION_PERIOD

LOCATION_PERIOD

SP_TYPE

TYPE

SP_SPECIAL_ARRANGEMENT

SPECIAL_ARRANGEMENT

SP_PART_OF

PART_OF

SP_PARTICIPANT

PARTICIPANT

SP_PARTICIPANT_TYPE

PARTICIPANT_TYPE

SP_EPISODEOFCARE

EPISODEOFCARE

SP_INCOMINGREFERRAL

INCOMINGREFERRAL

SP_PRACTITIONER

PRACTITIONER

INCLUDE_APPOINTMENT

INCLUDE_CONDITION

INCLUDE_EPISODEOFCARE

INCLUDE_INCOMINGREFERRAL

INCLUDE_INDICATION

INCLUDE_LOCATION

INCLUDE_PART_OF

INCLUDE_PARTICIPANT

INCLUDE_PATIENT

INCLUDE_PRACTITIONER

INCLUDE_PROCEDURE

Constructor Detail

Encounter

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getStatusElement

getStatus

setStatus

setStatus

getStatusHistory

setStatusHistory