
Class Encounter
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.model.Encounter
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IAnyResource
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
,org.hl7.fhir.instance.model.api.IBaseResource
,org.hl7.fhir.instance.model.api.IDomainResource
public class Encounter extends DomainResource
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Encounter.ClassHistoryComponent
static class
Encounter.DiagnosisComponent
static class
Encounter.EncounterHospitalizationComponent
static class
Encounter.EncounterLocationComponent
static class
Encounter.EncounterLocationStatus
static class
Encounter.EncounterLocationStatusEnumFactory
static class
Encounter.EncounterParticipantComponent
static class
Encounter.EncounterStatus
static class
Encounter.EncounterStatusEnumFactory
static class
Encounter.StatusHistoryComponent
-
Field Summary
Fields Modifier and Type Field Description protected List<Reference>
account
The set of accounts that may be used for billing for this Encounter.protected List<Account>
accountTarget
The actual objects that are the target of the reference (The set of accounts that may be used for billing for this Encounter.)protected Reference
appointment
The appointment that scheduled this encounter.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
APPOINTMENT
Fluent Client search parameter constant for appointmentprotected Appointment
appointmentTarget
The actual object that is the target of the reference (The appointment that scheduled this encounter.)static ca.uhn.fhir.rest.gclient.TokenClientParam
CLASS
Fluent Client search parameter constant for classprotected Coding
class_
inpatient | outpatient | ambulatory | emergency +.protected List<Encounter.ClassHistoryComponent>
classHistory
The class history permits the tracking of the encounters transitions without needing to go through the resource history.static ca.uhn.fhir.rest.gclient.DateClientParam
DATE
Fluent Client search parameter constant for dateprotected List<Encounter.DiagnosisComponent>
diagnosis
The list of diagnosis relevant to this encounter.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
DIAGNOSIS
Fluent Client search parameter constant for diagnosisprotected 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.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
EPISODEOFCARE
Fluent Client search parameter constant for episodeofcareprotected List<EpisodeOfCare>
episodeOfCareTarget
The actual objects that are the target of the reference (Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used.protected Encounter.EncounterHospitalizationComponent
hospitalization
Details about the admission to a healthcare service.protected List<Identifier>
identifier
Identifier(s) by which this encounter is known.static ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.Include
INCLUDE_APPOINTMENT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_DIAGNOSIS
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_EPISODEOFCARE
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_INCOMINGREFERRAL
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_LOCATION
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PART_OF
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PARTICIPANT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PRACTITIONER
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_SERVICE_PROVIDER
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.protected List<Reference>
incomingReferral
The referral request this encounter satisfies (incoming referral).static ca.uhn.fhir.rest.gclient.ReferenceClientParam
INCOMINGREFERRAL
Fluent Client search parameter constant for incomingreferralprotected List<ReferralRequest>
incomingReferralTarget
The actual objects that are the target of the reference (The referral request this encounter satisfies (incoming referral).)protected Duration
length
Quantity of time the encounter lasted.static ca.uhn.fhir.rest.gclient.NumberClientParam
LENGTH
Fluent Client search parameter constant for lengthprotected List<Encounter.EncounterLocationComponent>
location
List of locations where the patient has been during this encounter.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
LOCATION
Fluent Client search parameter constant for locationstatic ca.uhn.fhir.rest.gclient.DateClientParam
LOCATION_PERIOD
Fluent Client search parameter constant for location-periodstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
PART_OF
Fluent Client search parameter constant for part-ofprotected List<Encounter.EncounterParticipantComponent>
participant
The list of people responsible for providing the service.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
PARTICIPANT
Fluent Client search parameter constant for participantstatic ca.uhn.fhir.rest.gclient.TokenClientParam
PARTICIPANT_TYPE
Fluent Client search parameter constant for participant-typeprotected Reference
partOf
Another Encounter of which this encounter is a part of (administratively or in time).protected Encounter
partOfTarget
The actual object that is the target of the reference (Another Encounter of which this encounter is a part of (administratively or in time).)static ca.uhn.fhir.rest.gclient.ReferenceClientParam
PATIENT
Fluent Client search parameter constant for patientprotected Period
period
The start and end time of the encounter.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
PRACTITIONER
Fluent Client search parameter constant for practitionerprotected CodeableConcept
priority
Indicates the urgency of the encounter.protected List<CodeableConcept>
reason
Reason the encounter takes place, expressed as a code.static ca.uhn.fhir.rest.gclient.TokenClientParam
REASON
Fluent Client search parameter constant for reasonstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
SERVICE_PROVIDER
Fluent Client search parameter constant for service-providerprotected Reference
serviceProvider
An organization that is in charge of maintaining the information of this Encounter (e.g.protected Organization
serviceProviderTarget
The actual object that is the target of the reference (An organization that is in charge of maintaining the information of this Encounter (e.g.static String
SP_APPOINTMENT
Search parameter: appointmentstatic String
SP_CLASS
Search parameter: classstatic String
SP_DATE
Search parameter: datestatic String
SP_DIAGNOSIS
Search parameter: diagnosisstatic String
SP_EPISODEOFCARE
Search parameter: episodeofcarestatic String
SP_IDENTIFIER
Search parameter: identifierstatic String
SP_INCOMINGREFERRAL
Search parameter: incomingreferralstatic String
SP_LENGTH
Search parameter: lengthstatic String
SP_LOCATION
Search parameter: locationstatic String
SP_LOCATION_PERIOD
Search parameter: location-periodstatic String
SP_PART_OF
Search parameter: part-ofstatic String
SP_PARTICIPANT
Search parameter: participantstatic String
SP_PARTICIPANT_TYPE
Search parameter: participant-typestatic String
SP_PATIENT
Search parameter: patientstatic String
SP_PRACTITIONER
Search parameter: practitionerstatic String
SP_REASON
Search parameter: reasonstatic String
SP_SERVICE_PROVIDER
Search parameter: service-providerstatic String
SP_SPECIAL_ARRANGEMENT
Search parameter: special-arrangementstatic String
SP_STATUS
Search parameter: statusstatic String
SP_SUBJECT
Search parameter: subjectstatic String
SP_TYPE
Search parameter: typestatic ca.uhn.fhir.rest.gclient.TokenClientParam
SPECIAL_ARRANGEMENT
Fluent Client search parameter constant for special-arrangementprotected Enumeration<Encounter.EncounterStatus>
status
planned | arrived | triaged | in-progress | onleave | finished | cancelled +.static ca.uhn.fhir.rest.gclient.TokenClientParam
STATUS
Fluent Client search parameter constant for statusprotected List<Encounter.StatusHistoryComponent>
statusHistory
The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.protected Reference
subject
The patient ro group present at the encounter.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
SUBJECT
Fluent Client search parameter constant for subjectprotected Resource
subjectTarget
The actual object that is the target of the reference (The patient ro group present at the encounter.)protected List<CodeableConcept>
type
Specific type of encounter (e.g.static ca.uhn.fhir.rest.gclient.TokenClientParam
TYPE
Fluent Client search parameter constant for type-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Encounter()
ConstructorEncounter(Enumeration<Encounter.EncounterStatus> status)
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Identifier(s) by which this encounter is known.
-
status
protected Enumeration<Encounter.EncounterStatus> status
planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
-
statusHistory
protected List<Encounter.StatusHistoryComponent> statusHistory
The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
-
classHistory
protected List<Encounter.ClassHistoryComponent> classHistory
The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transisions 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 kindof discharge from emergency to inpatient.
-
type
protected List<CodeableConcept> type
Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
-
priority
protected CodeableConcept priority
Indicates the urgency of the encounter.
-
subjectTarget
protected Resource subjectTarget
The actual object that is the target of the reference (The patient ro group present at the encounter.)
-
episodeOfCare
protected List<Reference> episodeOfCare
Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
-
episodeOfCareTarget
protected List<EpisodeOfCare> episodeOfCareTarget
The actual objects that are the target of the reference (Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).)
-
incomingReferral
protected List<Reference> incomingReferral
The referral request this encounter satisfies (incoming referral).
-
incomingReferralTarget
protected List<ReferralRequest> incomingReferralTarget
The actual objects that are the target of the reference (The referral request this encounter satisfies (incoming referral).)
-
participant
protected List<Encounter.EncounterParticipantComponent> participant
The list of people responsible for providing the service.
-
appointment
protected Reference appointment
The appointment that scheduled this encounter.
-
appointmentTarget
protected Appointment appointmentTarget
The actual object that is the target of the reference (The appointment that scheduled this encounter.)
-
length
protected Duration length
Quantity of time the encounter lasted. This excludes the time during leaves of absence.
-
reason
protected List<CodeableConcept> reason
Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
-
diagnosis
protected List<Encounter.DiagnosisComponent> diagnosis
The list of diagnosis relevant to this encounter.
-
account
protected List<Reference> account
The set of accounts that may be used for billing for this Encounter.
-
accountTarget
protected List<Account> accountTarget
The actual objects that are the target of the reference (The set of accounts that may be used for billing for this Encounter.)
-
hospitalization
protected Encounter.EncounterHospitalizationComponent hospitalization
Details about the admission to a healthcare service.
-
location
protected List<Encounter.EncounterLocationComponent> location
List of locations where the patient has been during this encounter.
-
serviceProvider
protected Reference serviceProvider
An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.
-
serviceProviderTarget
protected Organization serviceProviderTarget
The actual object that is the target of the reference (An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.)
-
partOf
protected Reference partOf
Another Encounter of which this encounter is a part of (administratively or in time).
-
partOfTarget
protected Encounter partOfTarget
The actual object that is the target of the reference (Another Encounter of which this encounter is a part of (administratively or in time).)
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: A date within the period the Encounter lasted
Type: date
Path: Encounter.period
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: A date within the period the Encounter lasted
Type: date
Path: Encounter.period
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Identifier(s) by which this encounter is known
Type: token
Path: Encounter.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Identifier(s) by which this encounter is known
Type: token
Path: Encounter.identifier
-
SP_REASON
public static final String SP_REASON
Search parameter: reasonDescription: Reason the encounter takes place (code)
Type: token
Path: Encounter.reason
- See Also:
- Constant Field Values
-
REASON
public static final ca.uhn.fhir.rest.gclient.TokenClientParam REASON
Fluent Client search parameter constant for reasonDescription: Reason the encounter takes place (code)
Type: token
Path: Encounter.reason
-
SP_EPISODEOFCARE
public static final String SP_EPISODEOFCARE
Search parameter: episodeofcareDescription: Episode(s) of care that this encounter should be recorded against
Type: reference
Path: Encounter.episodeOfCare
- See Also:
- Constant Field Values
-
EPISODEOFCARE
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam EPISODEOFCARE
Fluent Client search parameter constant for episodeofcareDescription: Episode(s) of care that this encounter should be recorded against
Type: reference
Path: Encounter.episodeOfCare
-
INCLUDE_EPISODEOFCARE
public static final ca.uhn.fhir.model.api.Include INCLUDE_EPISODEOFCARE
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:episodeofcare".
-
SP_PARTICIPANT_TYPE
public static final String SP_PARTICIPANT_TYPE
Search parameter: participant-typeDescription: 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-typeDescription: Role of participant in encounter
Type: token
Path: Encounter.participant.type
-
SP_INCOMINGREFERRAL
public static final String SP_INCOMINGREFERRAL
Search parameter: incomingreferralDescription: The ReferralRequest that initiated this encounter
Type: reference
Path: Encounter.incomingReferral
- See Also:
- Constant Field Values
-
INCOMINGREFERRAL
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INCOMINGREFERRAL
Fluent Client search parameter constant for incomingreferralDescription: The ReferralRequest that initiated this encounter
Type: reference
Path: Encounter.incomingReferral
-
INCLUDE_INCOMINGREFERRAL
public static final ca.uhn.fhir.model.api.Include INCLUDE_INCOMINGREFERRAL
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:incomingreferral".
-
SP_PRACTITIONER
public static final String SP_PRACTITIONER
Search parameter: practitionerDescription: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.individual
- See Also:
- Constant Field Values
-
PRACTITIONER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRACTITIONER
Fluent Client search parameter constant for practitionerDescription: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.individual
-
INCLUDE_PRACTITIONER
public static final ca.uhn.fhir.model.api.Include INCLUDE_PRACTITIONER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:practitioner".
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: The patient ro 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 subjectDescription: The patient ro group present at the encounter
Type: reference
Path: Encounter.subject
-
INCLUDE_SUBJECT
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:subject".
-
SP_LENGTH
public static final String SP_LENGTH
Search parameter: lengthDescription: Length of encounter in days
Type: number
Path: Encounter.length
- See Also:
- Constant Field Values
-
LENGTH
public static final ca.uhn.fhir.rest.gclient.NumberClientParam LENGTH
Fluent Client search parameter constant for lengthDescription: Length of encounter in days
Type: number
Path: Encounter.length
-
SP_DIAGNOSIS
public static final String SP_DIAGNOSIS
Search parameter: diagnosisDescription: Reason the encounter takes place (resource)
Type: reference
Path: Encounter.diagnosis.condition
- See Also:
- Constant Field Values
-
DIAGNOSIS
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DIAGNOSIS
Fluent Client search parameter constant for diagnosisDescription: Reason the encounter takes place (resource)
Type: reference
Path: Encounter.diagnosis.condition
-
INCLUDE_DIAGNOSIS
public static final ca.uhn.fhir.model.api.Include INCLUDE_DIAGNOSIS
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:diagnosis".
-
SP_APPOINTMENT
public static final String SP_APPOINTMENT
Search parameter: appointmentDescription: 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 appointmentDescription: The appointment that scheduled this encounter
Type: reference
Path: Encounter.appointment
-
INCLUDE_APPOINTMENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_APPOINTMENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:appointment".
-
SP_PART_OF
public static final String SP_PART_OF
Search parameter: part-ofDescription: 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-ofDescription: Another Encounter this encounter is part of
Type: reference
Path: Encounter.partOf
-
INCLUDE_PART_OF
public static final ca.uhn.fhir.model.api.Include INCLUDE_PART_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:part-of".
-
SP_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: Specific type of encounter
Type: token
Path: Encounter.type
- See Also:
- Constant Field Values
-
TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
Fluent Client search parameter constant for typeDescription: Specific type of encounter
Type: token
Path: Encounter.type
-
SP_PARTICIPANT
public static final String SP_PARTICIPANT
Search parameter: participantDescription: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.individual
- See Also:
- Constant Field Values
-
PARTICIPANT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARTICIPANT
Fluent Client search parameter constant for participantDescription: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.individual
-
INCLUDE_PARTICIPANT
public static final ca.uhn.fhir.model.api.Include INCLUDE_PARTICIPANT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:participant".
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: The patient ro group present at the encounter
Type: reference
Path: Encounter.subject
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: The patient ro group present at the encounter
Type: reference
Path: Encounter.subject
-
INCLUDE_PATIENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:patient".
-
SP_LOCATION_PERIOD
public static final String SP_LOCATION_PERIOD
Search parameter: location-periodDescription: Time period during which the patient was present at the location
Type: date
Path: Encounter.location.period
- See Also:
- Constant Field Values
-
LOCATION_PERIOD
public static final ca.uhn.fhir.rest.gclient.DateClientParam LOCATION_PERIOD
Fluent Client search parameter constant for location-periodDescription: Time period during which the patient was present at the location
Type: date
Path: Encounter.location.period
-
SP_LOCATION
public static final String SP_LOCATION
Search parameter: locationDescription: 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 locationDescription: Location the encounter takes place
Type: reference
Path: Encounter.location.location
-
INCLUDE_LOCATION
public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:location".
-
SP_SERVICE_PROVIDER
public static final String SP_SERVICE_PROVIDER
Search parameter: service-providerDescription: The custodian organization of this Encounter record
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-providerDescription: The custodian organization of this Encounter record
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-arrangementDescription: Wheelchair, translator, stretcher, etc.
Type: token
Path: Encounter.hospitalization.specialArrangement
- See Also:
- Constant Field Values
-
SPECIAL_ARRANGEMENT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SPECIAL_ARRANGEMENT
Fluent Client search parameter constant for special-arrangementDescription: Wheelchair, translator, stretcher, etc.
Type: token
Path: Encounter.hospitalization.specialArrangement
-
SP_CLASS
public static final String SP_CLASS
Search parameter: classDescription: inpatient | outpatient | ambulatory | emergency +
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 classDescription: inpatient | outpatient | ambulatory | emergency +
Type: token
Path: Encounter.class
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Type: token
Path: Encounter.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Type: token
Path: Encounter.status
-
-
Constructor Detail
-
Encounter
public Encounter()
Constructor
-
Encounter
public Encounter(Enumeration<Encounter.EncounterStatus> status)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier
(Identifier(s) by which this encounter is known.)
-
setIdentifier
public Encounter setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public Encounter addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getStatusElement
public Enumeration<Encounter.EncounterStatus> getStatusElement()
- Returns:
status
(planned | arrived | triaged | in-progress | onleave | finished | cancelled +.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public Encounter setStatusElement(Enumeration<Encounter.EncounterStatus> value)
- Parameters:
value
-status
(planned | arrived | triaged | in-progress | onleave | finished | cancelled +.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Encounter.EncounterStatus getStatus()
- Returns:
- planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
-
setStatus
public Encounter setStatus(Encounter.EncounterStatus value)
- Parameters:
value
- planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
-
getStatusHistory
public List<Encounter.StatusHistoryComponent> getStatusHistory()
- Returns:
statusHistory
(The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.)
-
setStatusHistory
public Encounter setStatusHistory(List<Encounter.StatusHistoryComponent> theStatusHistory)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasStatusHistory
public boolean hasStatusHistory()
-
addStatusHistory
public Encounter.StatusHistoryComponent addStatusHistory()
-
addStatusHistory
public Encounter addStatusHistory(Encounter.StatusHistoryComponent t)
-
getStatusHistoryFirstRep
public Encounter.StatusHistoryComponent getStatusHistoryFirstRep()
- Returns:
- The first repetition of repeating field
statusHistory
, creating it if it does not already exist
-
getClass_
public Coding getClass_()
- Returns:
class_
(inpatient | outpatient | ambulatory | emergency +.)
-
hasClass_
public boolean hasClass_()
-
setClass_
public Encounter setClass_(Coding value)
- Parameters:
value
-class_
(inpatient | outpatient | ambulatory | emergency +.)
-
getClassHistory
public List<Encounter.ClassHistoryComponent> getClassHistory()
- Returns:
classHistory
(The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transisions 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 kindof discharge from emergency to inpatient.)
-
setClassHistory
public Encounter setClassHistory(List<Encounter.ClassHistoryComponent> theClassHistory)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasClassHistory
public boolean hasClassHistory()
-
addClassHistory
public Encounter.ClassHistoryComponent addClassHistory()
-
addClassHistory
public Encounter addClassHistory(Encounter.ClassHistoryComponent t)
-
getClassHistoryFirstRep
public Encounter.ClassHistoryComponent getClassHistoryFirstRep()
- Returns:
- The first repetition of repeating field
classHistory
, creating it if it does not already exist
-
getType
public List<CodeableConcept> getType()
- Returns:
type
(Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).)
-
setType
public Encounter setType(List<CodeableConcept> theType)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasType
public boolean hasType()
-
addType
public CodeableConcept addType()
-
addType
public Encounter addType(CodeableConcept t)
-
getTypeFirstRep
public CodeableConcept getTypeFirstRep()
- Returns:
- The first repetition of repeating field
type
, creating it if it does not already exist
-
getPriority
public CodeableConcept getPriority()
- Returns:
priority
(Indicates the urgency of the encounter.)
-
hasPriority
public boolean hasPriority()
-
setPriority
public Encounter setPriority(CodeableConcept value)
- Parameters:
value
-priority
(Indicates the urgency of the encounter.)
-
getSubject
public Reference getSubject()
- Returns:
subject
(The patient ro group present at the encounter.)
-
hasSubject
public boolean hasSubject()
-
setSubject
public Encounter setSubject(Reference value)
- Parameters:
value
-subject
(The patient ro group present at the encounter.)
-
getSubjectTarget
public Resource getSubjectTarget()
- Returns:
subject
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The patient ro group present at the encounter.)
-
setSubjectTarget
public Encounter setSubjectTarget(Resource value)
- Parameters:
value
-subject
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The patient ro group present at the encounter.)
-
getEpisodeOfCare
public List<Reference> getEpisodeOfCare()
- Returns:
episodeOfCare
(Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).)
-
setEpisodeOfCare
public Encounter setEpisodeOfCare(List<Reference> theEpisodeOfCare)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEpisodeOfCare
public boolean hasEpisodeOfCare()
-
addEpisodeOfCare
public Reference addEpisodeOfCare()
-
addEpisodeOfCare
public Encounter addEpisodeOfCare(Reference t)
-
getEpisodeOfCareFirstRep
public Reference getEpisodeOfCareFirstRep()
- Returns:
- The first repetition of repeating field
episodeOfCare
, creating it if it does not already exist
-
getEpisodeOfCareTarget
@Deprecated public List<EpisodeOfCare> getEpisodeOfCareTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addEpisodeOfCareTarget
@Deprecated public EpisodeOfCare addEpisodeOfCareTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getIncomingReferral
public List<Reference> getIncomingReferral()
- Returns:
incomingReferral
(The referral request this encounter satisfies (incoming referral).)
-
setIncomingReferral
public Encounter setIncomingReferral(List<Reference> theIncomingReferral)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIncomingReferral
public boolean hasIncomingReferral()
-
addIncomingReferral
public Reference addIncomingReferral()
-
addIncomingReferral
public Encounter addIncomingReferral(Reference t)
-
getIncomingReferralFirstRep
public Reference getIncomingReferralFirstRep()
- Returns:
- The first repetition of repeating field
incomingReferral
, creating it if it does not already exist
-
getIncomingReferralTarget
@Deprecated public List<ReferralRequest> getIncomingReferralTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addIncomingReferralTarget
@Deprecated public ReferralRequest addIncomingReferralTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getParticipant
public List<Encounter.EncounterParticipantComponent> getParticipant()
- Returns:
participant
(The list of people responsible for providing the service.)
-
setParticipant
public Encounter setParticipant(List<Encounter.EncounterParticipantComponent> theParticipant)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasParticipant
public boolean hasParticipant()
-
addParticipant
public Encounter.EncounterParticipantComponent addParticipant()
-
addParticipant
public Encounter addParticipant(Encounter.EncounterParticipantComponent t)
-
getParticipantFirstRep
public Encounter.EncounterParticipantComponent getParticipantFirstRep()
- Returns:
- The first repetition of repeating field
participant
, creating it if it does not already exist
-
getAppointment
public Reference getAppointment()
- Returns:
appointment
(The appointment that scheduled this encounter.)
-
hasAppointment
public boolean hasAppointment()
-
setAppointment
public Encounter setAppointment(Reference value)
- Parameters:
value
-appointment
(The appointment that scheduled this encounter.)
-
getAppointmentTarget
public Appointment getAppointmentTarget()
- Returns:
appointment
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The appointment that scheduled this encounter.)
-
setAppointmentTarget
public Encounter setAppointmentTarget(Appointment value)
- Parameters:
value
-appointment
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The appointment that scheduled this encounter.)
-
hasPeriod
public boolean hasPeriod()
-
setPeriod
public Encounter setPeriod(Period value)
- Parameters:
value
-period
(The start and end time of the encounter.)
-
getLength
public Duration getLength()
- Returns:
length
(Quantity of time the encounter lasted. This excludes the time during leaves of absence.)
-
hasLength
public boolean hasLength()
-
setLength
public Encounter setLength(Duration value)
- Parameters:
value
-length
(Quantity of time the encounter lasted. This excludes the time during leaves of absence.)
-
getReason
public List<CodeableConcept> getReason()
- Returns:
reason
(Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.)
-
setReason
public Encounter setReason(List<CodeableConcept> theReason)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReason
public boolean hasReason()
-
addReason
public CodeableConcept addReason()
-
addReason
public Encounter addReason(CodeableConcept t)
-
getReasonFirstRep
public CodeableConcept getReasonFirstRep()
- Returns:
- The first repetition of repeating field
reason
, creating it if it does not already exist
-
getDiagnosis
public List<Encounter.DiagnosisComponent> getDiagnosis()
- Returns:
diagnosis
(The list of diagnosis relevant to this encounter.)
-
setDiagnosis
public Encounter setDiagnosis(List<Encounter.DiagnosisComponent> theDiagnosis)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDiagnosis
public boolean hasDiagnosis()
-
addDiagnosis
public Encounter.DiagnosisComponent addDiagnosis()
-
addDiagnosis
public Encounter addDiagnosis(Encounter.DiagnosisComponent t)
-
getDiagnosisFirstRep
public Encounter.DiagnosisComponent getDiagnosisFirstRep()
- Returns:
- The first repetition of repeating field
diagnosis
, creating it if it does not already exist
-
getAccount
public List<Reference> getAccount()
- Returns:
account
(The set of accounts that may be used for billing for this Encounter.)
-
setAccount
public Encounter setAccount(List<Reference> theAccount)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAccount
public boolean hasAccount()
-
addAccount
public Reference addAccount()
-
addAccount
public Encounter addAccount(Reference t)
-
getAccountFirstRep
public Reference getAccountFirstRep()
- Returns:
- The first repetition of repeating field
account
, creating it if it does not already exist
-
getAccountTarget
@Deprecated public List<Account> getAccountTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addAccountTarget
@Deprecated public Account addAccountTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getHospitalization
public Encounter.EncounterHospitalizationComponent getHospitalization()
- Returns:
hospitalization
(Details about the admission to a healthcare service.)
-
hasHospitalization
public boolean hasHospitalization()
-
setHospitalization
public Encounter setHospitalization(Encounter.EncounterHospitalizationComponent value)
- Parameters:
value
-hospitalization
(Details about the admission to a healthcare service.)
-
getLocation
public List<Encounter.EncounterLocationComponent> getLocation()
- Returns:
location
(List of locations where the patient has been during this encounter.)
-
setLocation
public Encounter setLocation(List<Encounter.EncounterLocationComponent> theLocation)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasLocation
public boolean hasLocation()
-
addLocation
public Encounter.EncounterLocationComponent addLocation()
-
addLocation
public Encounter addLocation(Encounter.EncounterLocationComponent t)
-
getLocationFirstRep
public Encounter.EncounterLocationComponent getLocationFirstRep()
- Returns:
- The first repetition of repeating field
location
, creating it if it does not already exist
-
getServiceProvider
public Reference getServiceProvider()
- Returns:
serviceProvider
(An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.)
-
hasServiceProvider
public boolean hasServiceProvider()
-
setServiceProvider
public Encounter setServiceProvider(Reference value)
- Parameters:
value
-serviceProvider
(An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.)
-
getServiceProviderTarget
public Organization getServiceProviderTarget()
- Returns:
serviceProvider
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.)
-
setServiceProviderTarget
public Encounter setServiceProviderTarget(Organization value)
- Parameters:
value
-serviceProvider
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.)
-
getPartOf
public Reference getPartOf()
- Returns:
partOf
(Another Encounter of which this encounter is a part of (administratively or in time).)
-
hasPartOf
public boolean hasPartOf()
-
setPartOf
public Encounter setPartOf(Reference value)
- Parameters:
value
-partOf
(Another Encounter of which this encounter is a part of (administratively or in time).)
-
getPartOfTarget
public Encounter getPartOfTarget()
- Returns:
partOf
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Another Encounter of which this encounter is a part of (administratively or in time).)
-
setPartOfTarget
public Encounter setPartOfTarget(Encounter value)
- Parameters:
value
-partOf
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Another Encounter of which this encounter is a part of (administratively or in time).)
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
public Encounter copy()
- Specified by:
copy
in classDomainResource
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceType
in classResource
-
-