
Package org.hl7.fhir.dstu2.model
Class Encounter
java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.BaseResource
org.hl7.fhir.dstu2.model.Resource
org.hl7.fhir.dstu2.model.DomainResource
org.hl7.fhir.dstu2.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
An interaction between a patient and healthcare provider(s) for the purpose
 of providing healthcare service(s) or assessing the health status of a
 patient.
- See Also:
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic enumstatic classstatic classstatic classstatic enumstatic classstatic classstatic enumstatic classstatic class
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected ReferenceThe appointment that scheduled this encounter.protected AppointmentThe actual object that is the target of the reference (The appointment that scheduled this encounter.)protected Enumeration<Encounter.EncounterClass> inpatient | outpatient | ambulatory | emergency +.Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used.protected List<EpisodeOfCare> 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.The referral request this encounter satisfies (incoming referral).protected List<ReferralRequest> The actual objects that are the target of the reference (The referral request this encounter satisfies (incoming referral).)Reason the encounter takes place, as specified using information from another resource.The actual objects that are the target of the reference (Reason the encounter takes place, as specified using information from another resource.protected DurationQuantity of time the encounter lasted.protected List<Encounter.EncounterLocationComponent> List of locations where the patient has been during this encounter.protected List<Encounter.EncounterParticipantComponent> The list of people responsible for providing the service.protected 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).)protected ReferenceThe patient present at the encounter.protected PatientThe actual object that is the target of the reference (The patient present at the encounter.)protected PeriodThe start and end time of the encounter.protected CodeableConceptIndicates the urgency of the encounter.protected List<CodeableConcept> Reason the encounter takes place, expressed as a code.protected ReferenceAn organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.).protected OrganizationThe actual object that is the target of the reference (An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.).static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringprotected Enumeration<Encounter.EncounterState> planned | arrived | in-progress | onleave | finished | cancelled.protected List<Encounter.EncounterStatusHistoryComponent> The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.protected List<CodeableConcept> Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).Fields inherited from class org.hl7.fhir.dstu2.model.DomainResourcecontained, extension, modifierExtension, textFields inherited from class org.hl7.fhir.dstu2.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 SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionaddType()copy()booleanequalsDeep(Base other) booleanequalsShallow(Base other) fhirType()getType()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasType()booleanisEmpty()protected voidlistChildren(List<Property> childrenList) setAppointment(Reference value) setAppointmentTarget(Appointment value) setPartOfTarget(Encounter value) setPatient(Reference value) setPatientTarget(Patient value) setPriority(CodeableConcept value) voidsetProperty(String name, Base value) setServiceProvider(Reference value) protected EncounterMethods inherited from class org.hl7.fhir.dstu2.model.DomainResourceaddContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setTextMethods inherited from class org.hl7.fhir.dstu2.model.ResourcecopyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetaMethods inherited from class org.hl7.fhir.dstu2.model.BaseResourcegetStructureFhirVersionEnum, setIdMethods inherited from class org.hl7.fhir.dstu2.model.BasecastToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINNMethods 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 | 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_inpatient | outpatient | ambulatory | emergency +.
- 
typeSpecific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
- 
priorityIndicates the urgency of the encounter.
- 
patientThe patient present at the encounter.
- 
patientTargetThe actual object that is the target of the reference (The patient 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).)
- 
incomingReferralThe referral request this encounter satisfies (incoming referral).
- 
incomingReferralTargetThe actual objects that are the target of the reference (The referral request this encounter satisfies (incoming referral).)
- 
participantThe list of people responsible for providing the service.
- 
appointmentThe appointment that scheduled this encounter.
- 
appointmentTargetThe actual object that is 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.
- 
reasonReason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
- 
indicationReason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
- 
indicationTargetThe actual objects that are the target of the reference (Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.)
- 
hospitalizationDetails about the admission to a healthcare service.
- 
locationList of locations where the patient has been during this encounter.
- 
serviceProviderAn organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.
- 
serviceProviderTargetThe actual object that is the target of the reference (An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.)
- 
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_DATE- See Also:
 
- 
SP_IDENTIFIER- See Also:
 
- 
SP_REASON- See Also:
 
- 
SP_EPISODEOFCARE- See Also:
 
- 
SP_PARTICIPANTTYPE- See Also:
 
- 
SP_INCOMINGREFERRAL- See Also:
 
- 
SP_PRACTITIONER- See Also:
 
- 
SP_LENGTH- See Also:
 
- 
SP_APPOINTMENT- See Also:
 
- 
SP_PARTOF- See Also:
 
- 
SP_PROCEDURE- See Also:
 
- 
SP_TYPE- See Also:
 
- 
SP_PARTICIPANT- See Also:
 
- 
SP_CONDITION- See Also:
 
- 
SP_PATIENT- See Also:
 
- 
SP_LOCATIONPERIOD- See Also:
 
- 
SP_LOCATION- See Also:
 
- 
SP_INDICATION- See Also:
 
- 
SP_SPECIALARRANGEMENT- See Also:
 
