
Class 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
- See Also:
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic enumstatic classstatic classstatic enumstatic classstatic class
- 
Field SummaryFieldsModifier and TypeFieldDescriptionThe set of accounts that may be used for billing for this Encounter.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for accountThe actual objects that are the target of the reference (The set of accounts that may be used for billing for this Encounter.)The appointment that scheduled this encounter.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for appointmentprotected List<Appointment> The actual objects that are the target of the reference (The appointment that scheduled this encounter.)static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for based-onThe request this encounter satisfies (e.g. incoming referral or procedure request).protected List<ServiceRequest> The actual objects that are the target of the reference (The request this encounter satisfies (e.g. incoming referral or procedure request).)static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for classprotected CodingConcepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.protected List<Encounter.ClassHistoryComponent> The class history permits the tracking of the encounters transitions without needing to go through the resource history.static final ca.uhn.fhir.rest.gclient.DateClientParamFluent Client search parameter constant for dateprotected List<Encounter.DiagnosisComponent> The list of diagnosis relevant to this encounter.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for diagnosisstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for episode-of-careWhere a specific encounter should be classified as a part of a specific episode(s) of care this field should be used.protected List<EpisodeOfCare> The actual objects that are the target of the reference (Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used.Details about the admission to a healthcare service.protected List<Identifier> Identifier(s) by which this encounter is known.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.protected DurationQuantity of time the encounter lasted.static final ca.uhn.fhir.rest.gclient.QuantityClientParamFluent Client search parameter constant for lengthprotected List<Encounter.EncounterLocationComponent> List of locations where the patient has been during this encounter.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for locationstatic final ca.uhn.fhir.rest.gclient.DateClientParamFluent Client search parameter constant for location-periodstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for part-ofprotected List<Encounter.EncounterParticipantComponent> The list of people responsible for providing the service.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for participantstatic final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for participant-typeprotected ReferenceAnother Encounter of which this encounter is a part of (administratively or in time).protected EncounterThe actual object that is the target of the reference (Another Encounter of which this encounter is a part of (administratively or in time).)static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for patientprotected PeriodThe start and end time of the encounter.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for practitionerprotected CodeableConceptIndicates the urgency of the encounter.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for reason-codestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for reason-referenceprotected List<CodeableConcept> Reason the encounter takes place, expressed as a code.Reason the encounter takes place, expressed as a code.The actual objects that are the target of the reference (Reason the encounter takes place, expressed as a code.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for service-providerprotected ReferenceThe organization that is primarily responsible for this Encounter's services.protected OrganizationThe actual object that is the target of the reference (The organization that is primarily responsible for this Encounter's services.protected CodeableConceptBroad categorization of the service that is to be provided (e.g. cardiology).static final StringSearch parameter: accountstatic final StringSearch parameter: appointmentstatic final StringSearch parameter: based-onstatic final StringSearch parameter: classstatic final StringSearch parameter: datestatic final StringSearch parameter: diagnosisstatic final StringSearch parameter: episode-of-carestatic final StringSearch parameter: identifierstatic final StringSearch parameter: lengthstatic final StringSearch parameter: locationstatic final StringSearch parameter: location-periodstatic final StringSearch parameter: part-ofstatic final StringSearch parameter: participantstatic final StringSearch parameter: participant-typestatic final StringSearch parameter: patientstatic final StringSearch parameter: practitionerstatic final StringSearch parameter: reason-codestatic final StringSearch parameter: reason-referencestatic final StringSearch parameter: service-providerstatic final StringSearch parameter: special-arrangementstatic final StringSearch parameter: statusstatic final StringSearch parameter: subjectstatic final StringSearch parameter: typestatic final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for special-arrangementprotected Enumeration<Encounter.EncounterStatus> planned | arrived | triaged | in-progress | onleave | finished | cancelled +.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for statusprotected List<Encounter.StatusHistoryComponent> The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.protected ReferenceThe patient or group present at the encounter.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for subjectprotected ResourceThe actual object that is the target of the reference (The patient or group present at the encounter.)protected List<CodeableConcept> Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for typeFields inherited from class org.hl7.fhir.r4.model.DomainResourcecontained, extension, modifierExtension, textFields inherited from class org.hl7.fhir.r4.model.Resourceid, implicitRules, language, metaFields inherited from interface org.hl7.fhir.instance.model.api.IAnyResourceRES_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_TAGFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResourceINCLUDE_ALL, WILDCARD_ALL_SET
- 
Constructor SummaryConstructorsConstructorDescriptionConstructorEncounter(Enumeration<Encounter.EncounterStatus> status, Coding class_) Constructor
- 
Method SummaryModifier and TypeMethodDescriptionaddType()copy()voidcopyValues(Encounter dst) booleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()getNamedProperty(int _hash, String _name, boolean _checkValid) Base[]getProperty(int hash, String name, boolean checkValid) getType()String[]getTypesForProperty(int hash, String name) booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasType()booleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) voidremoveChild(String name, Base value) setAccount(List<Reference> theAccount) setAppointment(List<Reference> theAppointment) setBasedOn(List<Reference> theBasedOn) setClassHistory(List<Encounter.ClassHistoryComponent> theClassHistory) setDiagnosis(List<Encounter.DiagnosisComponent> theDiagnosis) setEpisodeOfCare(List<Reference> theEpisodeOfCare) setIdentifier(List<Identifier> theIdentifier) setLocation(List<Encounter.EncounterLocationComponent> theLocation) setParticipant(List<Encounter.EncounterParticipantComponent> theParticipant) setPartOfTarget(Encounter value) setPriority(CodeableConcept value) setProperty(int hash, String name, Base value) setProperty(String name, Base value) setReasonCode(List<CodeableConcept> theReasonCode) setReasonReference(List<Reference> theReasonReference) setServiceProvider(Reference value) setServiceType(CodeableConcept value) setStatusHistory(List<Encounter.StatusHistoryComponent> theStatusHistory) setSubject(Reference value) setSubjectTarget(Resource value) setType(List<CodeableConcept> theType) protected EncounterMethods inherited from class org.hl7.fhir.r4.model.DomainResourceaddContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, hasText, setContained, setExtension, setModifierExtension, setTextMethods inherited from class org.hl7.fhir.r4.model.ResourcecopyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetaMethods inherited from class org.hl7.fhir.r4.model.BaseResourcegetStructureFhirVersionEnum, isResource, setIdMethods inherited from class org.hl7.fhir.r4.model.BasecastToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN, setXhtmlMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResourcegetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBasegetFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResourcegetMeta, getStructureFhirVersionEnum, isDeleted, setId
- 
Field Details- 
identifierIdentifier(s) by which this encounter is known.
- 
statusplanned | arrived | triaged | in-progress | onleave | finished | cancelled +.
- 
statusHistoryThe status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
- 
class_Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
- 
classHistoryThe class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.
- 
typeSpecific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
- 
serviceTypeBroad categorization of the service that is to be provided (e.g. cardiology).
- 
priorityIndicates the urgency of the encounter.
- 
subjectThe patient or group present at the encounter.
- 
subjectTargetThe actual object that is the target of the reference (The patient or group present at the encounter.)
- 
episodeOfCareWhere 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).
- 
episodeOfCareTargetThe actual objects that are the target of the reference (Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).)
- 
basedOnThe request this encounter satisfies (e.g. incoming referral or procedure request).
- 
basedOnTargetThe actual objects that are the target of the reference (The request this encounter satisfies (e.g. incoming referral or procedure request).)
- 
participantThe list of people responsible for providing the service.
- 
appointmentThe appointment that scheduled this encounter.
- 
appointmentTargetThe actual objects that are the target of the reference (The appointment that scheduled this encounter.)
- 
periodThe start and end time of the encounter.
- 
lengthQuantity of time the encounter lasted. This excludes the time during leaves of absence.
- 
reasonCodeReason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
- 
reasonReferenceReason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
- 
reasonReferenceTargetThe actual objects that are the target of the reference (Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.)
- 
diagnosisThe list of diagnosis relevant to this encounter.
- 
accountThe set of accounts that may be used for billing for this Encounter.
- 
accountTargetThe actual objects that are the target of the reference (The set of accounts that may be used for billing for this Encounter.)
- 
hospitalizationDetails about the admission to a healthcare service.
- 
locationList of locations where the patient has been during this encounter.
- 
serviceProviderThe organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.
- 
serviceProviderTargetThe actual object that is the target of the reference (The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.)
- 
partOfAnother Encounter of which this encounter is a part of (administratively or in time).
- 
partOfTargetThe actual object that is the target of the reference (Another Encounter of which this encounter is a part of (administratively or in time).)
- 
SP_DATESearch parameter: dateDescription: A date within the period the Encounter lasted 
 Type: date
 Path: Encounter.period
 - See Also:
 
