Package org.hl7.fhir.r4.model

Class Encounter

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.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 enum	Encounter.EncounterLocationStatus
static class	Encounter.EncounterLocationStatusEnumFactory
static class	Encounter.EncounterParticipantComponent
static enum	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 final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ACCOUNT	Fluent Client search parameter constant for account
protected List<Account>	accountTarget	The actual objects that are the target of the reference (The set of accounts that may be used for billing for this Encounter.)
protected List<Reference>	appointment	The appointment that scheduled this encounter.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	APPOINTMENT	Fluent Client search parameter constant for appointment
protected List<Appointment>	appointmentTarget	The actual objects that are the target of the reference (The appointment that scheduled this encounter.)
static final 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.
protected List<ServiceRequest>	basedOnTarget	The actual objects that are the target of the reference (The request this encounter satisfies (e.g.
static final 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 final 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 final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DIAGNOSIS	Fluent Client search parameter constant for diagnosis
static final 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 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.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_ACCOUNT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_APPOINTMENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_BASED_ON	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_DIAGNOSIS	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_EPISODE_OF_CARE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_LOCATION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PART_OF	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PARTICIPANT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PRACTITIONER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_REASON_REFERENCE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SERVICE_PROVIDER	Constant for fluent queries to be used to add include statements.
static final 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 final 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 final ca.uhn.fhir.rest.gclient.ReferenceClientParam	LOCATION	Fluent Client search parameter constant for location
static final ca.uhn.fhir.rest.gclient.DateClientParam	LOCATION_PERIOD	Fluent Client search parameter constant for location-period
static final 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 final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PARTICIPANT	Fluent Client search parameter constant for participant
static final 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).
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).)
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected Period	period	The start and end time of the encounter.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PRACTITIONER	Fluent Client search parameter constant for practitioner
protected CodeableConcept	priority	Indicates the urgency of the encounter.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	REASON_CODE	Fluent Client search parameter constant for reason-code
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	REASON_REFERENCE	Fluent Client search parameter constant for reason-reference
protected List<CodeableConcept>	reasonCode	Reason the encounter takes place, expressed as a code.
protected List<Reference>	reasonReference	Reason the encounter takes place, expressed as a code.
protected List<Resource>	reasonReferenceTarget	The actual objects that are the target of the reference (Reason the encounter takes place, expressed as a code.
static final 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 Organization	serviceProviderTarget	The actual object that is the target of the reference (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 final String	SP_ACCOUNT	Search parameter: account
static final String	SP_APPOINTMENT	Search parameter: appointment
static final String	SP_BASED_ON	Search parameter: based-on
static final String	SP_CLASS	Search parameter: class
static final String	SP_DATE	Search parameter: date
static final String	SP_DIAGNOSIS	Search parameter: diagnosis
static final String	SP_EPISODE_OF_CARE	Search parameter: episode-of-care
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_LENGTH	Search parameter: length
static final String	SP_LOCATION	Search parameter: location
static final String	SP_LOCATION_PERIOD	Search parameter: location-period
static final String	SP_PART_OF	Search parameter: part-of
static final String	SP_PARTICIPANT	Search parameter: participant
static final String	SP_PARTICIPANT_TYPE	Search parameter: participant-type
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_PRACTITIONER	Search parameter: practitioner
static final String	SP_REASON_CODE	Search parameter: reason-code
static final String	SP_REASON_REFERENCE	Search parameter: reason-reference
static final String	SP_SERVICE_PROVIDER	Search parameter: service-provider
static final String	SP_SPECIAL_ARRANGEMENT	Search parameter: special-arrangement
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUBJECT	Search parameter: subject
static final String	SP_TYPE	Search parameter: type
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SPECIAL_ARRANGEMENT	Fluent Client search parameter constant for special-arrangement
protected Enumeration<Encounter.EncounterStatus>	status	planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
static final 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 final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject
protected Resource	subjectTarget	The actual object that is the target of the reference (The patient or group present at the encounter.)
protected List<CodeableConcept>	type	Specific type of encounter (e.g.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TYPE	Fluent Client search parameter constant for type

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, SP_RES_ID

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Encounter()	Constructor
Encounter(Enumeration<Encounter.EncounterStatus> status, Coding class_)	Constructor

Method Summary

Modifier and Type	Method	Description
Reference	addAccount()
Encounter	addAccount(Reference t)
Account	addAccountTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Reference	addAppointment()
Encounter	addAppointment(Reference t)
Appointment	addAppointmentTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Reference	addBasedOn()
Encounter	addBasedOn(Reference t)
ServiceRequest	addBasedOnTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
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)
EpisodeOfCare	addEpisodeOfCareTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Identifier	addIdentifier()
Encounter	addIdentifier(Identifier t)
Encounter.EncounterLocationComponent	addLocation()
Encounter	addLocation(Encounter.EncounterLocationComponent t)
Encounter.EncounterParticipantComponent	addParticipant()
Encounter	addParticipant(Encounter.EncounterParticipantComponent t)
CodeableConcept	addReasonCode()
Encounter	addReasonCode(CodeableConcept t)
Reference	addReasonReference()
Encounter	addReasonReference(Reference 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()
List<Account>	getAccountTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<Reference>	getAppointment()
Reference	getAppointmentFirstRep()
List<Appointment>	getAppointmentTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<Reference>	getBasedOn()
Reference	getBasedOnFirstRep()
List<ServiceRequest>	getBasedOnTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Coding	getClass_()
List<Encounter.ClassHistoryComponent>	getClassHistory()
Encounter.ClassHistoryComponent	getClassHistoryFirstRep()
List<Encounter.DiagnosisComponent>	getDiagnosis()
Encounter.DiagnosisComponent	getDiagnosisFirstRep()
List<Reference>	getEpisodeOfCare()
Reference	getEpisodeOfCareFirstRep()
List<EpisodeOfCare>	getEpisodeOfCareTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
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()
Encounter	getPartOfTarget()
Period	getPeriod()
CodeableConcept	getPriority()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<CodeableConcept>	getReasonCode()
CodeableConcept	getReasonCodeFirstRep()
List<Reference>	getReasonReference()
Reference	getReasonReferenceFirstRep()
List<Resource>	getReasonReferenceTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
ResourceType	getResourceType()
Reference	getServiceProvider()
Organization	getServiceProviderTarget()
CodeableConcept	getServiceType()
Encounter.EncounterStatus	getStatus()
Enumeration<Encounter.EncounterStatus>	getStatusElement()
List<Encounter.StatusHistoryComponent>	getStatusHistory()
Encounter.StatusHistoryComponent	getStatusHistoryFirstRep()
Reference	getSubject()
Resource	getSubjectTarget()
List<CodeableConcept>	getType()
CodeableConcept	getTypeFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAccount()
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	hasPeriod()
boolean	hasPriority()
boolean	hasReasonCode()
boolean	hasReasonReference()
boolean	hasServiceProvider()
boolean	hasServiceType()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasStatusHistory()
boolean	hasSubject()
boolean	hasType()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
Encounter	setAccount(List<Reference> theAccount)
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	setPartOfTarget(Encounter value)
Encounter	setPeriod(Period value)
Encounter	setPriority(CodeableConcept value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Encounter	setReasonCode(List<CodeableConcept> theReasonCode)
Encounter	setReasonReference(List<Reference> theReasonReference)
Encounter	setServiceProvider(Reference value)
Encounter	setServiceProviderTarget(Organization 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	setSubjectTarget(Resource value)
Encounter	setType(List<CodeableConcept> theType)
protected Encounter	typedCopy()

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

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

copyValues, getId, getIdBase, getIdElement, getIdPart, 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.r4.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, 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, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

Identifier(s) by which this encounter is known.

status

protected Enumeration<Encounter.EncounterStatus> status

planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

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.

subjectTarget

protected Resource subjectTarget

The actual object that is the target of the reference (The patient or group 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).)

basedOn

protected List<Reference> basedOn

The request this encounter satisfies (e.g. incoming referral or procedure request).

basedOnTarget

protected List<ServiceRequest> basedOnTarget

The actual objects that are the target of the reference (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.

appointmentTarget

protected List<Appointment> appointmentTarget

The actual objects that are 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.

reasonCode

protected List<CodeableConcept> reasonCode

Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

reasonReference

protected List<Reference> reasonReference

Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

reasonReferenceTarget

protected List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Reason the encounter takes place, expressed as a code. 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.

accountTarget

protected List<Account> accountTarget

The actual objects that are the target of the reference (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.

serviceProviderTarget

protected Organization serviceProviderTarget

The actual object that is the target of the reference (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).

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

Search parameter: 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_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Identifier(s) by which this encounter is known
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: Identifier(s) by which this encounter is known
Type: token
Path: Encounter.identifier

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_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.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: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.individual

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_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_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_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_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_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_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_TYPE

public static final String SP_TYPE

Search parameter: type

Description: Specific type of encounter
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: Specific type of encounter
Type: token
Path: Encounter.type

SP_REASON_CODE

public static final String SP_REASON_CODE

Search parameter: reason-code

Description: Coded reason the encounter takes place
Type: token
Path: Encounter.reasonCode

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: Coded reason the encounter takes place
Type: token
Path: Encounter.reasonCode

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.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: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.individual

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_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_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: The patient or group present at the encounter
Type: reference
Path: Encounter.subject

See Also:

• Constant Field Values

PATIENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: The patient or group present at the encounter
Type: reference
Path: Encounter.subject

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_REASON_REFERENCE

public static final String SP_REASON_REFERENCE

Search parameter: reason-reference

Description: Reason the encounter takes place (reference)
Type: reference
Path: Encounter.reasonReference

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: Reason the encounter takes place (reference)
Type: reference
Path: Encounter.reasonReference

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_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_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_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_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_STATUS

public static final String SP_STATUS

Search parameter: status

Description: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
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 | arrived | triaged | in-progress | onleave | finished | cancelled +
Type: token
Path: Encounter.status

Constructor Details

Encounter

public Encounter()

Constructor

Encounter

public Encounter(Enumeration<Encounter.EncounterStatus> status,
 Coding class_)

Constructor

Method Details

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

getStatusElement

public Enumeration<Encounter.EncounterStatus> getStatusElement()

Returns:

status (planned | arrived | triaged | 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.EncounterStatus> value)

Parameters:

value - status (planned | arrived | triaged | 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.EncounterStatus getStatus()

Returns:

planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

setStatus

public Encounter setStatus(Encounter.EncounterStatus value)

Parameters:

value - planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

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

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

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

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

getSubjectTarget

public Resource getSubjectTarget()

Returns:

subject 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 or group present at the encounter.)

setSubjectTarget

public Encounter setSubjectTarget(Resource value)

Parameters:

value - subject 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 or group 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).)

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

getEpisodeOfCareTarget

@Deprecated
public List<EpisodeOfCare> getEpisodeOfCareTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addEpisodeOfCareTarget

@Deprecated
public EpisodeOfCare addEpisodeOfCareTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

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

getBasedOnTarget

@Deprecated
public List<ServiceRequest> getBasedOnTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addBasedOnTarget

@Deprecated
public ServiceRequest addBasedOnTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

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

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

getAppointmentTarget

@Deprecated
public List<Appointment> getAppointmentTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addAppointmentTarget

@Deprecated
public Appointment addAppointmentTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

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

getReasonCode

public List<CodeableConcept> getReasonCode()

Returns:

reasonCode (Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.)

setReasonCode

public Encounter setReasonCode(List<CodeableConcept> theReasonCode)

Returns:

Returns a reference to this for easy method chaining

hasReasonCode

public boolean hasReasonCode()

addReasonCode

public CodeableConcept addReasonCode()

addReasonCode

public Encounter addReasonCode(CodeableConcept t)

getReasonCodeFirstRep

public CodeableConcept getReasonCodeFirstRep()

Returns:

The first repetition of repeating field reasonCode, creating it if it does not already exist

getReasonReference

public List<Reference> getReasonReference()

Returns:

reasonReference (Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.)

setReasonReference

public Encounter setReasonReference(List<Reference> theReasonReference)

Returns:

Returns a reference to this for easy method chaining

hasReasonReference

public boolean hasReasonReference()

addReasonReference

public Reference addReasonReference()

addReasonReference

public Encounter addReasonReference(Reference t)

getReasonReferenceFirstRep

public Reference getReasonReferenceFirstRep()

Returns:

The first repetition of repeating field reasonReference, creating it if it does not already exist

getReasonReferenceTarget

@Deprecated
public List<Resource> getReasonReferenceTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

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

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

getAccountTarget

@Deprecated
public List<Account> getAccountTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addAccountTarget

@Deprecated
public Account addAccountTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

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

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

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. (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.)

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. (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).)

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