Encounter (HAPI FHIR Structures - HL7.org DSTU2 3.3.0 API)

java.lang.Object
- org.hl7.fhir.instance.model.Base
- - org.hl7.fhir.instance.model.BaseResource
  - - org.hl7.fhir.instance.model.Resource
    - - org.hl7.fhir.instance.model.DomainResource
      - org.hl7.fhir.instance.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 and Description
`static class`	`Encounter.EncounterClass`
`static class`	`Encounter.EncounterClassEnumFactory`
`static class`	`Encounter.EncounterHospitalizationComponent`
`static class`	`Encounter.EncounterLocationComponent`
`static class`	`Encounter.EncounterLocationStatus`
`static class`	`Encounter.EncounterLocationStatusEnumFactory`
`static class`	`Encounter.EncounterParticipantComponent`
`static class`	`Encounter.EncounterState`
`static class`	`Encounter.EncounterStateEnumFactory`
`static class`	`Encounter.EncounterStatusHistoryComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Reference`	`appointment` The appointment that scheduled this encounter.
`protected Appointment`	`appointmentTarget` The actual object that is the target of the reference (The appointment that scheduled this encounter.)
`protected Enumeration<Encounter.EncounterClass>`	`class_` inpatient \| outpatient \| ambulatory \| emergency +.
`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 List<EpisodeOfCare>`	`episodeOfCareTarget` The actual objects that are the target of the reference (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.
`protected List<Reference>`	`incomingReferral` The referral request this encounter satisfies (incoming referral).
`protected List<ReferralRequest>`	`incomingReferralTarget` The actual objects that are the target of the reference (The referral request this encounter satisfies (incoming referral).)
`protected List<Reference>`	`indication` Reason the encounter takes place, as specified using information from another resource.
`protected List<Resource>`	`indicationTarget` The actual objects that are the target of the reference (Reason the encounter takes place, as specified using information from another resource.
`protected Duration`	`length` Quantity of time the encounter lasted.
`protected List<Encounter.EncounterLocationComponent>`	`location` List of locations where the patient has been during this encounter.
`protected List<Encounter.EncounterParticipantComponent>`	`participant` The list of people responsible for providing the service.
`protected Reference`	`partOf` Another Encounter of which this encounter is a part of (administratively or in time).
`protected Encounter`	`partOfTarget` The actual object that is the target of the reference (Another Encounter of which this encounter is a part of (administratively or in time).)
`protected Reference`	`patient` The patient present at the encounter.
`protected Patient`	`patientTarget` The actual object that is the target of the reference (The patient present at the encounter.)
`protected Period`	`period` The start and end time of the encounter.
`protected CodeableConcept`	`priority` Indicates the urgency of the encounter.
`protected List<CodeableConcept>`	`reason` Reason the encounter takes place, expressed as a code.
`protected Reference`	`serviceProvider` An organization that is in charge of maintaining the information of this Encounter (e.g.
`protected Organization`	`serviceProviderTarget` The actual object that is the target of the reference (An organization that is in charge of maintaining the information of this Encounter (e.g.
`static String`	`SP_APPOINTMENT`
`static String`	`SP_CONDITION`
`static String`	`SP_DATE`
`static String`	`SP_EPISODEOFCARE`
`static String`	`SP_IDENTIFIER`
`static String`	`SP_INCOMINGREFERRAL`
`static String`	`SP_INDICATION`
`static String`	`SP_LENGTH`
`static String`	`SP_LOCATION`
`static String`	`SP_LOCATIONPERIOD`
`static String`	`SP_PARTICIPANT`
`static String`	`SP_PARTICIPANTTYPE`
`static String`	`SP_PARTOF`
`static String`	`SP_PATIENT`
`static String`	`SP_PRACTITIONER`
`static String`	`SP_PROCEDURE`
`static String`	`SP_REASON`
`static String`	`SP_SPECIALARRANGEMENT`
`static String`	`SP_STATUS`
`static String`	`SP_TYPE`
`protected Enumeration<Encounter.EncounterState>`	`status` planned \| arrived \| in-progress \| onleave \| finished \| cancelled.
`protected List<Encounter.EncounterStatusHistoryComponent>`	`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 List<CodeableConcept>`	`type` Specific type of encounter (e.g.

Fields inherited from class org.hl7.fhir.instance.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.instance.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 and Description

Encounter()

Encounter(Enumeration<Encounter.EncounterState> status)

Constructors
Constructor and Description
`Encounter()`
`Encounter(Enumeration<Encounter.EncounterState> status)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Reference`	`addEpisodeOfCare()`
`Encounter`	`addEpisodeOfCare(Reference t)`
`EpisodeOfCare`	`addEpisodeOfCareTarget()`
`Identifier`	`addIdentifier()`
`Encounter`	`addIdentifier(Identifier t)`
`Reference`	`addIncomingReferral()`
`Encounter`	`addIncomingReferral(Reference t)`
`ReferralRequest`	`addIncomingReferralTarget()`
`Reference`	`addIndication()`
`Encounter`	`addIndication(Reference t)`
`Encounter.EncounterLocationComponent`	`addLocation()`
`Encounter`	`addLocation(Encounter.EncounterLocationComponent t)`
`Encounter.EncounterParticipantComponent`	`addParticipant()`
`Encounter`	`addParticipant(Encounter.EncounterParticipantComponent t)`
`CodeableConcept`	`addReason()`
`Encounter`	`addReason(CodeableConcept t)`
`Encounter.EncounterStatusHistoryComponent`	`addStatusHistory()`
`Encounter`	`addStatusHistory(Encounter.EncounterStatusHistoryComponent t)`
`CodeableConcept`	`addType()`
`Encounter`	`addType(CodeableConcept t)`
`Encounter`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`Reference`	`getAppointment()`
`Appointment`	`getAppointmentTarget()`
`Encounter.EncounterClass`	`getClass_()`
`Enumeration<Encounter.EncounterClass>`	`getClass_Element()`
`List<Reference>`	`getEpisodeOfCare()`
`List<EpisodeOfCare>`	`getEpisodeOfCareTarget()`
`Encounter.EncounterHospitalizationComponent`	`getHospitalization()`
`List<Identifier>`	`getIdentifier()`
`List<Reference>`	`getIncomingReferral()`
`List<ReferralRequest>`	`getIncomingReferralTarget()`
`List<Reference>`	`getIndication()`
`List<Resource>`	`getIndicationTarget()`
`Duration`	`getLength()`
`List<Encounter.EncounterLocationComponent>`	`getLocation()`
`List<Encounter.EncounterParticipantComponent>`	`getParticipant()`
`Reference`	`getPartOf()`
`Encounter`	`getPartOfTarget()`
`Reference`	`getPatient()`
`Patient`	`getPatientTarget()`
`Period`	`getPeriod()`
`CodeableConcept`	`getPriority()`
`List<CodeableConcept>`	`getReason()`
`ResourceType`	`getResourceType()`
`Reference`	`getServiceProvider()`
`Organization`	`getServiceProviderTarget()`
`Encounter.EncounterState`	`getStatus()`
`Enumeration<Encounter.EncounterState>`	`getStatusElement()`
`List<Encounter.EncounterStatusHistoryComponent>`	`getStatusHistory()`
`List<CodeableConcept>`	`getType()`
`boolean`	`hasAppointment()`
`boolean`	`hasClass_()`
`boolean`	`hasClass_Element()`
`boolean`	`hasEpisodeOfCare()`
`boolean`	`hasHospitalization()`
`boolean`	`hasIdentifier()`
`boolean`	`hasIncomingReferral()`
`boolean`	`hasIndication()`
`boolean`	`hasLength()`
`boolean`	`hasLocation()`
`boolean`	`hasParticipant()`
`boolean`	`hasPartOf()`
`boolean`	`hasPatient()`
`boolean`	`hasPeriod()`
`boolean`	`hasPriority()`
`boolean`	`hasReason()`
`boolean`	`hasServiceProvider()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasStatusHistory()`
`boolean`	`hasType()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Encounter`	`setAppointment(Reference value)`
`Encounter`	`setAppointmentTarget(Appointment value)`
`Encounter`	`setClass_(Encounter.EncounterClass value)`
`Encounter`	`setClass_Element(Enumeration<Encounter.EncounterClass> value)`
`Encounter`	`setHospitalization(Encounter.EncounterHospitalizationComponent value)`
`Encounter`	`setLength(Duration value)`
`Encounter`	`setPartOf(Reference value)`
`Encounter`	`setPartOfTarget(Encounter value)`
`Encounter`	`setPatient(Reference value)`
`Encounter`	`setPatientTarget(Patient value)`
`Encounter`	`setPeriod(Period value)`
`Encounter`	`setPriority(CodeableConcept value)`
`void`	`setProperty(String name, Base value)`
`Encounter`	`setServiceProvider(Reference value)`
`Encounter`	`setServiceProviderTarget(Organization value)`
`Encounter`	`setStatus(Encounter.EncounterState value)`
`Encounter`	`setStatusElement(Enumeration<Encounter.EncounterState> value)`
`protected Encounter`	`typedCopy()`

Methods inherited from class org.hl7.fhir.instance.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

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

Methods inherited from class org.hl7.fhir.instance.model.BaseResource
setId

Methods inherited from class org.hl7.fhir.instance.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

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

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    Identifier(s) by which this encounter is known.
  - status
```
protected Enumeration<Encounter.EncounterState> status
```
    planned | arrived | in-progress | onleave | finished | cancelled.
  - statusHistory
```
protected List<Encounter.EncounterStatusHistoryComponent> 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 Enumeration<Encounter.EncounterClass> class_
```
    inpatient | outpatient | ambulatory | emergency +.
  - type
```
protected List<CodeableConcept> type
```
    Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
  - priority
```
protected CodeableConcept priority
```
    Indicates the urgency of the encounter.
  - patient
```
protected Reference patient
```
    The patient present at the encounter.
  - patientTarget
```
protected Patient patientTarget
```
    The actual object that is the target of the reference (The patient present at the encounter.)
  - 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).
  - episodeOfCareTarget
```
protected List<EpisodeOfCare> episodeOfCareTarget
```
    The actual objects that are the target of the reference (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).)
  - incomingReferral
```
protected List<Reference> incomingReferral
```
    The referral request this encounter satisfies (incoming referral).
  - incomingReferralTarget
```
protected List<ReferralRequest> incomingReferralTarget
```
    The actual objects that are the target of the reference (The referral request this encounter satisfies (incoming referral).)
  - participant
```
protected List<Encounter.EncounterParticipantComponent> participant
```
    The list of people responsible for providing the service.
  - appointment
```
protected Reference appointment
```
    The appointment that scheduled this encounter.
  - appointmentTarget
```
protected Appointment appointmentTarget
```
    The actual object that is the target of the reference (The appointment that scheduled this encounter.)
  - period
```
protected Period period
```
    The start and end time of the encounter.
  - length
```
protected Duration length
```
    Quantity of time the encounter lasted. This excludes the time during leaves of absence.
  - reason
```
protected List<CodeableConcept> reason
```
    Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
  - indication
```
protected List<Reference> indication
```
    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.
  - indicationTarget
```
protected List<Resource> indicationTarget
```
    The actual objects that are the target of the reference (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.)
  - 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
```
    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.
  - serviceProviderTarget
```
protected Organization serviceProviderTarget
```
    The actual object that is the target of the reference (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.)
  - partOf
```
protected Reference partOf
```
    Another Encounter of which this encounter is a part of (administratively or in time).
  - partOfTarget
```
protected Encounter partOfTarget
```
    The actual object that is the target of the reference (Another Encounter of which this encounter is a part of (administratively or in time).)
  - SP_DATE
```
public static final String SP_DATE
```
    See Also:
    
    Constant Field Values
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - SP_REASON
```
public static final String SP_REASON
```
    See Also:
    
    Constant Field Values
  - SP_EPISODEOFCARE
```
public static final String SP_EPISODEOFCARE
```
    See Also:
    
    Constant Field Values
  - SP_PARTICIPANTTYPE
```
public static final String SP_PARTICIPANTTYPE
```
    See Also:
    
    Constant Field Values
  - SP_INCOMINGREFERRAL
```
public static final String SP_INCOMINGREFERRAL
```
    See Also:
    
    Constant Field Values
  - SP_PRACTITIONER
```
public static final String SP_PRACTITIONER
```
    See Also:
    
    Constant Field Values
  - SP_LENGTH
```
public static final String SP_LENGTH
```
    See Also:
    
    Constant Field Values
  - SP_APPOINTMENT
```
public static final String SP_APPOINTMENT
```
    See Also:
    
    Constant Field Values
  - SP_PARTOF
```
public static final String SP_PARTOF
```
    See Also:
    
    Constant Field Values
  - SP_PROCEDURE
```
public static final String SP_PROCEDURE
```
    See Also:
    
    Constant Field Values
  - SP_TYPE
```
public static final String SP_TYPE
```
    See Also:
    
    Constant Field Values
  - SP_PARTICIPANT
```
public static final String SP_PARTICIPANT
```
    See Also:
    
    Constant Field Values
  - SP_CONDITION
```
public static final String SP_CONDITION
```
    See Also:
    
    Constant Field Values
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    See Also:
    
    Constant Field Values
  - SP_LOCATIONPERIOD
```
public static final String SP_LOCATIONPERIOD
```
    See Also:
    
    Constant Field Values
  - SP_LOCATION
```
public static final String SP_LOCATION
```
    See Also:
    
    Constant Field Values
  - SP_INDICATION
```
public static final String SP_INDICATION
```
    See Also:
    
    Constant Field Values
  - SP_SPECIALARRANGEMENT
```
public static final String SP_SPECIALARRANGEMENT
```
    See Also:
    
    Constant Field Values
  - SP_STATUS
```
public static final String SP_STATUS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Encounter
```
public Encounter()
```
  - Encounter
```
public Encounter(Enumeration<Encounter.EncounterState> status)
```
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (Identifier(s) by which this encounter is known.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    identifier (Identifier(s) by which this encounter is known.)
  - addIdentifier
```
public Encounter addIdentifier(Identifier t)
```
  - getStatusElement
```
public Enumeration<Encounter.EncounterState> getStatusElement()
```
    Returns:
    
    status (planned | arrived | in-progress | onleave | finished | cancelled.). 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.EncounterState> value)
```
    Parameters:
    
    value - status (planned | arrived | in-progress | onleave | finished | cancelled.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public Encounter.EncounterState getStatus()
```
    Returns:
    
    planned | arrived | in-progress | onleave | finished | cancelled.
  - setStatus
```
public Encounter setStatus(Encounter.EncounterState value)
```
    Parameters:
    
    value - planned | arrived | in-progress | onleave | finished | cancelled.
  - getStatusHistory
```
public List<Encounter.EncounterStatusHistoryComponent> 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.)
  - hasStatusHistory
```
public boolean hasStatusHistory()
```
  - addStatusHistory
```
public Encounter.EncounterStatusHistoryComponent addStatusHistory()
```
    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.)
  - addStatusHistory
```
public Encounter addStatusHistory(Encounter.EncounterStatusHistoryComponent t)
```
  - getClass_Element
```
public Enumeration<Encounter.EncounterClass> getClass_Element()
```
    Returns:
    
    class_ (inpatient | outpatient | ambulatory | emergency +.). This is the underlying object with id, value and extensions. The accessor "getClass_" gives direct access to the value
  - hasClass_Element
```
public boolean hasClass_Element()
```
  - hasClass_
```
public boolean hasClass_()
```
  - setClass_Element
```
public Encounter setClass_Element(Enumeration<Encounter.EncounterClass> value)
```
    Parameters:
    
    value - class_ (inpatient | outpatient | ambulatory | emergency +.). This is the underlying object with id, value and extensions. The accessor "getClass_" gives direct access to the value
  - getClass_
```
public Encounter.EncounterClass getClass_()
```
    Returns:
    
    inpatient | outpatient | ambulatory | emergency +.
  - setClass_
```
public Encounter setClass_(Encounter.EncounterClass value)
```
    Parameters:
    
    value - inpatient | outpatient | ambulatory | emergency +.
  - getType
```
public List<CodeableConcept> getType()
```
    Returns:
    
    type (Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).)
  - hasType
```
public boolean hasType()
```
  - addType
```
public CodeableConcept addType()
```
    Returns:
    
    type (Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).)
  - addType
```
public Encounter addType(CodeableConcept t)
```
  - 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.)
  - getPatient
```
public Reference getPatient()
```
    Returns:
    
    patient (The patient present at the encounter.)
  - hasPatient
```
public boolean hasPatient()
```
  - setPatient
```
public Encounter setPatient(Reference value)
```
    Parameters:
    
    value - patient (The patient present at the encounter.)
  - getPatientTarget
```
public Patient getPatientTarget()
```
    Returns:
    
    patient The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The patient present at the encounter.)
  - setPatientTarget
```
public Encounter setPatientTarget(Patient value)
```
    Parameters:
    
    value - patient The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The patient present at the encounter.)
  - 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).)
  - hasEpisodeOfCare
```
public boolean hasEpisodeOfCare()
```
  - addEpisodeOfCare
```
public Reference addEpisodeOfCare()
```
    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).)
  - addEpisodeOfCare
```
public Encounter addEpisodeOfCare(Reference t)
```
  - getEpisodeOfCareTarget
```
public List<EpisodeOfCare> getEpisodeOfCareTarget()
```
    Returns:
    
    episodeOfCare (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. 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).)
  - addEpisodeOfCareTarget
```
public EpisodeOfCare addEpisodeOfCareTarget()
```
    Returns:
    
    episodeOfCare (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. 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<Reference> getIncomingReferral()
```
    Returns:
    
    incomingReferral (The referral request this encounter satisfies (incoming referral).)
  - hasIncomingReferral
```
public boolean hasIncomingReferral()
```
  - addIncomingReferral
```
public Reference addIncomingReferral()
```
    Returns:
    
    incomingReferral (The referral request this encounter satisfies (incoming referral).)
  - addIncomingReferral
```
public Encounter addIncomingReferral(Reference t)
```
  - getIncomingReferralTarget
```
public List<ReferralRequest> getIncomingReferralTarget()
```
    Returns:
    
    incomingReferral (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. The referral request this encounter satisfies (incoming referral).)
  - addIncomingReferralTarget
```
public ReferralRequest addIncomingReferralTarget()
```
    Returns:
    
    incomingReferral (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. The referral request this encounter satisfies (incoming referral).)
  - getParticipant
```
public List<Encounter.EncounterParticipantComponent> getParticipant()
```
    Returns:
    
    participant (The list of people responsible for providing the service.)
  - hasParticipant
```
public boolean hasParticipant()
```
  - addParticipant
```
public Encounter.EncounterParticipantComponent addParticipant()
```
    Returns:
    
    participant (The list of people responsible for providing the service.)
  - addParticipant
```
public Encounter addParticipant(Encounter.EncounterParticipantComponent t)
```
  - getAppointment
```
public Reference getAppointment()
```
    Returns:
    
    appointment (The appointment that scheduled this encounter.)
  - hasAppointment
```
public boolean hasAppointment()
```
  - setAppointment
```
public Encounter setAppointment(Reference value)
```
    Parameters:
    
    value - appointment (The appointment that scheduled this encounter.)
  - getAppointmentTarget
```
public Appointment getAppointmentTarget()
```
    Returns:
    
    appointment The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The appointment that scheduled this encounter.)
  - setAppointmentTarget
```
public Encounter setAppointmentTarget(Appointment value)
```
    Parameters:
    
    value - appointment The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The appointment that scheduled this encounter.)
  - getPeriod
```
public Period getPeriod()
```
    Returns:
    
    period (The start and end time of the encounter.)
  - hasPeriod
```
public boolean hasPeriod()
```
  - setPeriod
```
public Encounter setPeriod(Period value)
```
    Parameters:
    
    value - period (The start and end time 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<CodeableConcept> getReason()
```
    Returns:
    
    reason (Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.)
  - hasReason
```
public boolean hasReason()
```
  - addReason
```
public CodeableConcept addReason()
```
    Returns:
    
    reason (Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.)
  - addReason
```
public Encounter addReason(CodeableConcept t)
```
  - getIndication
```
public List<Reference> getIndication()
```
    Returns:
    
    indication (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.)
  - hasIndication
```
public boolean hasIndication()
```
  - addIndication
```
public Reference addIndication()
```
    Returns:
    
    indication (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 Encounter addIndication(Reference t)
```
  - getIndicationTarget
```
public List<Resource> getIndicationTarget()
```
    Returns:
    
    indication (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. 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.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.)
  - hasLocation
```
public boolean hasLocation()
```
  - addLocation
```
public Encounter.EncounterLocationComponent addLocation()
```
    Returns:
    
    location (List of locations where the patient has been during this encounter.)
  - addLocation
```
public Encounter addLocation(Encounter.EncounterLocationComponent t)
```
  - getServiceProvider
```
public Reference getServiceProvider()
```
    Returns:
    
    serviceProvider (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.)
  - hasServiceProvider
```
public boolean hasServiceProvider()
```
  - setServiceProvider
```
public Encounter setServiceProvider(Reference value)
```
    Parameters:
    
    value - serviceProvider (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.)
  - getServiceProviderTarget
```
public Organization getServiceProviderTarget()
```
    Returns:
    
    serviceProvider The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (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.)
  - setServiceProviderTarget
```
public Encounter setServiceProviderTarget(Organization value)
```
    Parameters:
    
    value - serviceProvider The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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 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).)
  - getPartOfTarget
```
public Encounter getPartOfTarget()
```
    Returns:
    
    partOf The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Another Encounter of which this encounter is a part of (administratively or in time).)
  - setPartOfTarget