- 
DATEFluent Client search parameter constant for dateDescription: A date within the period the Encounter lasted 
 Type: date
 Path: Encounter.period
 
- 
SP_IDENTIFIERSearch parameter: identifierDescription: Identifier(s) by which this encounter is known 
 Type: token
 Path: Encounter.identifier
 - See Also:
 
- 
IDENTIFIERFluent Client search parameter constant for identifierDescription: Identifier(s) by which this encounter is known 
 Type: token
 Path: Encounter.identifier
 
- 
SP_PARTICIPANT_TYPESearch parameter: participant-typeDescription: Role of participant in encounter 
 Type: token
 Path: Encounter.participant.type
 - See Also:
 
- 
PARTICIPANT_TYPEFluent Client search parameter constant for participant-typeDescription: Role of participant in encounter 
 Type: token
 Path: Encounter.participant.type
 
- 
SP_PRACTITIONERSearch parameter: practitionerDescription: Persons involved in the encounter other than the patient 
 Type: reference
 Path: Encounter.participant.individual
 - See Also:
 
- 
PRACTITIONERFluent Client search parameter constant for practitionerDescription: Persons involved in the encounter other than the patient 
 Type: reference
 Path: Encounter.participant.individual
 
- 
INCLUDE_PRACTITIONERConstant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:practitioner".
- 
SP_SUBJECTSearch parameter: subjectDescription: The patient or group present at the encounter 
 Type: reference
 Path: Encounter.subject
 - See Also:
 
