Package org.hl7.fhir.r5.model

Class Encounter

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.Encounter

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class Encounter
extends DomainResource

An interaction between healthcare provider(s), and/or patient(s) for the purpose of providing healthcare service(s) or assessing the health status of patient(s).

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Encounter.DiagnosisComponent
static class	Encounter.EncounterAdmissionComponent
static class	Encounter.EncounterLocationComponent
static enum	Encounter.EncounterLocationStatus
static class	Encounter.EncounterLocationStatusEnumFactory
static class	Encounter.EncounterParticipantComponent
static class	Encounter.ReasonComponent

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

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 Period	actualPeriod	The actual start and end time of the encounter.
protected Encounter.EncounterAdmissionComponent	admission	Details about the stay during which a healthcare service is provided.
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
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<Reference>	careTeam	The group(s) of individuals, organizations that are allocated to participate in this encounter.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	CARETEAM	Fluent Client search parameter constant for careteam
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CLASS	Fluent Client search parameter constant for class
protected List<CodeableConcept>	class_	Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE_START	Fluent Client search parameter constant for date-start
protected List<Encounter.DiagnosisComponent>	diagnosis	The list of diagnosis relevant to this encounter.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	DIAGNOSIS_CODE	Fluent Client search parameter constant for diagnosis-code
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DIAGNOSIS_REFERENCE	Fluent Client search parameter constant for diagnosis-reference
protected List<CodeableConcept>	dietPreference	Diet preferences reported by the patient.
static final ca.uhn.fhir.rest.gclient.DateClientParam	END_DATE	Fluent Client search parameter constant for end-date
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<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_CARETEAM	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_DIAGNOSIS_REFERENCE	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	Actual 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.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).
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected DateTimeType	plannedEndDate	The planned end date/time (or discharge date) of the encounter.
protected DateTimeType	plannedStartDate	The planned start date/time (or admission date) of the encounter.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PRACTITIONER	Fluent Client search parameter constant for practitioner
protected CodeableConcept	priority	Indicates the urgency of the encounter.
protected List<Encounter.ReasonComponent>	reason	The list of medical reasons that are expected to be addressed during the episode of care.
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
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 List<CodeableReference>	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_CARETEAM	Search parameter: careteam
static final String	SP_CLASS	Search parameter: class
static final String	SP_DATE	Search parameter: date
static final String	SP_DATE_START	Search parameter: date-start
static final String	SP_DIAGNOSIS_CODE	Search parameter: diagnosis-code
static final String	SP_DIAGNOSIS_REFERENCE	Search parameter: diagnosis-reference
static final String	SP_END_DATE	Search parameter: end-date
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_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_SUBJECT_STATUS	Search parameter: subject-status
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 List<CodeableConcept>	specialArrangement	Any special requests that have been made for this encounter, such as the provision of specific equipment or other things.
protected List<CodeableConcept>	specialCourtesy	Special courtesies that may be provided to the patient during the encounter (VIP, board member, professional courtesy).
protected Enumeration<Enumerations.EncounterStatus>	status	The current state of the encounter (not the state of the patient within the encounter - that is subjectState).
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected Reference	subject	The patient or group related to this encounter.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SUBJECT_STATUS	Fluent Client search parameter constant for subject-status
protected CodeableConcept	subjectStatus	The subjectStatus value can be used to track the patient's status within the encounter.
protected List<CodeableConcept>	type	Specific type of encounter (e.g.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TYPE	Fluent Client search parameter constant for type
protected List<VirtualServiceDetail>	virtualService	Connection details of a virtual service (e.g.

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

contained, extension, modifierExtension, SP_TEXT, text, TEXT

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

id, implicitRules, language, meta

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

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Encounter()	Constructor
Encounter(Enumerations.EncounterStatus status)	Constructor

Method Summary

Modifier and Type	Method	Description
Reference	addAccount()
Encounter	addAccount(Reference t)
Reference	addAppointment()
Encounter	addAppointment(Reference t)
Reference	addBasedOn()
Encounter	addBasedOn(Reference t)
Reference	addCareTeam()
Encounter	addCareTeam(Reference t)
Base	addChild(String name)
CodeableConcept	addClass_()
Encounter	addClass_(CodeableConcept t)
Encounter.DiagnosisComponent	addDiagnosis()
Encounter	addDiagnosis(Encounter.DiagnosisComponent t)
CodeableConcept	addDietPreference()
Encounter	addDietPreference(CodeableConcept t)
Reference	addEpisodeOfCare()
Encounter	addEpisodeOfCare(Reference t)
Identifier	addIdentifier()
Encounter	addIdentifier(Identifier t)
Encounter.EncounterLocationComponent	addLocation()
Encounter	addLocation(Encounter.EncounterLocationComponent t)
Encounter.EncounterParticipantComponent	addParticipant()
Encounter	addParticipant(Encounter.EncounterParticipantComponent t)
Encounter.ReasonComponent	addReason()
Encounter	addReason(Encounter.ReasonComponent t)
CodeableReference	addServiceType()
Encounter	addServiceType(CodeableReference t)
CodeableConcept	addSpecialArrangement()
Encounter	addSpecialArrangement(CodeableConcept t)
CodeableConcept	addSpecialCourtesy()
Encounter	addSpecialCourtesy(CodeableConcept t)
CodeableConcept	addType()
Encounter	addType(CodeableConcept t)
VirtualServiceDetail	addVirtualService()
Encounter	addVirtualService(VirtualServiceDetail t)
Encounter	copy()
void	copyValues(Encounter dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<Reference>	getAccount()
Reference	getAccountFirstRep()
Period	getActualPeriod()
Encounter.EncounterAdmissionComponent	getAdmission()
List<Reference>	getAppointment()
Reference	getAppointmentFirstRep()
List<Reference>	getBasedOn()
Reference	getBasedOnFirstRep()
List<Reference>	getCareTeam()
Reference	getCareTeamFirstRep()
List<CodeableConcept>	getClass_()
CodeableConcept	getClass_FirstRep()
List<Encounter.DiagnosisComponent>	getDiagnosis()
Encounter.DiagnosisComponent	getDiagnosisFirstRep()
List<CodeableConcept>	getDietPreference()
CodeableConcept	getDietPreferenceFirstRep()
List<Reference>	getEpisodeOfCare()
Reference	getEpisodeOfCareFirstRep()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
Duration	getLength()
List<Encounter.EncounterLocationComponent>	getLocation()
Encounter.EncounterLocationComponent	getLocationFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Encounter.EncounterParticipantComponent>	getParticipant()
Encounter.EncounterParticipantComponent	getParticipantFirstRep()
Reference	getPartOf()
Date	getPlannedEndDate()
DateTimeType	getPlannedEndDateElement()
Date	getPlannedStartDate()
DateTimeType	getPlannedStartDateElement()
CodeableConcept	getPriority()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<Encounter.ReasonComponent>	getReason()
Encounter.ReasonComponent	getReasonFirstRep()
ResourceType	getResourceType()
Reference	getServiceProvider()
List<CodeableReference>	getServiceType()
CodeableReference	getServiceTypeFirstRep()
List<CodeableConcept>	getSpecialArrangement()
CodeableConcept	getSpecialArrangementFirstRep()
List<CodeableConcept>	getSpecialCourtesy()
CodeableConcept	getSpecialCourtesyFirstRep()
Enumerations.EncounterStatus	getStatus()
Enumeration<Enumerations.EncounterStatus>	getStatusElement()
Reference	getSubject()
CodeableConcept	getSubjectStatus()
List<CodeableConcept>	getType()
CodeableConcept	getTypeFirstRep()
String[]	getTypesForProperty(int hash, String name)
List<VirtualServiceDetail>	getVirtualService()
VirtualServiceDetail	getVirtualServiceFirstRep()
boolean	hasAccount()
boolean	hasActualPeriod()
boolean	hasAdmission()
boolean	hasAppointment()
boolean	hasBasedOn()
boolean	hasCareTeam()
boolean	hasClass_()
boolean	hasDiagnosis()
boolean	hasDietPreference()
boolean	hasEpisodeOfCare()
boolean	hasIdentifier()
boolean	hasLength()
boolean	hasLocation()
boolean	hasParticipant()
boolean	hasPartOf()
boolean	hasPlannedEndDate()
boolean	hasPlannedEndDateElement()
boolean	hasPlannedStartDate()
boolean	hasPlannedStartDateElement()
boolean	hasPriority()
boolean	hasReason()
boolean	hasServiceProvider()
boolean	hasServiceType()
boolean	hasSpecialArrangement()
boolean	hasSpecialCourtesy()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	hasSubjectStatus()
boolean	hasType()
boolean	hasVirtualService()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Encounter	setAccount(List<Reference> theAccount)
Encounter	setActualPeriod(Period value)
Encounter	setAdmission(Encounter.EncounterAdmissionComponent value)
Encounter	setAppointment(List<Reference> theAppointment)
Encounter	setBasedOn(List<Reference> theBasedOn)
Encounter	setCareTeam(List<Reference> theCareTeam)
Encounter	setClass_(List<CodeableConcept> theClass_)
Encounter	setDiagnosis(List<Encounter.DiagnosisComponent> theDiagnosis)
Encounter	setDietPreference(List<CodeableConcept> theDietPreference)
Encounter	setEpisodeOfCare(List<Reference> theEpisodeOfCare)
Encounter	setIdentifier(List<Identifier> theIdentifier)
Encounter	setLength(Duration value)
Encounter	setLocation(List<Encounter.EncounterLocationComponent> theLocation)
Encounter	setParticipant(List<Encounter.EncounterParticipantComponent> theParticipant)
Encounter	setPartOf(Reference value)
Encounter	setPlannedEndDate(Date value)
Encounter	setPlannedEndDateElement(DateTimeType value)
Encounter	setPlannedStartDate(Date value)
Encounter	setPlannedStartDateElement(DateTimeType value)
Encounter	setPriority(CodeableConcept value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Encounter	setReason(List<Encounter.ReasonComponent> theReason)
Encounter	setServiceProvider(Reference value)
Encounter	setServiceType(List<CodeableReference> theServiceType)
Encounter	setSpecialArrangement(List<CodeableConcept> theSpecialArrangement)
Encounter	setSpecialCourtesy(List<CodeableConcept> theSpecialCourtesy)
Encounter	setStatus(Enumerations.EncounterStatus value)
Encounter	setStatusElement(Enumeration<Enumerations.EncounterStatus> value)
Encounter	setSubject(Reference value)
Encounter	setSubjectStatus(CodeableConcept value)
Encounter	setType(List<CodeableConcept> theType)
Encounter	setVirtualService(List<VirtualServiceDetail> theVirtualService)
protected Encounter	typedCopy()

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

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

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

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

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

getStructureFhirVersionEnum, isResource, setId

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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<Enumerations.EncounterStatus> status

The current state of the encounter (not the state of the patient within the encounter - that is subjectState).

class_

protected List<CodeableConcept> class_

Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

priority

protected CodeableConcept priority

Indicates the urgency of the encounter.

type

protected List<CodeableConcept> type

Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

serviceType

protected List<CodeableReference> serviceType

Broad categorization of the service that is to be provided (e.g. cardiology).

subject

protected Reference subject

The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.

subjectStatus

protected CodeableConcept subjectStatus

The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.

episodeOfCare

protected List<Reference> episodeOfCare

Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).

basedOn

protected List<Reference> basedOn

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

careTeam

protected List<Reference> careTeam

The group(s) of individuals, organizations that are allocated to participate in this encounter. The participants backbone will record the actuals of when these individuals participated during the encounter.

partOf

protected Reference partOf

Another Encounter of which this encounter is a part of (administratively or in time).

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 colonoscopy example on the Encounter examples tab.

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.

virtualService

protected List<VirtualServiceDetail> virtualService

Connection details of a virtual service (e.g. conference call).

actualPeriod

protected Period actualPeriod

The actual start and end time of the encounter.

plannedStartDate

protected DateTimeType plannedStartDate

The planned start date/time (or admission date) of the encounter.

plannedEndDate

protected DateTimeType plannedEndDate

The planned end date/time (or discharge date) of the encounter.

length

protected Duration length

Actual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values.

reason

protected List<Encounter.ReasonComponent> reason

The list of medical reasons that are expected to be addressed during the episode of care.

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.

dietPreference

protected List<CodeableConcept> dietPreference

Diet preferences reported by the patient.

specialArrangement

protected List<CodeableConcept> specialArrangement

Any special requests that have been made for this encounter, such as the provision of specific equipment or other things.

specialCourtesy

protected List<CodeableConcept> specialCourtesy

Special courtesies that may be provided to the patient during the encounter (VIP, board member, professional courtesy).

admission

protected Encounter.EncounterAdmissionComponent admission

Details about the stay during which a healthcare service is provided. This does not describe the event of admitting the patient, but rather any information that is relevant from the time of admittance until the time of discharge.

location

protected List<Encounter.EncounterLocationComponent> location

List of locations where the patient has been during this encounter.

SP_ACCOUNT

public static final String SP_ACCOUNT

Search parameter: account

Description: The set of accounts that may be used for billing for this Encounter
Type: reference
Path: Encounter.account

See Also:

• Constant Field Values

ACCOUNT

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

Fluent Client search parameter constant for account

Description: The set of accounts that may be used for billing for this Encounter
Type: reference
Path: Encounter.account

INCLUDE_ACCOUNT

public static final ca.uhn.fhir.model.api.Include INCLUDE_ACCOUNT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:account".

SP_APPOINTMENT

public static final String SP_APPOINTMENT

Search parameter: appointment

Description: The appointment that scheduled this encounter
Type: reference
Path: Encounter.appointment

See Also:

• Constant Field Values

APPOINTMENT

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

Fluent Client search parameter constant for appointment

Description: The appointment that scheduled this encounter
Type: reference
Path: Encounter.appointment

INCLUDE_APPOINTMENT

public static final ca.uhn.fhir.model.api.Include INCLUDE_APPOINTMENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:appointment".

SP_BASED_ON

public static final String SP_BASED_ON

Search parameter: based-on

Description: The ServiceRequest that initiated this encounter
Type: reference
Path: Encounter.basedOn

See Also:

• Constant Field Values

BASED_ON

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

Fluent Client search parameter constant for based-on

Description: The ServiceRequest that initiated this encounter
Type: reference
Path: Encounter.basedOn

INCLUDE_BASED_ON

public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON

Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:based-on".

SP_CARETEAM

public static final String SP_CARETEAM

Search parameter: careteam

Description: Careteam allocated to participate in the encounter
Type: reference
Path: Encounter.careTeam

See Also:

• Constant Field Values

CARETEAM

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

Fluent Client search parameter constant for careteam

Description: Careteam allocated to participate in the encounter
Type: reference
Path: Encounter.careTeam

INCLUDE_CARETEAM

public static final ca.uhn.fhir.model.api.Include INCLUDE_CARETEAM

Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:careteam".

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_DATE_START

public static final String SP_DATE_START

Search parameter: date-start

Description: The actual start date of the Encounter
Type: date
Path: Encounter.actualPeriod.start

See Also:

• Constant Field Values

DATE_START

public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE_START

Fluent Client search parameter constant for date-start

Description: The actual start date of the Encounter
Type: date
Path: Encounter.actualPeriod.start

SP_DIAGNOSIS_CODE

public static final String SP_DIAGNOSIS_CODE

Search parameter: diagnosis-code

Description: The diagnosis or procedure relevant to the encounter (coded)
Type: token
Path: Encounter.diagnosis.condition.concept

See Also:

• Constant Field Values

DIAGNOSIS_CODE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam DIAGNOSIS_CODE

Fluent Client search parameter constant for diagnosis-code

Description: The diagnosis or procedure relevant to the encounter (coded)
Type: token
Path: Encounter.diagnosis.condition.concept

SP_DIAGNOSIS_REFERENCE

public static final String SP_DIAGNOSIS_REFERENCE

Search parameter: diagnosis-reference

Description: The diagnosis or procedure relevant to the encounter (resource reference)
Type: reference
Path: Encounter.diagnosis.condition.reference

See Also:

• Constant Field Values

DIAGNOSIS_REFERENCE

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

Fluent Client search parameter constant for diagnosis-reference

Description: The diagnosis or procedure relevant to the encounter (resource reference)
Type: reference
Path: Encounter.diagnosis.condition.reference

INCLUDE_DIAGNOSIS_REFERENCE

public static final ca.uhn.fhir.model.api.Include INCLUDE_DIAGNOSIS_REFERENCE

Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:diagnosis-reference".

SP_END_DATE

public static final String SP_END_DATE

Search parameter: end-date

Description: The actual end date of the Encounter
Type: date
Path: Encounter.actualPeriod.end

See Also:

• Constant Field Values

END_DATE

public static final ca.uhn.fhir.rest.gclient.DateClientParam END_DATE

Fluent Client search parameter constant for end-date

Description: The actual end date of the Encounter
Type: date
Path: Encounter.actualPeriod.end

SP_EPISODE_OF_CARE

public static final String SP_EPISODE_OF_CARE

Search parameter: episode-of-care

Description: Episode(s) of care that this encounter should be recorded against
Type: reference
Path: Encounter.episodeOfCare

See Also:

• Constant Field Values

EPISODE_OF_CARE

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

Fluent Client search parameter constant for episode-of-care

Description: Episode(s) of care that this encounter should be recorded against
Type: reference
Path: Encounter.episodeOfCare

INCLUDE_EPISODE_OF_CARE

public static final ca.uhn.fhir.model.api.Include INCLUDE_EPISODE_OF_CARE

Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:episode-of-care".

SP_LENGTH

public static final String SP_LENGTH

Search parameter: length

Description: Length of encounter in days
Type: quantity
Path: Encounter.length

See Also:

• Constant Field Values

LENGTH

public static final ca.uhn.fhir.rest.gclient.QuantityClientParam LENGTH

Fluent Client search parameter constant for length

Description: Length of encounter in days
Type: quantity
Path: Encounter.length

SP_LOCATION

public static final String SP_LOCATION

Search parameter: location

Description: Location the encounter takes place
Type: reference
Path: Encounter.location.location

See Also:

• Constant Field Values

LOCATION

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

Fluent Client search parameter constant for location

Description: Location the encounter takes place
Type: reference
Path: Encounter.location.location

INCLUDE_LOCATION

public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION

Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:location".

SP_PART_OF

public static final String SP_PART_OF

Search parameter: part-of

Description: Another Encounter this encounter is part of
Type: reference
Path: Encounter.partOf

See Also:

• Constant Field Values

PART_OF

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

Fluent Client search parameter constant for part-of

Description: Another Encounter this encounter is part of
Type: reference
Path: Encounter.partOf

INCLUDE_PART_OF

public static final ca.uhn.fhir.model.api.Include INCLUDE_PART_OF

Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:part-of".

SP_PARTICIPANT_TYPE

public static final String SP_PARTICIPANT_TYPE

Search parameter: participant-type

Description: Role of participant in encounter
Type: token
Path: Encounter.participant.type

See Also:

• Constant Field Values

PARTICIPANT_TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam PARTICIPANT_TYPE

Fluent Client search parameter constant for participant-type

Description: Role of participant in encounter
Type: token
Path: Encounter.participant.type

SP_PARTICIPANT

public static final String SP_PARTICIPANT

Search parameter: participant

Description: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.actor

See Also:

• Constant Field Values

PARTICIPANT

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

Fluent Client search parameter constant for participant

Description: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.actor

INCLUDE_PARTICIPANT

public static final ca.uhn.fhir.model.api.Include INCLUDE_PARTICIPANT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:participant".

SP_PRACTITIONER

public static final String SP_PRACTITIONER

Search parameter: practitioner

Description: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.actor.where(resolve() is Practitioner)

See Also:

• Constant Field Values

PRACTITIONER

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

Fluent Client search parameter constant for practitioner

Description: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.actor.where(resolve() is Practitioner)

INCLUDE_PRACTITIONER

public static final ca.uhn.fhir.model.api.Include INCLUDE_PRACTITIONER

Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:practitioner".

SP_REASON_CODE

public static final String SP_REASON_CODE

Search parameter: reason-code

Description: Reference to a concept (coded)
Type: token
Path: Encounter.reason.value.concept

See Also:

• Constant Field Values

REASON_CODE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam REASON_CODE

Fluent Client search parameter constant for reason-code

Description: Reference to a concept (coded)
Type: token
Path: Encounter.reason.value.concept

SP_REASON_REFERENCE

public static final String SP_REASON_REFERENCE

Search parameter: reason-reference

Description: Reference to a resource (resource reference)
Type: reference
Path: Encounter.reason.value.reference

See Also:

• Constant Field Values

REASON_REFERENCE

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

Fluent Client search parameter constant for reason-reference

Description: Reference to a resource (resource reference)
Type: reference
Path: Encounter.reason.value.reference

INCLUDE_REASON_REFERENCE

public static final ca.uhn.fhir.model.api.Include INCLUDE_REASON_REFERENCE

Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:reason-reference".

SP_SERVICE_PROVIDER

public static final String SP_SERVICE_PROVIDER

Search parameter: service-provider

Description: The organization (facility) responsible for this encounter
Type: reference
Path: Encounter.serviceProvider

See Also:

• Constant Field Values

SERVICE_PROVIDER

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

Fluent Client search parameter constant for service-provider

Description: The organization (facility) responsible for this encounter
Type: reference
Path: Encounter.serviceProvider

INCLUDE_SERVICE_PROVIDER

public static final ca.uhn.fhir.model.api.Include INCLUDE_SERVICE_PROVIDER

Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:service-provider".

SP_SPECIAL_ARRANGEMENT

public static final String SP_SPECIAL_ARRANGEMENT

Search parameter: special-arrangement

Description: Wheelchair, translator, stretcher, etc.
Type: token
Path: Encounter.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.specialArrangement

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: planned | in-progress | on-hold | completed | cancelled | entered-in-error | unknown
Type: token
Path: Encounter.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: planned | in-progress | on-hold | completed | cancelled | entered-in-error | unknown
Type: token
Path: Encounter.status

SP_SUBJECT_STATUS

public static final String SP_SUBJECT_STATUS

Search parameter: subject-status

Description: The current status of the subject in relation to the Encounter
Type: token
Path: Encounter.subjectStatus

See Also:

• Constant Field Values

SUBJECT_STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam SUBJECT_STATUS

Fluent Client search parameter constant for subject-status

Description: The current status of the subject in relation to the Encounter
Type: token
Path: Encounter.subjectStatus

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

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

See Also:

• Constant Field Values

SUBJECT

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

Fluent Client search parameter constant for subject

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

INCLUDE_SUBJECT

public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:subject".

SP_DATE

public static final String SP_DATE

Search parameter: date

Description: Multiple Resources: [AdverseEvent](adverseevent.html): When the event occurred [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [Appointment](appointment.html): Appointment date/time. [AuditEvent](auditevent.html): Time when the event was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [DocumentReference](documentreference.html): When this document reference was created [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [ImmunizationEvaluation](immunizationevaluation.html): Date the evaluation was generated [ImmunizationRecommendation](immunizationrecommendation.html): Date recommendation(s) created [Invoice](invoice.html): Invoice date / posting date [List](list.html): When the list was prepared [MeasureReport](measurereport.html): The date of the measure report [NutritionIntake](nutritionintake.html): Date when patient was taking (or not taking) the medication [Observation](observation.html): Clinically relevant time/time-period for observation [Procedure](procedure.html): When the procedure occurred or is occurring [ResearchSubject](researchsubject.html): Start and end of participation [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AdverseEvent.occurrence.ofType(dateTime) | AdverseEvent.occurrence.ofType(Period) | AdverseEvent.occurrence.ofType(Timing) | AllergyIntolerance.recordedDate | (start | requestedPeriod.start).first() | AuditEvent.recorded | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.date | DiagnosticReport.effective.ofType(dateTime) | DiagnosticReport.effective.ofType(Period) | DocumentReference.date | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence.ofType(dateTime)) | ImmunizationEvaluation.date | ImmunizationRecommendation.date | Invoice.date | List.date | MeasureReport.date | NutritionIntake.occurrence.ofType(dateTime) | NutritionIntake.occurrence.ofType(Period) | Observation.effective.ofType(dateTime) | Observation.effective.ofType(Period) | Observation.effective.ofType(Timing) | Observation.effective.ofType(instant) | Procedure.occurrence.ofType(dateTime) | Procedure.occurrence.ofType(Period) | Procedure.occurrence.ofType(Timing) | ResearchSubject.period | (RiskAssessment.occurrence.ofType(dateTime)) | SupplyRequest.authoredOn

See Also:

• Constant Field Values

DATE

public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE

Fluent Client search parameter constant for date

Description: Multiple Resources: [AdverseEvent](adverseevent.html): When the event occurred [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [Appointment](appointment.html): Appointment date/time. [AuditEvent](auditevent.html): Time when the event was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [DocumentReference](documentreference.html): When this document reference was created [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [ImmunizationEvaluation](immunizationevaluation.html): Date the evaluation was generated [ImmunizationRecommendation](immunizationrecommendation.html): Date recommendation(s) created [Invoice](invoice.html): Invoice date / posting date [List](list.html): When the list was prepared [MeasureReport](measurereport.html): The date of the measure report [NutritionIntake](nutritionintake.html): Date when patient was taking (or not taking) the medication [Observation](observation.html): Clinically relevant time/time-period for observation [Procedure](procedure.html): When the procedure occurred or is occurring [ResearchSubject](researchsubject.html): Start and end of participation [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AdverseEvent.occurrence.ofType(dateTime) | AdverseEvent.occurrence.ofType(Period) | AdverseEvent.occurrence.ofType(Timing) | AllergyIntolerance.recordedDate | (start | requestedPeriod.start).first() | AuditEvent.recorded | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.date | DiagnosticReport.effective.ofType(dateTime) | DiagnosticReport.effective.ofType(Period) | DocumentReference.date | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence.ofType(dateTime)) | ImmunizationEvaluation.date | ImmunizationRecommendation.date | Invoice.date | List.date | MeasureReport.date | NutritionIntake.occurrence.ofType(dateTime) | NutritionIntake.occurrence.ofType(Period) | Observation.effective.ofType(dateTime) | Observation.effective.ofType(Period) | Observation.effective.ofType(Timing) | Observation.effective.ofType(instant) | Procedure.occurrence.ofType(dateTime) | Procedure.occurrence.ofType(Period) | Procedure.occurrence.ofType(Timing) | ResearchSubject.period | (RiskAssessment.occurrence.ofType(dateTime)) | SupplyRequest.authoredOn

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.identifier

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.patient

See Also:

• Constant Field Values

PATIENT

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

Fluent Client search parameter constant for patient

Description: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.patient

INCLUDE_PATIENT

public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:patient".

SP_TYPE

public static final String SP_TYPE

Search parameter: type

Description: Multiple Resources: [Account](account.html): E.g. patient, expense, depreciation [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known) [Composition](composition.html): Kind of composition (LOINC if possible) [Coverage](coverage.html): The kind of coverage (health plan, auto, Workers Compensation) [DocumentReference](documentreference.html): Kind of document (LOINC if possible) [Encounter](encounter.html): Specific type of encounter [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management [Invoice](invoice.html): Type of Invoice [MedicationDispense](medicationdispense.html): Returns dispenses of a specific type [MolecularSequence](molecularsequence.html): Amino Acid Sequence/ DNA Sequence / RNA Sequence [Specimen](specimen.html): The specimen type
Type: token
Path: Account.type | AllergyIntolerance.type | Composition.type | Coverage.type | DocumentReference.type | Encounter.type | EpisodeOfCare.type | Invoice.type | MedicationDispense.type | MolecularSequence.type | Specimen.type

See Also:

• Constant Field Values

TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE

Fluent Client search parameter constant for type

Description: Multiple Resources: [Account](account.html): E.g. patient, expense, depreciation [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known) [Composition](composition.html): Kind of composition (LOINC if possible) [Coverage](coverage.html): The kind of coverage (health plan, auto, Workers Compensation) [DocumentReference](documentreference.html): Kind of document (LOINC if possible) [Encounter](encounter.html): Specific type of encounter [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management [Invoice](invoice.html): Type of Invoice [MedicationDispense](medicationdispense.html): Returns dispenses of a specific type [MolecularSequence](molecularsequence.html): Amino Acid Sequence/ DNA Sequence / RNA Sequence [Specimen](specimen.html): The specimen type
Type: token
Path: Account.type | AllergyIntolerance.type | Composition.type | Coverage.type | DocumentReference.type | Encounter.type | EpisodeOfCare.type | Invoice.type | MedicationDispense.type | MolecularSequence.type | Specimen.type

Constructor Details

Encounter

public Encounter()

Constructor

Encounter

public Encounter(Enumerations.EncounterStatus status)

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 {3}

getStatusElement

public Enumeration<Enumerations.EncounterStatus> getStatusElement()

Returns:

status (The current state of the encounter (not the state of the patient within the encounter - that is subjectState).). 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<Enumerations.EncounterStatus> value)

Parameters:

value - status (The current state of the encounter (not the state of the patient within the encounter - that is subjectState).). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Enumerations.EncounterStatus getStatus()

Returns:

The current state of the encounter (not the state of the patient within the encounter - that is subjectState).

setStatus

public Encounter setStatus(Enumerations.EncounterStatus value)

Parameters:

value - The current state of the encounter (not the state of the patient within the encounter - that is subjectState).

getClass_

public List<CodeableConcept> getClass_()

Returns:

class_ (Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.)

setClass_

public Encounter setClass_(List<CodeableConcept> theClass_)

Returns:

Returns a reference to this for easy method chaining

hasClass_

public boolean hasClass_()

addClass_

public CodeableConcept addClass_()

addClass_

public Encounter addClass_(CodeableConcept t)

getClass_FirstRep

public CodeableConcept getClass_FirstRep()

Returns:

The first repetition of repeating field class_, creating it if it does not already exist {3}

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

getType

public List<CodeableConcept> getType()

Returns:

type (Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).)

setType

public Encounter setType(List<CodeableConcept> theType)

Returns:

Returns a reference to this for easy method chaining

hasType

public boolean hasType()

addType

public CodeableConcept addType()

addType

public Encounter addType(CodeableConcept t)

getTypeFirstRep

public CodeableConcept getTypeFirstRep()

Returns:

The first repetition of repeating field type, creating it if it does not already exist {3}

getServiceType

public List<CodeableReference> getServiceType()

Returns:

serviceType (Broad categorization of the service that is to be provided (e.g. cardiology).)

setServiceType

public Encounter setServiceType(List<CodeableReference> theServiceType)

Returns:

Returns a reference to this for easy method chaining

hasServiceType

public boolean hasServiceType()

addServiceType

public CodeableReference addServiceType()

addServiceType

public Encounter addServiceType(CodeableReference t)

getServiceTypeFirstRep

public CodeableReference getServiceTypeFirstRep()

Returns:

The first repetition of repeating field serviceType, creating it if it does not already exist {3}

getSubject

public Reference getSubject()

Returns:

subject (The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.)

hasSubject

public boolean hasSubject()

setSubject

public Encounter setSubject(Reference value)

Parameters:

value - subject (The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.)

getSubjectStatus

public CodeableConcept getSubjectStatus()

Returns:

subjectStatus (The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.)

hasSubjectStatus

public boolean hasSubjectStatus()

setSubjectStatus

public Encounter setSubjectStatus(CodeableConcept value)

Parameters:

value - subjectStatus (The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.)

getEpisodeOfCare

public List<Reference> getEpisodeOfCare()

Returns:

episodeOfCare (Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).)

setEpisodeOfCare

public Encounter setEpisodeOfCare(List<Reference> theEpisodeOfCare)

Returns:

Returns a reference to this for easy method chaining

hasEpisodeOfCare

public boolean hasEpisodeOfCare()

addEpisodeOfCare

public Reference addEpisodeOfCare()

addEpisodeOfCare

public Encounter addEpisodeOfCare(Reference t)

getEpisodeOfCareFirstRep

public Reference getEpisodeOfCareFirstRep()

Returns:

The first repetition of repeating field episodeOfCare, creating it if it does not already exist {3}

getBasedOn

public List<Reference> getBasedOn()

Returns:

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

setBasedOn

public Encounter setBasedOn(List<Reference> theBasedOn)

Returns:

Returns a reference to this for easy method chaining

hasBasedOn

public boolean hasBasedOn()

addBasedOn

public Reference addBasedOn()

addBasedOn

public Encounter addBasedOn(Reference t)

getBasedOnFirstRep

public Reference getBasedOnFirstRep()

Returns:

The first repetition of repeating field basedOn, creating it if it does not already exist {3}

getCareTeam

public List<Reference> getCareTeam()

Returns:

careTeam (The group(s) of individuals, organizations that are allocated to participate in this encounter. The participants backbone will record the actuals of when these individuals participated during the encounter.)

setCareTeam

public Encounter setCareTeam(List<Reference> theCareTeam)

Returns:

Returns a reference to this for easy method chaining

hasCareTeam

public boolean hasCareTeam()

addCareTeam

public Reference addCareTeam()

addCareTeam

public Encounter addCareTeam(Reference t)

getCareTeamFirstRep

public Reference getCareTeamFirstRep()

Returns:

The first repetition of repeating field careTeam, creating it if it does not already exist {3}

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

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 colonoscopy example on the Encounter examples tab.)

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 colonoscopy example on the Encounter examples tab.)

getParticipant

public List<Encounter.EncounterParticipantComponent> getParticipant()

Returns:

participant (The list of people responsible for providing the service.)

setParticipant

public Encounter setParticipant(List<Encounter.EncounterParticipantComponent> theParticipant)

Returns:

Returns a reference to this for easy method chaining

hasParticipant

public boolean hasParticipant()

addParticipant

public Encounter.EncounterParticipantComponent addParticipant()

addParticipant

public Encounter addParticipant(Encounter.EncounterParticipantComponent t)

getParticipantFirstRep

public Encounter.EncounterParticipantComponent getParticipantFirstRep()

Returns:

The first repetition of repeating field participant, creating it if it does not already exist {3}

getAppointment

public List<Reference> getAppointment()

Returns:

appointment (The appointment that scheduled this encounter.)

setAppointment

public Encounter setAppointment(List<Reference> theAppointment)

Returns:

Returns a reference to this for easy method chaining

hasAppointment

public boolean hasAppointment()

addAppointment

public Reference addAppointment()

addAppointment

public Encounter addAppointment(Reference t)

getAppointmentFirstRep

public Reference getAppointmentFirstRep()

Returns:

The first repetition of repeating field appointment, creating it if it does not already exist {3}

getVirtualService

public List<VirtualServiceDetail> getVirtualService()

Returns:

virtualService (Connection details of a virtual service (e.g. conference call).)

setVirtualService

public Encounter setVirtualService(List<VirtualServiceDetail> theVirtualService)

Returns:

Returns a reference to this for easy method chaining

hasVirtualService

public boolean hasVirtualService()

addVirtualService

public VirtualServiceDetail addVirtualService()

addVirtualService

public Encounter addVirtualService(VirtualServiceDetail t)

getVirtualServiceFirstRep

public VirtualServiceDetail getVirtualServiceFirstRep()

Returns:

The first repetition of repeating field virtualService, creating it if it does not already exist {3}

getActualPeriod

public Period getActualPeriod()

Returns:

actualPeriod (The actual start and end time of the encounter.)

hasActualPeriod

public boolean hasActualPeriod()

setActualPeriod

public Encounter setActualPeriod(Period value)

Parameters:

value - actualPeriod (The actual start and end time of the encounter.)

getPlannedStartDateElement

public DateTimeType getPlannedStartDateElement()

Returns:

plannedStartDate (The planned start date/time (or admission date) of the encounter.). This is the underlying object with id, value and extensions. The accessor "getPlannedStartDate" gives direct access to the value

hasPlannedStartDateElement

public boolean hasPlannedStartDateElement()

hasPlannedStartDate

public boolean hasPlannedStartDate()

setPlannedStartDateElement

public Encounter setPlannedStartDateElement(DateTimeType value)

Parameters:

value - plannedStartDate (The planned start date/time (or admission date) of the encounter.). This is the underlying object with id, value and extensions. The accessor "getPlannedStartDate" gives direct access to the value

getPlannedStartDate

public Date getPlannedStartDate()

Returns:

The planned start date/time (or admission date) of the encounter.

setPlannedStartDate

public Encounter setPlannedStartDate(Date value)

Parameters:

value - The planned start date/time (or admission date) of the encounter.

getPlannedEndDateElement

public DateTimeType getPlannedEndDateElement()

Returns:

plannedEndDate (The planned end date/time (or discharge date) of the encounter.). This is the underlying object with id, value and extensions. The accessor "getPlannedEndDate" gives direct access to the value

hasPlannedEndDateElement

public boolean hasPlannedEndDateElement()

hasPlannedEndDate

public boolean hasPlannedEndDate()

setPlannedEndDateElement

public Encounter setPlannedEndDateElement(DateTimeType value)

Parameters:

value - plannedEndDate (The planned end date/time (or discharge date) of the encounter.). This is the underlying object with id, value and extensions. The accessor "getPlannedEndDate" gives direct access to the value

getPlannedEndDate

public Date getPlannedEndDate()

Returns:

The planned end date/time (or discharge date) of the encounter.

setPlannedEndDate

public Encounter setPlannedEndDate(Date value)

Parameters:

value - The planned end date/time (or discharge date) of the encounter.

getLength

public Duration getLength()

Returns:

length (Actual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values.)

hasLength

public boolean hasLength()

setLength

public Encounter setLength(Duration value)

Parameters:

value - length (Actual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values.)

getReason

public List<Encounter.ReasonComponent> getReason()

Returns:

reason (The list of medical reasons that are expected to be addressed during the episode of care.)

setReason

public Encounter setReason(List<Encounter.ReasonComponent> theReason)

Returns:

Returns a reference to this for easy method chaining

hasReason

public boolean hasReason()

addReason

public Encounter.ReasonComponent addReason()

addReason

public Encounter addReason(Encounter.ReasonComponent t)

getReasonFirstRep

public Encounter.ReasonComponent getReasonFirstRep()

Returns:

The first repetition of repeating field reason, creating it if it does not already exist {3}

getDiagnosis

public List<Encounter.DiagnosisComponent> getDiagnosis()

Returns:

diagnosis (The list of diagnosis relevant to this encounter.)

setDiagnosis

public Encounter setDiagnosis(List<Encounter.DiagnosisComponent> theDiagnosis)

Returns:

Returns a reference to this for easy method chaining

hasDiagnosis

public boolean hasDiagnosis()

addDiagnosis

public Encounter.DiagnosisComponent addDiagnosis()

addDiagnosis

public Encounter addDiagnosis(Encounter.DiagnosisComponent t)

getDiagnosisFirstRep

public Encounter.DiagnosisComponent getDiagnosisFirstRep()

Returns:

The first repetition of repeating field diagnosis, creating it if it does not already exist {3}

getAccount

public List<Reference> getAccount()

Returns:

account (The set of accounts that may be used for billing for this Encounter.)

setAccount

public Encounter setAccount(List<Reference> theAccount)

Returns:

Returns a reference to this for easy method chaining

hasAccount

public boolean hasAccount()

addAccount

public Reference addAccount()

addAccount

public Encounter addAccount(Reference t)

getAccountFirstRep

public Reference getAccountFirstRep()

Returns:

The first repetition of repeating field account, creating it if it does not already exist {3}

getDietPreference

public List<CodeableConcept> getDietPreference()

Returns:

dietPreference (Diet preferences reported by the patient.)

setDietPreference

public Encounter setDietPreference(List<CodeableConcept> theDietPreference)

Returns:

Returns a reference to this for easy method chaining

hasDietPreference

public boolean hasDietPreference()

addDietPreference

public CodeableConcept addDietPreference()

addDietPreference

public Encounter addDietPreference(CodeableConcept t)

getDietPreferenceFirstRep

public CodeableConcept getDietPreferenceFirstRep()

Returns:

The first repetition of repeating field dietPreference, creating it if it does not already exist {3}

getSpecialArrangement

public List<CodeableConcept> getSpecialArrangement()

Returns:

specialArrangement (Any special requests that have been made for this encounter, such as the provision of specific equipment or other things.)

setSpecialArrangement

public Encounter setSpecialArrangement(List<CodeableConcept> theSpecialArrangement)

Returns:

Returns a reference to this for easy method chaining

hasSpecialArrangement

public boolean hasSpecialArrangement()

addSpecialArrangement

public CodeableConcept addSpecialArrangement()

addSpecialArrangement

public Encounter addSpecialArrangement(CodeableConcept t)

getSpecialArrangementFirstRep

public CodeableConcept getSpecialArrangementFirstRep()

Returns:

The first repetition of repeating field specialArrangement, creating it if it does not already exist {3}

getSpecialCourtesy

public List<CodeableConcept> getSpecialCourtesy()

Returns:

specialCourtesy (Special courtesies that may be provided to the patient during the encounter (VIP, board member, professional courtesy).)

setSpecialCourtesy

public Encounter setSpecialCourtesy(List<CodeableConcept> theSpecialCourtesy)

Returns:

Returns a reference to this for easy method chaining

hasSpecialCourtesy

public boolean hasSpecialCourtesy()

addSpecialCourtesy

public CodeableConcept addSpecialCourtesy()

addSpecialCourtesy

public Encounter addSpecialCourtesy(CodeableConcept t)

getSpecialCourtesyFirstRep

public CodeableConcept getSpecialCourtesyFirstRep()

Returns:

The first repetition of repeating field specialCourtesy, creating it if it does not already exist {3}

getAdmission

public Encounter.EncounterAdmissionComponent getAdmission()

Returns:

admission (Details about the stay during which a healthcare service is provided. This does not describe the event of admitting the patient, but rather any information that is relevant from the time of admittance until the time of discharge.)

hasAdmission

public boolean hasAdmission()

setAdmission

public Encounter setAdmission(Encounter.EncounterAdmissionComponent value)

Parameters:

value - admission (Details about the stay during which a healthcare service is provided. This does not describe the event of admitting the patient, but rather any information that is relevant from the time of admittance until the time of discharge.)

getLocation

public List<Encounter.EncounterLocationComponent> getLocation()

Returns:

location (List of locations where the patient has been during this encounter.)

setLocation

public Encounter setLocation(List<Encounter.EncounterLocationComponent> theLocation)

Returns:

Returns a reference to this for easy method chaining

hasLocation

public boolean hasLocation()

addLocation

public Encounter.EncounterLocationComponent addLocation()

addLocation

public Encounter addLocation(Encounter.EncounterLocationComponent t)

getLocationFirstRep

public Encounter.EncounterLocationComponent getLocationFirstRep()

Returns:

The first repetition of repeating field location, creating it if it does not already exist {3}

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

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild 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

Returns:

the FHIR type name of the instance (not the java class name)

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