```
public Encounter setPartOfTarget(Encounter value)
```
    Parameters:
    
    value - partOf The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Another Encounter of which this encounter is a part of (administratively or in time).)
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - setProperty
```
public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty 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()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Encounter copy()
```
    Specified by:
    
    copy in class DomainResource
  - 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

Class Encounter

Nested Class Summary

Field Summary

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

Fields inherited from class org.hl7.fhir.instance.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.instance.model.DomainResource

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

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

Methods inherited from class org.hl7.fhir.instance.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.IBaseResource

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

Field Detail

identifier

status

statusHistory

class_

type

priority

patient

patientTarget

episodeOfCare

episodeOfCareTarget

incomingReferral

incomingReferralTarget

participant

appointment

appointmentTarget

period

length

reason

indication

indicationTarget

hospitalization

location

serviceProvider

serviceProviderTarget

partOf

partOfTarget

SP_DATE

SP_IDENTIFIER

SP_REASON

SP_EPISODEOFCARE

SP_PARTICIPANTTYPE

SP_INCOMINGREFERRAL

SP_PRACTITIONER

SP_LENGTH

SP_APPOINTMENT

SP_PARTOF

SP_PROCEDURE

SP_TYPE

SP_PARTICIPANT

SP_CONDITION

SP_PATIENT

SP_LOCATIONPERIOD

SP_LOCATION

SP_INDICATION

SP_SPECIALARRANGEMENT

SP_STATUS

Constructor Detail

Encounter

Encounter

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getStatusHistory

hasStatusHistory