- 
SUBJECTFluent Client search parameter constant for subjectDescription: The patient or group present at the encounter 
 Type: reference
 Path: Encounter.subject
 
- 
INCLUDE_SUBJECTConstant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:subject".
- 
SP_LENGTHSearch parameter: lengthDescription: Length of encounter in days 
 Type: quantity
 Path: Encounter.length
 - See Also:
 
- 
LENGTHFluent Client search parameter constant for lengthDescription: Length of encounter in days 
 Type: quantity
 Path: Encounter.length
 
- 
SP_EPISODE_OF_CARESearch parameter: episode-of-careDescription: Episode(s) of care that this encounter should be recorded against 
 Type: reference
 Path: Encounter.episodeOfCare
 - See Also:
 
- 
EPISODE_OF_CAREFluent Client search parameter constant for episode-of-careDescription: Episode(s) of care that this encounter should be recorded against 
 Type: reference
 Path: Encounter.episodeOfCare
 
- 
INCLUDE_EPISODE_OF_CAREConstant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:episode-of-care".
- 
SP_DIAGNOSISSearch parameter: diagnosisDescription: The diagnosis or procedure relevant to the encounter 
 Type: reference
 Path: Encounter.diagnosis.condition
 - See Also:
 
- 
DIAGNOSISFluent Client search parameter constant for diagnosisDescription: The diagnosis or procedure relevant to the encounter 
 Type: reference
 Path: Encounter.diagnosis.condition
 
