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 Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
static class
static enum
static class
static class
static enum
static class
static class
-
Field Summary
Modifier and TypeFieldDescriptionThe set of accounts that may be used for billing for this Encounter.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent 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.ReferenceClientParam
Fluent 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.ReferenceClientParam
Fluent Client search parameter constant for based-onThe request this encounter satisfies (e.g.protected List
<ServiceRequest> The actual objects that are the target of the reference (The request this encounter satisfies (e.g.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for classprotected Coding
Concepts 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.DateClientParam
Fluent Client search parameter constant for dateprotected List
<Encounter.DiagnosisComponent> The list of diagnosis relevant to this encounter.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for diagnosisstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent 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.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected Duration
Quantity of time the encounter lasted.static final ca.uhn.fhir.rest.gclient.QuantityClientParam
Fluent 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.ReferenceClientParam
Fluent Client search parameter constant for locationstatic final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for location-periodstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent 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.ReferenceClientParam
Fluent Client search parameter constant for participantstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for participant-typeprotected Reference
Another Encounter of which this encounter is a part of (administratively or in time).protected Encounter
The actual object that is the target of the reference (Another Encounter of which this encounter is a part of (administratively or in time).)static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientprotected Period
The start and end time of the encounter.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for practitionerprotected CodeableConcept
Indicates the urgency of the encounter.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for reason-codestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent 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.ReferenceClientParam
Fluent Client search parameter constant for service-providerprotected Reference
The organization that is primarily responsible for this Encounter's services.protected Organization
The actual object that is the target of the reference (The organization that is primarily responsible for this Encounter's services.protected CodeableConcept
Broad categorization of the service that is to be provided (e.g.static final String
Search parameter: accountstatic final String
Search parameter: appointmentstatic final String
Search parameter: based-onstatic final String
Search parameter: classstatic final String
Search parameter: datestatic final String
Search parameter: diagnosisstatic final String
Search parameter: episode-of-carestatic final String
Search parameter: identifierstatic final String
Search parameter: lengthstatic final String
Search parameter: locationstatic final String
Search parameter: location-periodstatic final String
Search parameter: part-ofstatic final String
Search parameter: participantstatic final String
Search parameter: participant-typestatic final String
Search parameter: patientstatic final String
Search parameter: practitionerstatic final String
Search parameter: reason-codestatic final String
Search parameter: reason-referencestatic final String
Search parameter: service-providerstatic final String
Search parameter: special-arrangementstatic final String
Search parameter: statusstatic final String
Search parameter: subjectstatic final String
Search parameter: typestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent 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.TokenClientParam
Fluent 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 Reference
The patient or group present at the encounter.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectprotected Resource
The 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.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for typeFields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorDescriptionConstructorEncounter
(Enumeration<Encounter.EncounterStatus> status, Coding class_) Constructor -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadaddType()
copy()
void
copyValues
(Encounter dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadgetNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadgetType()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(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 Encounter
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
Identifier(s) by which this encounter is known. -
status
planned | arrived | triaged | in-progress | onleave | finished | cancelled +. -
statusHistory
The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them. -
class_
Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. -
classHistory
The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient. -
type
Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). -
serviceType
Broad categorization of the service that is to be provided (e.g. cardiology). -
priority
Indicates the urgency of the encounter. -
subject
The patient or group present at the encounter. -
subjectTarget
The actual object that is the target of the reference (The patient or group present at the encounter.) -
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
The actual objects that are the target of the reference (Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).) -
basedOn
The request this encounter satisfies (e.g. incoming referral or procedure request). -
basedOnTarget
The actual objects that are the target of the reference (The request this encounter satisfies (e.g. incoming referral or procedure request).) -
participant
The list of people responsible for providing the service. -
appointment
The appointment that scheduled this encounter. -
appointmentTarget
The actual objects that are the target of the reference (The appointment that scheduled this encounter.) -
period
The start and end time of the encounter. -
length
Quantity of time the encounter lasted. This excludes the time during leaves of absence. -
reasonCode
Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. -
reasonReference
Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. -
reasonReferenceTarget
The actual objects that are the target of the reference (Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.) -
diagnosis
The list of diagnosis relevant to this encounter. -
account
The set of accounts that may be used for billing for this Encounter. -
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
Details about the admission to a healthcare service. -
location
List of locations where the patient has been during this encounter. -
serviceProvider
The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy. -
serviceProviderTarget
The actual object that is the target of the reference (The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.) -
partOf
Another Encounter of which this encounter is a part of (administratively or in time). -
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
Search parameter: dateDescription: A date within the period the Encounter lasted
Type: date
Path: Encounter.period
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: A date within the period the Encounter lasted
Type: date
Path: Encounter.period
-
SP_IDENTIFIER
Search parameter: identifierDescription: Identifier(s) by which this encounter is known
Type: token
Path: Encounter.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Identifier(s) by which this encounter is known
Type: token
Path: Encounter.identifier
-
SP_PARTICIPANT_TYPE
Search parameter: participant-typeDescription: Role of participant in encounter
Type: token
Path: Encounter.participant.type
- See Also:
-
PARTICIPANT_TYPE
Fluent Client search parameter constant for participant-typeDescription: Role of participant in encounter
Type: token
Path: Encounter.participant.type
-
SP_PRACTITIONER
Search parameter: practitionerDescription: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.individual
- See Also:
-
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
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:practitioner". -
SP_SUBJECT
Search parameter: subjectDescription: The patient or group present at the encounter
Type: reference
Path: Encounter.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: The patient or group present at the encounter
Type: reference
Path: Encounter.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:subject". -
SP_LENGTH
Search parameter: lengthDescription: Length of encounter in days
Type: quantity
Path: Encounter.length
- See Also:
-
LENGTH
Fluent Client search parameter constant for lengthDescription: Length of encounter in days
Type: quantity
Path: Encounter.length
-
SP_EPISODE_OF_CARE
Search parameter: episode-of-careDescription: Episode(s) of care that this encounter should be recorded against
Type: reference
Path: Encounter.episodeOfCare
- See Also:
-
EPISODE_OF_CARE
Fluent 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_CARE
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:episode-of-care". -
SP_DIAGNOSIS
Search parameter: diagnosisDescription: The diagnosis or procedure relevant to the encounter
Type: reference
Path: Encounter.diagnosis.condition
- See Also:
-
DIAGNOSIS
Fluent Client search parameter constant for diagnosisDescription: The diagnosis or procedure relevant to the encounter
Type: reference
Path: Encounter.diagnosis.condition
-
INCLUDE_DIAGNOSIS
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:diagnosis". -
SP_APPOINTMENT
Search parameter: appointmentDescription: The appointment that scheduled this encounter
Type: reference
Path: Encounter.appointment
- See Also:
-
APPOINTMENT
Fluent Client search parameter constant for appointmentDescription: The appointment that scheduled this encounter
Type: reference
Path: Encounter.appointment
-
INCLUDE_APPOINTMENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:appointment". -
SP_PART_OF
Search parameter: part-ofDescription: Another Encounter this encounter is part of
Type: reference
Path: Encounter.partOf
- See Also:
-
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
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:part-of". -
SP_TYPE
Search parameter: typeDescription: Specific type of encounter
Type: token
Path: Encounter.type
- See Also:
-
TYPE
Fluent Client search parameter constant for typeDescription: Specific type of encounter
Type: token
Path: Encounter.type
-
SP_REASON_CODE
Search parameter: reason-codeDescription: Coded reason the encounter takes place
Type: token
Path: Encounter.reasonCode
- See Also:
-
REASON_CODE
Fluent Client search parameter constant for reason-codeDescription: Coded reason the encounter takes place
Type: token
Path: Encounter.reasonCode
-
SP_PARTICIPANT
Search parameter: participantDescription: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.individual
- See Also:
-
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
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:participant". -
SP_BASED_ON
Search parameter: based-onDescription: The ServiceRequest that initiated this encounter
Type: reference
Path: Encounter.basedOn
- See Also:
-
BASED_ON
Fluent Client search parameter constant for based-onDescription: The ServiceRequest that initiated this encounter
Type: reference
Path: Encounter.basedOn
-
INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:based-on". -
SP_PATIENT
Search parameter: patientDescription: The patient or group present at the encounter
Type: reference
Path: Encounter.subject
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: The patient or group present at the encounter
Type: reference
Path: Encounter.subject
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:patient". -
SP_REASON_REFERENCE
Search parameter: reason-referenceDescription: Reason the encounter takes place (reference)
Type: reference
Path: Encounter.reasonReference
- See Also:
-
REASON_REFERENCE
Fluent Client search parameter constant for reason-referenceDescription: Reason the encounter takes place (reference)
Type: reference
Path: Encounter.reasonReference
-
INCLUDE_REASON_REFERENCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:reason-reference". -
SP_LOCATION_PERIOD
Search parameter: location-periodDescription: Time period during which the patient was present at the location
Type: date
Path: Encounter.location.period
- See Also:
-
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
Search parameter: locationDescription: Location the encounter takes place
Type: reference
Path: Encounter.location.location
- See Also:
-
LOCATION
Fluent Client search parameter constant for locationDescription: Location the encounter takes place
Type: reference
Path: Encounter.location.location
-
INCLUDE_LOCATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:location". -
SP_SERVICE_PROVIDER
Search parameter: service-providerDescription: The organization (facility) responsible for this encounter
Type: reference
Path: Encounter.serviceProvider
- See Also:
-
SERVICE_PROVIDER
Fluent Client search parameter constant for service-providerDescription: The organization (facility) responsible for this encounter
Type: reference
Path: Encounter.serviceProvider
-
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
Search parameter: special-arrangementDescription: Wheelchair, translator, stretcher, etc.
Type: token
Path: Encounter.hospitalization.specialArrangement
- See Also:
-
SPECIAL_ARRANGEMENT
Fluent Client search parameter constant for special-arrangementDescription: Wheelchair, translator, stretcher, etc.
Type: token
Path: Encounter.hospitalization.specialArrangement
-
SP_CLASS
Search parameter: classDescription: Classification of patient encounter
Type: token
Path: Encounter.class
- See Also:
-
CLASS
Fluent Client search parameter constant for classDescription: Classification of patient encounter
Type: token
Path: Encounter.class
-
SP_ACCOUNT
Search parameter: accountDescription: The set of accounts that may be used for billing for this Encounter
Type: reference
Path: Encounter.account
- See Also:
-
ACCOUNT
Fluent 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_ACCOUNT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:account". -
SP_STATUS
Search parameter: statusDescription: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Type: token
Path: Encounter.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Type: token
Path: Encounter.status
-
-
Constructor Details
-
Encounter
public Encounter()Constructor -
Encounter
Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Identifier(s) by which this encounter is known.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for 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
this
for 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
this
for 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
this
for 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:
subject
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The patient or group present at the encounter.)
-
setSubjectTarget
- Parameters:
value
-subject
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The patient or group present at the encounter.)
-
getEpisodeOfCare
- 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
this
for easy method chaining
-
hasEpisodeOfCare
-
addEpisodeOfCare
-
addEpisodeOfCare
-
getEpisodeOfCareFirstRep
- Returns:
- The first repetition of repeating field
episodeOfCare
, creating it if it does not already exist
-
getEpisodeOfCareTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addEpisodeOfCareTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getBasedOn
- Returns:
basedOn
(The request this encounter satisfies (e.g. incoming referral or procedure request).)
-
setBasedOn
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasBasedOn
-
addBasedOn
-
addBasedOn
-
getBasedOnFirstRep
- Returns:
- The first repetition of repeating field
basedOn
, creating it if it does not already exist
-
getBasedOnTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addBasedOnTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getParticipant
- Returns:
participant
(The list of people responsible for providing the service.)
-
setParticipant
- Returns:
- Returns a reference to
this
for 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
this
for easy method chaining
-
hasAppointment
-
addAppointment
-
addAppointment
-
getAppointmentFirstRep
- Returns:
- The first repetition of repeating field
appointment
, creating it if it does not already exist
-
getAppointmentTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addAppointmentTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
this
for 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
this
for easy method chaining
-
hasReasonReference
-
addReasonReference
-
addReasonReference
-
getReasonReferenceFirstRep
- Returns:
- The first repetition of repeating field
reasonReference
, creating it if it does not already exist
-
getReasonReferenceTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getDiagnosis
- Returns:
diagnosis
(The list of diagnosis relevant to this encounter.)
-
setDiagnosis
- Returns:
- Returns a reference to
this
for 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
this
for easy method chaining
-
hasAccount
-
addAccount
-
addAccount
-
getAccountFirstRep
- Returns:
- The first repetition of repeating field
account
, creating it if it does not already exist
-
getAccountTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addAccountTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
this
for 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:
serviceProvider
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.)
-
setServiceProviderTarget
- Parameters:
value
-serviceProvider
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.)
-
getPartOf
- 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:
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
- 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
- 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
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- 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
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-