
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
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
static class
static class
static enum
static class
static class
static enum
static class
static class
Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason
-
Field Summary
FieldsModifier 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 accountprotected Period
The actual start and end time of the encounter.protected Encounter.EncounterAdmissionComponent
Details about the admission to a healthcare service.The appointment that scheduled this encounter.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for appointmentstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for based-onThe request this encounter satisfies (e.g.The group(s) of individuals, organizations that are allocated to participate in this encounter.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for careteamstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for classprotected List<CodeableConcept>
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 datestatic final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for date-startprotected 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.DateClientParam
Fluent Client search parameter constant for end-datestatic 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<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.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected Duration
Actual 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).static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientprotected DateTimeType
The planned end date/time (or discharge date) of the encounter.protected DateTimeType
The planned start date/time (or admission date) 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.protected List<CodeableReference>
Reason the encounter takes place, expressed as a code or a reference to another resource.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-referencestatic 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 List<CodeableReference>
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: careteamstatic final String
Search parameter: classstatic final String
Search parameter: datestatic final String
Search parameter: date-startstatic final String
Search parameter: diagnosisstatic final String
Search parameter: end-datestatic 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: subject-statusstatic final String
Search parameter: typestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for special-arrangementprotected Enumeration<Encounter.EncounterStatus>
planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown.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 related to this encounter.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for subject-statusprotected CodeableConcept
The subjectStatus value can be used to track the patient's status within 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 typeprotected List<VirtualServiceDetail>
Connection details of a virtual service (e.g.Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddType()
copy()
void
copyValues
(Encounter dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) getType()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
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
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setAccount
(List<Reference> theAccount) setActualPeriod
(Period value) setAppointment
(List<Reference> theAppointment) setBasedOn
(List<Reference> theBasedOn) setCareTeam
(List<Reference> theCareTeam) setClass_
(List<CodeableConcept> theClass_) 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) setPlannedEndDate
(Date value) setPlannedStartDate
(Date value) setPriority
(CodeableConcept value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setReason
(List<CodeableReference> theReason) setServiceProvider
(Reference value) setServiceType
(List<CodeableReference> theServiceType) setStatusHistory
(List<Encounter.StatusHistoryComponent> theStatusHistory) setSubject
(Reference value) setSubjectStatus
(CodeableConcept value) setType
(List<CodeableConcept> theType) setVirtualService
(List<VirtualServiceDetail> theVirtualService) protected Encounter
Methods inherited from class org.hl7.fhir.r5.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.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, hasValidationInfo, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, removeChild, 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, setId
-
Field Details
-
identifier
Identifier(s) by which this encounter is known. -
status
planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown. -
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. -
priority
Indicates the urgency of the encounter. -
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). -
subject
The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam. -
subjectStatus
The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status. -
episodeOfCare
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). -
careTeam
The group(s) of individuals, organizations that are allocated to participate in this encounter. The participants backbone will record the actuals of when these individuals participated during the encounter. -
partOf
Another Encounter of which this encounter is a part of (administratively or in time). -
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. -
participant
The list of people responsible for providing the service. -
appointment
The appointment that scheduled this encounter. -
virtualService
Connection details of a virtual service (e.g. conference call). -
actualPeriod
The actual start and end time of the encounter. -
plannedStartDate
The planned start date/time (or admission date) of the encounter. -
plannedEndDate
The planned end date/time (or discharge date) of the encounter. -
length
Actual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values. -
reason
Reason the encounter takes place, expressed as a code or a reference to another resource. 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. -
admission
Details about the admission to a healthcare service. -
location
List of locations where the patient has been during this encounter. -
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_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_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_CARETEAM
Search parameter: careteamDescription: Careteam allocated to participate in the encounter
Type: reference
Path: Encounter.careTeam
- See Also:
-
CARETEAM
Fluent Client search parameter constant for careteamDescription: Careteam allocated to participate in the encounter
Type: reference
Path: Encounter.careTeam
-
INCLUDE_CARETEAM
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:careteam". -
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_DATE_START
Search parameter: date-startDescription: The actual start date of the Encounter
Type: date
Path: Encounter.actualPeriod.start
- See Also:
-
DATE_START
Fluent Client search parameter constant for date-startDescription: The actual start date of the Encounter
Type: date
Path: Encounter.actualPeriod.start
-
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_END_DATE
Search parameter: end-dateDescription: The actual end date of the Encounter
Type: date
Path: Encounter.actualPeriod.end
- See Also:
-
END_DATE
Fluent Client search parameter constant for end-dateDescription: The actual end date of the Encounter
Type: date
Path: Encounter.actualPeriod.end
-
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_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_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_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_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_PARTICIPANT
Search parameter: participantDescription: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.actor
- See Also:
-
PARTICIPANT
Fluent Client search parameter constant for participantDescription: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.actor
-
INCLUDE_PARTICIPANT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:participant". -
SP_PRACTITIONER
Search parameter: practitionerDescription: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.actor.where(resolve() is Practitioner)
- See Also:
-
PRACTITIONER
Fluent Client search parameter constant for practitionerDescription: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.actor.where(resolve() is Practitioner)
-
INCLUDE_PRACTITIONER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:practitioner". -
SP_REASON_CODE
Search parameter: reason-codeDescription: Reference to a concept (by class)
Type: token
Path: Encounter.reason.concept
- See Also:
-
REASON_CODE
Fluent Client search parameter constant for reason-codeDescription: Reference to a concept (by class)
Type: token
Path: Encounter.reason.concept
-
SP_REASON_REFERENCE
Search parameter: reason-referenceDescription: Reference to a resource (by instance)
Type: reference
Path: Encounter.reason.reference
- See Also:
-
REASON_REFERENCE
Fluent Client search parameter constant for reason-referenceDescription: Reference to a resource (by instance)
Type: reference
Path: Encounter.reason.reference
-
INCLUDE_REASON_REFERENCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:reason-reference". -
SP_SERVICE_PROVIDER
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.admission.specialArrangement
- See Also:
-
SPECIAL_ARRANGEMENT
Fluent Client search parameter constant for special-arrangementDescription: Wheelchair, translator, stretcher, etc.
Type: token
Path: Encounter.admission.specialArrangement
-
SP_STATUS
Search parameter: statusDescription: planned | in-progress | on-hold | completed | cancelled | entered-in-error | unknown
Type: token
Path: Encounter.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: planned | in-progress | on-hold | completed | cancelled | entered-in-error | unknown
Type: token
Path: Encounter.status
-
SP_SUBJECT_STATUS
Search parameter: subject-statusDescription: The current status of the subject in relation to the Encounter
Type: token
Path: Encounter.subjectStatus
- See Also:
-
SUBJECT_STATUS
Fluent Client search parameter constant for subject-statusDescription: The current status of the subject in relation to the Encounter
Type: token
Path: Encounter.subjectStatus
-
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_DATE
Search parameter: dateDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [List](list.html): When the list was prepared [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period [Procedure](procedure.html): When the procedure occurred or is occurring [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AllergyIntolerance.recordedDate | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.date | DiagnosticReport.effective.as(dateTime) | DiagnosticReport.effective.as(Period) | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence as dateTime) | List.date | Observation.effective.as(dateTime) | Observation.effective.as(Period) | Observation.effective.as(Timing) | Observation.effective.as(instant) | Procedure.occurrence.as(dateTime) | Procedure.occurrence.as(Period) | Procedure.occurrence.as(Timing) | (RiskAssessment.occurrence as dateTime) | SupplyRequest.authoredOn
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [List](list.html): When the list was prepared [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period [Procedure](procedure.html): When the procedure occurred or is occurring [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AllergyIntolerance.recordedDate | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.date | DiagnosticReport.effective.as(dateTime) | DiagnosticReport.effective.as(Period) | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence as dateTime) | List.date | Observation.effective.as(dateTime) | Observation.effective.as(Period) | Observation.effective.as(Timing) | Observation.effective.as(instant) | Procedure.occurrence.as(dateTime) | Procedure.occurrence.as(Period) | Procedure.occurrence.as(Timing) | (RiskAssessment.occurrence as dateTime) | SupplyRequest.authoredOn
-
SP_IDENTIFIER
Search parameter: identifierDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier
-
SP_PATIENT
Search parameter: patientDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.subject | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | VisionPrescription.patient
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.subject | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | VisionPrescription.patient
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:patient". -
SP_TYPE
Search parameter: typeDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known) [Composition](composition.html): Kind of composition (LOINC if possible) [DocumentManifest](documentmanifest.html): Kind of document set [DocumentReference](documentreference.html): Kind of document (LOINC if possible) [Encounter](encounter.html): Specific type of encounter [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management
Type: token
Path: AllergyIntolerance.type | Composition.type | DocumentManifest.type | DocumentReference.type | Encounter.type | EpisodeOfCare.type
- See Also:
-
TYPE
Fluent Client search parameter constant for typeDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known) [Composition](composition.html): Kind of composition (LOINC if possible) [DocumentManifest](documentmanifest.html): Kind of document set [DocumentReference](documentreference.html): Kind of document (LOINC if possible) [Encounter](encounter.html): Specific type of encounter [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management
Type: token
Path: AllergyIntolerance.type | Composition.type | DocumentManifest.type | DocumentReference.type | Encounter.type | EpisodeOfCare.type
-
-
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 {3}
-
getStatusElement
- Returns:
status
(planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown.). 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 | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown.
-
setStatus
- Parameters:
value
- planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown.
-
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 {3}
-
getClass_
- Returns:
class_
(Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.)
-
setClass_
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasClass_
-
addClass_
-
addClass_
-
getClass_FirstRep
- Returns:
- The first repetition of repeating field
class_
, creating it if it does not already exist {3}
-
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 {3}
-
getPriority
- Returns:
priority
(Indicates the urgency of the encounter.)
-
hasPriority
-
setPriority
- Parameters:
value
-priority
(Indicates the urgency of the encounter.)
-
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 {3}
-
getServiceType
- Returns:
serviceType
(Broad categorization of the service that is to be provided (e.g. cardiology).)
-
setServiceType
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasServiceType
-
addServiceType
-
addServiceType
-
getServiceTypeFirstRep
- Returns:
- The first repetition of repeating field
serviceType
, creating it if it does not already exist {3}
-
getSubject
- Returns:
subject
(The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.)
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.)
-
getSubjectStatus
- Returns:
subjectStatus
(The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.)
-
hasSubjectStatus
-
setSubjectStatus
- Parameters:
value
-subjectStatus
(The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.)
-
getEpisodeOfCare
- 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 {3}
-
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 {3}
-
getCareTeam
- Returns:
careTeam
(The group(s) of individuals, organizations that are allocated to participate in this encounter. The participants backbone will record the actuals of when these individuals participated during the encounter.)
-
setCareTeam
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCareTeam
-
addCareTeam
-
addCareTeam
-
getCareTeamFirstRep
- Returns:
- The first repetition of repeating field
careTeam
, creating it if it does not already exist {3}
-
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).)
-
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.)
-
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 {3}
-
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 {3}
-
getVirtualService
- Returns:
virtualService
(Connection details of a virtual service (e.g. conference call).)
-
setVirtualService
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasVirtualService
-
addVirtualService
-
addVirtualService
-
getVirtualServiceFirstRep
- Returns:
- The first repetition of repeating field
virtualService
, creating it if it does not already exist {3}
-
getActualPeriod
- Returns:
actualPeriod
(The actual start and end time of the encounter.)
-
hasActualPeriod
-
setActualPeriod
- Parameters:
value
-actualPeriod
(The actual start and end time of the encounter.)
-
getPlannedStartDateElement
- Returns:
plannedStartDate
(The planned start date/time (or admission date) of the encounter.). This is the underlying object with id, value and extensions. The accessor "getPlannedStartDate" gives direct access to the value
-
hasPlannedStartDateElement
-
hasPlannedStartDate
-
setPlannedStartDateElement
- Parameters:
value
-plannedStartDate
(The planned start date/time (or admission date) of the encounter.). This is the underlying object with id, value and extensions. The accessor "getPlannedStartDate" gives direct access to the value
-
getPlannedStartDate
- Returns:
- The planned start date/time (or admission date) of the encounter.
-
setPlannedStartDate
- Parameters:
value
- The planned start date/time (or admission date) of the encounter.
-
getPlannedEndDateElement
- Returns:
plannedEndDate
(The planned end date/time (or discharge date) of the encounter.). This is the underlying object with id, value and extensions. The accessor "getPlannedEndDate" gives direct access to the value
-
hasPlannedEndDateElement
-
hasPlannedEndDate
-
setPlannedEndDateElement
- Parameters:
value
-plannedEndDate
(The planned end date/time (or discharge date) of the encounter.). This is the underlying object with id, value and extensions. The accessor "getPlannedEndDate" gives direct access to the value
-
getPlannedEndDate
- Returns:
- The planned end date/time (or discharge date) of the encounter.
-
setPlannedEndDate
- Parameters:
value
- The planned end date/time (or discharge date) of the encounter.
-
getLength
- Returns:
length
(Actual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values.)
-
hasLength
-
setLength
- Parameters:
value
-length
(Actual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values.)
-
getReason
- Returns:
reason
(Reason the encounter takes place, expressed as a code or a reference to another resource. For admissions, this can be used for a coded admission diagnosis.)
-
setReason
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReason
-
addReason
-
addReason
-
getReasonFirstRep
- Returns:
- The first repetition of repeating field
reason
, creating it if it does not already exist {3}
-
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 {3}
-
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 {3}
-
getAdmission
- Returns:
admission
(Details about the admission to a healthcare service.)
-
hasAdmission
-
setAdmission
- Parameters:
value
-admission
(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 {3}
-
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
-
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
-