- 
INCLUDE_DIAGNOSISConstant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:diagnosis".
- 
SP_APPOINTMENTSearch parameter: appointmentDescription: The appointment that scheduled this encounter 
 Type: reference
 Path: Encounter.appointment
 - See Also:
 
- 
APPOINTMENTFluent Client search parameter constant for appointmentDescription: The appointment that scheduled this encounter 
 Type: reference
 Path: Encounter.appointment
 
- 
INCLUDE_APPOINTMENTConstant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:appointment".
- 
SP_PART_OFSearch parameter: part-ofDescription: Another Encounter this encounter is part of 
 Type: reference
 Path: Encounter.partOf
 - See Also:
 
- 
PART_OFFluent Client search parameter constant for part-ofDescription: Another Encounter this encounter is part of 
 Type: reference
 Path: Encounter.partOf
 
- 
INCLUDE_PART_OFConstant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:part-of".
- 
SP_TYPESearch parameter: typeDescription: Specific type of encounter 
 Type: token
 Path: Encounter.type
 - See Also:
 
- 
TYPEFluent Client search parameter constant for typeDescription: Specific type of encounter 
 Type: token
 Path: Encounter.type
 
- 
SP_REASON_CODESearch parameter: reason-codeDescription: Coded reason the encounter takes place 
 Type: token
 Path: Encounter.reasonCode
 - See Also:
 
- 
REASON_CODEFluent Client search parameter constant for reason-codeDescription: Coded reason the encounter takes place 
 Type: token
 Path: Encounter.reasonCode
 
- 
SP_PARTICIPANTSearch parameter: participantDescription: Persons involved in the encounter other than the patient 
 Type: reference
 Path: Encounter.participant.individual
 - See Also:
 
- 
PARTICIPANTFluent Client search parameter constant for participantDescription: Persons involved in the encounter other than the patient 
 Type: reference
 Path: Encounter.participant.individual
 
- 
INCLUDE_PARTICIPANTConstant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:participant".
- 
SP_BASED_ONSearch parameter: based-onDescription: The ServiceRequest that initiated this encounter 
 Type: reference
 Path: Encounter.basedOn
 - See Also:
 
- 
BASED_ONFluent Client search parameter constant for based-onDescription: The ServiceRequest that initiated this encounter 
 Type: reference
 Path: Encounter.basedOn
 
- 
INCLUDE_BASED_ONConstant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:based-on".
- 
SP_PATIENTSearch parameter: patientDescription: The patient or group present at the encounter 
 Type: reference
 Path: Encounter.subject
 - See Also:
 
- 
PATIENTFluent Client search parameter constant for patientDescription: The patient or group present at the encounter 
 Type: reference
 Path: Encounter.subject
 
- 
INCLUDE_PATIENTConstant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:patient".
- 
SP_REASON_REFERENCESearch parameter: reason-referenceDescription: Reason the encounter takes place (reference) 
 Type: reference
 Path: Encounter.reasonReference
 - See Also:
 
- 
REASON_REFERENCEFluent Client search parameter constant for reason-referenceDescription: Reason the encounter takes place (reference) 
 Type: reference
 Path: Encounter.reasonReference
 
- 
INCLUDE_REASON_REFERENCEConstant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:reason-reference".
- 
SP_LOCATION_PERIODSearch parameter: location-periodDescription: Time period during which the patient was present at the location 
 Type: date
 Path: Encounter.location.period
 - See Also:
 
- 
LOCATION_PERIODFluent Client search parameter constant for location-periodDescription: Time period during which the patient was present at the location 
 Type: date
 Path: Encounter.location.period
 