- 
SP_STATUS- See Also:
 
 
- 
- 
Constructor Details- 
Encounterpublic Encounter()
- 
Encounter
 
- 
- 
Method Details- 
getIdentifier- Returns:
- identifier(Identifier(s) by which this encounter is known.)
 
- 
hasIdentifier
- 
addIdentifier- Returns:
- identifier(Identifier(s) by which this encounter is known.)
 
- 
addIdentifier
- 
getStatusElement- Returns:
- status(planned | arrived | in-progress | onleave | finished | cancelled.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
 
- 
hasStatusElement
- 
hasStatus
- 
setStatusElement- Parameters:
- value-- status(planned | arrived | in-progress | onleave | finished | cancelled.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
 
- 
getStatus- Returns:
- planned | arrived | in-progress | onleave | finished | cancelled.
 
- 
setStatus- Parameters:
- value- planned | arrived | 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.)
 
- 
hasStatusHistory
- 
addStatusHistory- Returns:
- statusHistory(The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.)
 
- 
addStatusHistory
- 
getClass_Element- Returns:
- class_(inpatient | outpatient | ambulatory | emergency +.). This is the underlying object with id, value and extensions. The accessor "getClass_" gives direct access to the value
 
- 
hasClass_Element
- 
hasClass_
- 
setClass_Element- Parameters:
- value-- class_(inpatient | outpatient | ambulatory | emergency +.). This is the underlying object with id, value and extensions. The accessor "getClass_" gives direct access to the value
 
- 
getClass_- Returns:
- inpatient | outpatient | ambulatory | emergency +.
 
- 
setClass_- Parameters:
- value- inpatient | outpatient | ambulatory | emergency +.
 
- 
getType- Returns:
- type(Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).)
 
- 
hasType
- 
addType- Returns:
- type(Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).)
 
- 
addType
- 
getPriority- Returns:
- priority(Indicates the urgency of the encounter.)
 
- 
hasPriority
- 
setPriority- Parameters:
- value-- priority(Indicates the urgency of the encounter.)
 
- 
getPatient- Returns:
- patient(The patient present at the encounter.)
 
- 
hasPatient
- 
setPatient- Parameters:
- value-- patient(The patient present at the encounter.)
 
- 
getPatientTarget- Returns:
- patientThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The patient present at the encounter.)
 
- 
setPatientTarget- Parameters:
- value-- patientThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The patient present at the encounter.)
 
- 
getEpisodeOfCare- Returns:
- episodeOfCare(Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).)
 
- 
hasEpisodeOfCare
- 
addEpisodeOfCare- Returns:
- episodeOfCare(Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).)
 
- 
addEpisodeOfCare
- 
getEpisodeOfCareTarget- Returns:
- episodeOfCare(The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).)
 
- 
addEpisodeOfCareTarget- Returns:
- episodeOfCare(Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).)
 
- 
getIncomingReferral- Returns:
- incomingReferral(The referral request this encounter satisfies (incoming referral).)
 
- 
hasIncomingReferral
- 
addIncomingReferral- Returns:
- incomingReferral(The referral request this encounter satisfies (incoming referral).)
 
- 
addIncomingReferral
- 
getIncomingReferralTarget- Returns:
- incomingReferral(The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. The referral request this encounter satisfies (incoming referral).)
 
- 
addIncomingReferralTarget- Returns:
- incomingReferral(Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. The referral request this encounter satisfies (incoming referral).)
 
- 
getParticipant- Returns:
- participant(The list of people responsible for providing the service.)
 
- 
hasParticipant
- 
addParticipant- Returns:
- participant(The list of people responsible for providing the service.)
 
- 
addParticipant
- 
getAppointment- Returns:
- appointment(The appointment that scheduled this encounter.)
 
- 
hasAppointment
- 
setAppointment- Parameters:
- value-- appointment(The appointment that scheduled this encounter.)
 
- 
getAppointmentTarget- Returns:
- appointmentThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The appointment that scheduled this encounter.)
 
- 
setAppointmentTarget- Parameters:
- value-- appointmentThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The appointment that scheduled this encounter.)
 
- 
getPeriod- 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.)
 
- 
getReason- Returns:
- reason(Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.)
 
- 
hasReason
- 
addReason- Returns:
- reason(Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.)
 
- 
addReason
- 
getIndication- Returns:
- indication(Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.)
 
- 
hasIndication
- 
addIndication- Returns:
- indication(Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.)
 
- 
addIndication
- 
getIndicationTarget- Returns:
- indication(The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.)
 
- 
getHospitalization- 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.)
 
- 
hasLocation
- 
addLocation- Returns:
- location(List of locations where the patient has been during this encounter.)
 
- 
addLocation
- 
getServiceProvider- Returns:
- serviceProvider(An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.)
 
- 
hasServiceProvider
- 
setServiceProvider- Parameters:
- value-- serviceProvider(An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.)
 
- 
getServiceProviderTarget- 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. (An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.)
 
- 
setServiceProviderTarget- 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. (An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.)
 
- 
getPartOf- 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
 
- 
setProperty- Overrides:
- setPropertyin 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
 
- 
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
 
 
-