- 
SP_LOCATIONSearch parameter: locationDescription: Location the encounter takes place 
 Type: reference
 Path: Encounter.location.location
 - See Also:
 
- 
LOCATIONFluent Client search parameter constant for locationDescription: Location the encounter takes place 
 Type: reference
 Path: Encounter.location.location
 
- 
INCLUDE_LOCATIONConstant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:location".
- 
SP_SERVICE_PROVIDERSearch parameter: service-providerDescription: The organization (facility) responsible for this encounter 
 Type: reference
 Path: Encounter.serviceProvider
 - See Also:
 
- 
SERVICE_PROVIDERFluent Client search parameter constant for service-providerDescription: The organization (facility) responsible for this encounter 
 Type: reference
 Path: Encounter.serviceProvider
 
- 
INCLUDE_SERVICE_PROVIDERConstant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:service-provider".
- 
SP_SPECIAL_ARRANGEMENTSearch parameter: special-arrangementDescription: Wheelchair, translator, stretcher, etc. 
 Type: token
 Path: Encounter.hospitalization.specialArrangement
 - See Also:
 
- 
SPECIAL_ARRANGEMENTFluent Client search parameter constant for special-arrangementDescription: Wheelchair, translator, stretcher, etc. 
 Type: token
 Path: Encounter.hospitalization.specialArrangement
 
- 
SP_CLASSSearch parameter: classDescription: Classification of patient encounter 
 Type: token
 Path: Encounter.class
 - See Also:
 
- 
CLASSFluent Client search parameter constant for classDescription: Classification of patient encounter 
 Type: token
 Path: Encounter.class
 
- 
SP_ACCOUNTSearch parameter: accountDescription: The set of accounts that may be used for billing for this Encounter 
 Type: reference
 Path: Encounter.account
 - See Also:
 
- 
ACCOUNTFluent Client search parameter constant for accountDescription: The set of accounts that may be used for billing for this Encounter 
 Type: reference
 Path: Encounter.account
 
- 
INCLUDE_ACCOUNTConstant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:account".
- 
SP_STATUSSearch parameter: statusDescription: planned | arrived | triaged | in-progress | onleave | finished | cancelled + 
 Type: token
 Path: Encounter.status
 - See Also:
 
- 
STATUSFluent Client search parameter constant for statusDescription: planned | arrived | triaged | in-progress | onleave | finished | cancelled + 
 Type: token
 Path: Encounter.status
 
 
- 
- 
Constructor Details- 
Encounterpublic Encounter()Constructor
- 
EncounterConstructor
 
- 
- 
Method Details- 
getIdentifier- Returns:
- identifier(Identifier(s) by which this encounter is known.)
 
- 
setIdentifier- Returns:
- Returns a reference to thisfor easy method chaining
 
- 
hasIdentifier
- 
addIdentifier
- 
addIdentifier
- 
getIdentifierFirstRep- Returns:
- The first repetition of repeating field identifier, creating it if it does not already exist
 
- 
getStatusElement- Returns:
- status(planned | arrived | triaged | in-progress | onleave | finished | cancelled +.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
 
- 
hasStatusElement
- 
hasStatus
- 
setStatusElement- Parameters:
- value-- status(planned | arrived | triaged | in-progress | onleave | finished | cancelled +.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
 
- 
getStatus- Returns:
- planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
 
- 
setStatus- Parameters:
- value- planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
 
- 
getStatusHistory- Returns:
- statusHistory(The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.)
 
- 
setStatusHistory- Returns:
- Returns a reference to thisfor easy method chaining
 
- 
hasStatusHistory
- 
addStatusHistory
- 
addStatusHistory
- 
getStatusHistoryFirstRep- Returns:
- The first repetition of repeating field statusHistory, creating it if it does not already exist
 
- 
getClass_- Returns:
- class_(Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.)
 
- 
hasClass_
- 
setClass_- Parameters:
- value-- class_(Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.)
 
- 
getClassHistory- Returns:
- classHistory(The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.)
 
- 
setClassHistory- Returns:
- Returns a reference to thisfor easy method chaining
 
- 
hasClassHistory
- 
addClassHistory
- 
addClassHistory
- 
getClassHistoryFirstRep- Returns:
- The first repetition of repeating field classHistory, creating it if it does not already exist
 
- 
getType- Returns:
- type(Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).)
 
- 
setType- Returns:
- Returns a reference to thisfor easy method chaining
 
- 
hasType
- 
addType
- 
addType
- 
getTypeFirstRep- Returns:
- The first repetition of repeating field type, creating it if it does not already exist
 
- 
getServiceType- Returns:
- serviceType(Broad categorization of the service that is to be provided (e.g. cardiology).)
 
- 
hasServiceType
- 
setServiceType- Parameters:
- value-- serviceType(Broad categorization of the service that is to be provided (e.g. cardiology).)
 
- 
getPriority- Returns:
- priority(Indicates the urgency of the encounter.)
 
- 
hasPriority
- 
setPriority- Parameters:
- value-- priority(Indicates the urgency of the encounter.)
 
- 
getSubject- Returns:
- subject(The patient or group present at the encounter.)
 
- 
hasSubject
- 
setSubject- Parameters:
- value-- subject(The patient or group present at the encounter.)
 
- 
getSubjectTarget- Returns:
- subjectThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The patient or group present at the encounter.)
 
- 
setSubjectTarget- Parameters:
- value-- subjectThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The patient or group present at the encounter.)
 
- 
getEpisodeOfCare- 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- Returns:
- Returns a reference to thisfor easy method chaining
 
- 
hasEpisodeOfCare
- 
addEpisodeOfCare
- 
addEpisodeOfCare
- 
getEpisodeOfCareFirstRep- Returns:
- The first repetition of repeating field episodeOfCare, creating it if it does not already exist
 
- 
getBasedOn- Returns:
- basedOn(The request this encounter satisfies (e.g. incoming referral or procedure request).)
 
- 
setBasedOn- Returns:
- Returns a reference to thisfor easy method chaining
 
- 
hasBasedOn
- 
addBasedOn
- 
addBasedOn
- 
getBasedOnFirstRep- Returns:
- The first repetition of repeating field basedOn, creating it if it does not already exist
 
- 
getParticipant- Returns:
- participant(The list of people responsible for providing the service.)
 
- 
setParticipant- Returns:
- Returns a reference to thisfor easy method chaining
 
- 
hasParticipant
- 
addParticipant
- 
addParticipant
- 
getParticipantFirstRep- Returns:
- The first repetition of repeating field participant, creating it if it does not already exist
 
- 
getAppointment- Returns:
- appointment(The appointment that scheduled this encounter.)
 
- 
setAppointment- Returns:
- Returns a reference to thisfor easy method chaining
 
- 
hasAppointment
- 
addAppointment
- 
addAppointment
- 
getAppointmentFirstRep- Returns:
- The first repetition of repeating field appointment, creating it if it does not already exist
 
- 
getPeriod- Returns:
- period(The start and end time of the encounter.)
 
- 
hasPeriod
- 
setPeriod- Parameters:
- value-- period(The start and end time of the encounter.)
 
- 
getLength- Returns:
- length(Quantity of time the encounter lasted. This excludes the time during leaves of absence.)
 
- 
hasLength
- 
setLength- Parameters:
- value-- length(Quantity of time the encounter lasted. This excludes the time during leaves of absence.)
 
- 
getReasonCode- Returns:
- reasonCode(Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.)
 
- 
setReasonCode- Returns:
- Returns a reference to thisfor easy method chaining
 
- 
hasReasonCode
- 
addReasonCode
- 
addReasonCode
- 
getReasonCodeFirstRep- Returns:
- The first repetition of repeating field reasonCode, creating it if it does not already exist
 
- 
getReasonReference- Returns:
- reasonReference(Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.)
 
- 
setReasonReference- Returns:
- Returns a reference to thisfor easy method chaining
 
- 
hasReasonReference
- 
addReasonReference
- 
addReasonReference
- 
getReasonReferenceFirstRep- Returns:
- The first repetition of repeating field reasonReference, creating it if it does not already exist
 
- 
getDiagnosis- Returns:
- diagnosis(The list of diagnosis relevant to this encounter.)
 
- 
setDiagnosis- Returns:
- Returns a reference to thisfor easy method chaining
 
- 
hasDiagnosis
- 
addDiagnosis
- 
addDiagnosis
- 
getDiagnosisFirstRep- Returns:
- The first repetition of repeating field diagnosis, creating it if it does not already exist
 
- 
getAccount- Returns:
- account(The set of accounts that may be used for billing for this Encounter.)
 
- 
setAccount- Returns:
- Returns a reference to thisfor easy method chaining
 
- 
hasAccount
- 
addAccount
- 
addAccount
- 
getAccountFirstRep- Returns:
- The first repetition of repeating field account, creating it if it does not already exist
 
- 
getHospitalization- Returns:
- hospitalization(Details about the admission to a healthcare service.)
 
- 
hasHospitalization
- 
setHospitalization- Parameters:
- value-- hospitalization(Details about the admission to a healthcare service.)
 
- 
getLocation- Returns:
- location(List of locations where the patient has been during this encounter.)
 
- 
setLocation- Returns:
- Returns a reference to thisfor easy method chaining
 
- 
hasLocation
- 
addLocation
- 
addLocation
- 
getLocationFirstRep- Returns:
- The first repetition of repeating field location, creating it if it does not already exist
 
- 
getServiceProvider- Returns:
- serviceProvider(The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.)
 
- 
hasServiceProvider
- 
setServiceProvider- Parameters:
- value-- serviceProvider(The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.)
 
- 
getServiceProviderTarget- Returns:
- serviceProviderThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.)
 
- 
setServiceProviderTarget- Parameters:
- value-- serviceProviderThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.)
 
- 
getPartOf- Returns:
- partOf(Another Encounter of which this encounter is a part of (administratively or in time).)
 
- 
hasPartOf
- 
setPartOf- Parameters:
- value-- partOf(Another Encounter of which this encounter is a part of (administratively or in time).)
 
- 
getPartOfTarget- Returns:
- partOfThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Another Encounter of which this encounter is a part of (administratively or in time).)
 
- 
setPartOfTarget- Parameters:
- value-- partOfThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Another Encounter of which this encounter is a part of (administratively or in time).)
 
- 
listChildren- Overrides:
- listChildrenin class- DomainResource
 
- 
getNamedPropertypublic Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
- getNamedPropertyin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
getPropertypublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
- getPropertyin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
setPropertypublic Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
- setPropertyin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
setProperty- Overrides:
- setPropertyin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
removeChild- Overrides:
- removeChildin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
makeProperty- Overrides:
- makePropertyin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
getTypesForPropertypublic String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
- getTypesForPropertyin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
addChild- Overrides:
- addChildin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
fhirType- Specified by:
- fhirTypein interface- org.hl7.fhir.instance.model.api.IBase
- Overrides:
- fhirTypein class- DomainResource
 
- 
copy- Specified by:
- copyin class- DomainResource
 
- 
copyValues
- 
typedCopy
- 
equalsDeep- Overrides:
- equalsDeepin class- DomainResource
 
- 
equalsShallow- Overrides:
- equalsShallowin class- DomainResource
 
- 
isEmpty- Specified by:
- isEmptyin interface- org.hl7.fhir.instance.model.api.IBase
- Overrides:
- isEmptyin class- DomainResource
 
- 
getResourceType- Specified by:
- getResourceTypein class- Resource
 
 
-