Class Encounter
- java.lang.Object
-
- org.hl7.fhir.dstu2016may.model.Base
-
- org.hl7.fhir.dstu2016may.model.BaseResource
-
- org.hl7.fhir.dstu2016may.model.Resource
-
- org.hl7.fhir.dstu2016may.model.DomainResource
-
- org.hl7.fhir.dstu2016may.model.Encounter
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement,Serializable,org.hl7.fhir.instance.model.api.IAnyResource,org.hl7.fhir.instance.model.api.IBase,org.hl7.fhir.instance.model.api.IBaseHasExtensions,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions,org.hl7.fhir.instance.model.api.IBaseResource,org.hl7.fhir.instance.model.api.IDomainResource
public class Encounter extends DomainResource
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classEncounter.EncounterClassstatic classEncounter.EncounterClassEnumFactorystatic classEncounter.EncounterHospitalizationComponentstatic classEncounter.EncounterLocationComponentstatic classEncounter.EncounterLocationStatusstatic classEncounter.EncounterLocationStatusEnumFactorystatic classEncounter.EncounterParticipantComponentstatic classEncounter.EncounterStatestatic classEncounter.EncounterStateEnumFactorystatic classEncounter.EncounterStatusHistoryComponent
-
Field Summary
Fields Modifier and Type Field Description protected ReferenceappointmentThe appointment that scheduled this encounter.static ca.uhn.fhir.rest.gclient.ReferenceClientParamAPPOINTMENTFluent Client search parameter constant for appointmentprotected AppointmentappointmentTargetThe actual object that is the target of the reference (The appointment that scheduled this encounter.)protected Enumeration<Encounter.EncounterClass>class_inpatient | outpatient | ambulatory | emergency +.static ca.uhn.fhir.rest.gclient.ReferenceClientParamCONDITIONFluent Client search parameter constant for conditionstatic ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected List<Reference>episodeOfCareWhere a specific encounter should be classified as a part of a specific episode(s) of care this field should be used.static ca.uhn.fhir.rest.gclient.ReferenceClientParamEPISODEOFCAREFluent Client search parameter constant for episodeofcareprotected List<EpisodeOfCare>episodeOfCareTargetThe actual objects that are the target of the reference (Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used.protected Encounter.EncounterHospitalizationComponenthospitalizationDetails about the admission to a healthcare service.protected List<Identifier>identifierIdentifier(s) by which this encounter is known.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_APPOINTMENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_CONDITIONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_EPISODEOFCAREConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_INCOMINGREFERRALConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_INDICATIONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_LOCATIONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PART_OFConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PARTICIPANTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PRACTITIONERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PROCEDUREConstant for fluent queries to be used to add include statements.protected List<Reference>incomingReferralThe referral request this encounter satisfies (incoming referral).static ca.uhn.fhir.rest.gclient.ReferenceClientParamINCOMINGREFERRALFluent Client search parameter constant for incomingreferralprotected List<ReferralRequest>incomingReferralTargetThe actual objects that are the target of the reference (The referral request this encounter satisfies (incoming referral).)protected List<Reference>indicationReason the encounter takes place, as specified using information from another resource.static ca.uhn.fhir.rest.gclient.ReferenceClientParamINDICATIONFluent Client search parameter constant for indicationprotected List<Resource>indicationTargetThe actual objects that are the target of the reference (Reason the encounter takes place, as specified using information from another resource.protected DurationlengthQuantity of time the encounter lasted.static ca.uhn.fhir.rest.gclient.NumberClientParamLENGTHFluent Client search parameter constant for lengthprotected List<Encounter.EncounterLocationComponent>locationList of locations where the patient has been during this encounter.static ca.uhn.fhir.rest.gclient.ReferenceClientParamLOCATIONFluent Client search parameter constant for locationstatic ca.uhn.fhir.rest.gclient.DateClientParamLOCATION_PERIODFluent Client search parameter constant for location-periodstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamPART_OFFluent Client search parameter constant for part-ofprotected List<Encounter.EncounterParticipantComponent>participantThe list of people responsible for providing the service.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPARTICIPANTFluent Client search parameter constant for participantstatic ca.uhn.fhir.rest.gclient.TokenClientParamPARTICIPANT_TYPEFluent Client search parameter constant for participant-typeprotected ReferencepartOfAnother Encounter of which this encounter is a part of (administratively or in time).protected EncounterpartOfTargetThe actual object that is the target of the reference (Another Encounter of which this encounter is a part of (administratively or in time).)protected ReferencepatientThe patient present at the encounter.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected PatientpatientTargetThe actual object that is the target of the reference (The patient present at the encounter.)protected PeriodperiodThe start and end time of the encounter.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPRACTITIONERFluent Client search parameter constant for practitionerprotected CodeableConceptpriorityIndicates the urgency of the encounter.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPROCEDUREFluent Client search parameter constant for procedureprotected List<CodeableConcept>reasonReason the encounter takes place, expressed as a code.static ca.uhn.fhir.rest.gclient.TokenClientParamREASONFluent Client search parameter constant for reasonprotected ReferenceserviceProviderAn organization that is in charge of maintaining the information of this Encounter (e.g.protected OrganizationserviceProviderTargetThe actual object that is the target of the reference (An organization that is in charge of maintaining the information of this Encounter (e.g.static StringSP_APPOINTMENTSearch parameter: appointmentstatic StringSP_CONDITIONSearch parameter: conditionstatic StringSP_DATESearch parameter: datestatic StringSP_EPISODEOFCARESearch parameter: episodeofcarestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_INCOMINGREFERRALSearch parameter: incomingreferralstatic StringSP_INDICATIONSearch parameter: indicationstatic StringSP_LENGTHSearch parameter: lengthstatic StringSP_LOCATIONSearch parameter: locationstatic StringSP_LOCATION_PERIODSearch parameter: location-periodstatic StringSP_PART_OFSearch parameter: part-ofstatic StringSP_PARTICIPANTSearch parameter: participantstatic StringSP_PARTICIPANT_TYPESearch parameter: participant-typestatic StringSP_PATIENTSearch parameter: patientstatic StringSP_PRACTITIONERSearch parameter: practitionerstatic StringSP_PROCEDURESearch parameter: procedurestatic StringSP_REASONSearch parameter: reasonstatic StringSP_SPECIAL_ARRANGEMENTSearch parameter: special-arrangementstatic StringSP_STATUSSearch parameter: statusstatic StringSP_TYPESearch parameter: typestatic ca.uhn.fhir.rest.gclient.TokenClientParamSPECIAL_ARRANGEMENTFluent Client search parameter constant for special-arrangementprotected Enumeration<Encounter.EncounterState>statusplanned | arrived | in-progress | onleave | finished | cancelled.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected List<Encounter.EncounterStatusHistoryComponent>statusHistoryThe status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.protected List<CodeableConcept>typeSpecific type of encounter (e.g.static ca.uhn.fhir.rest.gclient.TokenClientParamTYPEFluent Client search parameter constant for type-
Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Encounter()ConstructorEncounter(Enumeration<Encounter.EncounterState> status)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource
getStructureFhirVersionEnum, setId
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Identifier(s) by which this encounter is known.
-
status
protected Enumeration<Encounter.EncounterState> status
planned | arrived | in-progress | onleave | finished | cancelled.
-
statusHistory
protected List<Encounter.EncounterStatusHistoryComponent> 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_
protected Enumeration<Encounter.EncounterClass> class_
inpatient | outpatient | ambulatory | emergency +.
-
type
protected List<CodeableConcept> type
Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
-
priority
protected CodeableConcept priority
Indicates the urgency of the encounter.
-
patientTarget
protected Patient patientTarget
The actual object that is the target of the reference (The patient present at the encounter.)
-
episodeOfCare
protected List<Reference> episodeOfCare
Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
-
episodeOfCareTarget
protected List<EpisodeOfCare> episodeOfCareTarget
The actual objects that are the target of the reference (Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).)
-
incomingReferral
protected List<Reference> incomingReferral
The referral request this encounter satisfies (incoming referral).
-
incomingReferralTarget
protected List<ReferralRequest> incomingReferralTarget
The actual objects that are the target of the reference (The referral request this encounter satisfies (incoming referral).)
-
participant
protected List<Encounter.EncounterParticipantComponent> participant
The list of people responsible for providing the service.
-
appointment
protected Reference appointment
The appointment that scheduled this encounter.
-
appointmentTarget
protected Appointment appointmentTarget
The actual object that is the target of the reference (The appointment that scheduled this encounter.)
-
length
protected Duration length
Quantity of time the encounter lasted. This excludes the time during leaves of absence.
-
reason
protected List<CodeableConcept> reason
Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
-
indication
protected List<Reference> indication
Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
-
indicationTarget
protected List<Resource> indicationTarget
The actual objects that are the target of the reference (Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.)
-
hospitalization
protected Encounter.EncounterHospitalizationComponent hospitalization
Details about the admission to a healthcare service.
-
location
protected List<Encounter.EncounterLocationComponent> location
List of locations where the patient has been during this encounter.
-
serviceProvider
protected Reference serviceProvider
An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.
-
serviceProviderTarget
protected Organization serviceProviderTarget
The actual object that is the target of the reference (An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.)
-
partOf
protected Reference partOf
Another Encounter of which this encounter is a part of (administratively or in time).
-
partOfTarget
protected Encounter partOfTarget
The actual object that is the target of the reference (Another Encounter of which this encounter is a part of (administratively or in time).)
-
SP_PARTICIPANT_TYPE
public static final String SP_PARTICIPANT_TYPE
Search parameter: participant-typeDescription: Role of participant in encounter
Type: token
Path: Encounter.participant.type
- See Also:
- Constant Field Values
-
PARTICIPANT_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam PARTICIPANT_TYPE
Fluent Client search parameter constant for participant-typeDescription: Role of participant in encounter
Type: token
Path: Encounter.participant.type
-
SP_EPISODEOFCARE
public static final String SP_EPISODEOFCARE
Search parameter: episodeofcareDescription: Episode(s) of care that this encounter should be recorded against
Type: reference
Path: Encounter.episodeOfCare
- See Also:
- Constant Field Values
-
EPISODEOFCARE
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam EPISODEOFCARE
Fluent Client search parameter constant for episodeofcareDescription: Episode(s) of care that this encounter should be recorded against
Type: reference
Path: Encounter.episodeOfCare
-
INCLUDE_EPISODEOFCARE
public static final ca.uhn.fhir.model.api.Include INCLUDE_EPISODEOFCARE
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:episodeofcare".
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: planned | arrived | in-progress | onleave | finished | cancelled
Type: token
Path: Encounter.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: planned | arrived | in-progress | onleave | finished | cancelled
Type: token
Path: Encounter.status
-
SP_REASON
public static final String SP_REASON
Search parameter: reasonDescription: Reason the encounter takes place (code)
Type: token
Path: Encounter.reason
- See Also:
- Constant Field Values
-
REASON
public static final ca.uhn.fhir.rest.gclient.TokenClientParam REASON
Fluent Client search parameter constant for reasonDescription: Reason the encounter takes place (code)
Type: token
Path: Encounter.reason
-
SP_CONDITION
public static final String SP_CONDITION
Search parameter: conditionDescription: Reason the encounter takes place (resource)
Type: reference
Path: Encounter.indication
- See Also:
- Constant Field Values
-
CONDITION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONDITION
Fluent Client search parameter constant for conditionDescription: Reason the encounter takes place (resource)
Type: reference
Path: Encounter.indication
-
INCLUDE_CONDITION
public static final ca.uhn.fhir.model.api.Include INCLUDE_CONDITION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:condition".
-
SP_LOCATION
public static final String SP_LOCATION
Search parameter: locationDescription: Location the encounter takes place
Type: reference
Path: Encounter.location.location
- See Also:
- Constant Field Values
-
LOCATION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam LOCATION
Fluent Client search parameter constant for locationDescription: Location the encounter takes place
Type: reference
Path: Encounter.location.location
-
INCLUDE_LOCATION
public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:location".
-
SP_INDICATION
public static final String SP_INDICATION
Search parameter: indicationDescription: Reason the encounter takes place (resource)
Type: reference
Path: Encounter.indication
- See Also:
- Constant Field Values
-
INDICATION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INDICATION
Fluent Client search parameter constant for indicationDescription: Reason the encounter takes place (resource)
Type: reference
Path: Encounter.indication
-
INCLUDE_INDICATION
public static final ca.uhn.fhir.model.api.Include INCLUDE_INDICATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:indication".
-
SP_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: Specific type of encounter
Type: token
Path: Encounter.type
- See Also:
- Constant Field Values
-
TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
Fluent Client search parameter constant for typeDescription: Specific type of encounter
Type: token
Path: Encounter.type
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: A date within the period the Encounter lasted
Type: date
Path: Encounter.period
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: A date within the period the Encounter lasted
Type: date
Path: Encounter.period
-
SP_SPECIAL_ARRANGEMENT
public static final String SP_SPECIAL_ARRANGEMENT
Search parameter: special-arrangementDescription: Wheelchair, translator, stretcher, etc.
Type: token
Path: Encounter.hospitalization.specialArrangement
- See Also:
- Constant Field Values
-
SPECIAL_ARRANGEMENT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SPECIAL_ARRANGEMENT
Fluent Client search parameter constant for special-arrangementDescription: Wheelchair, translator, stretcher, etc.
Type: token
Path: Encounter.hospitalization.specialArrangement
-
SP_PART_OF
public static final String SP_PART_OF
Search parameter: part-ofDescription: Another Encounter this encounter is part of
Type: reference
Path: Encounter.partOf
- See Also:
- Constant Field Values
-
PART_OF
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PART_OF
Fluent Client search parameter constant for part-ofDescription: Another Encounter this encounter is part of
Type: reference
Path: Encounter.partOf
-
INCLUDE_PART_OF
public static final ca.uhn.fhir.model.api.Include INCLUDE_PART_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:part-of".
-
SP_APPOINTMENT
public static final String SP_APPOINTMENT
Search parameter: appointmentDescription: The appointment that scheduled this encounter
Type: reference
Path: Encounter.appointment
- See Also:
- Constant Field Values
-
APPOINTMENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam APPOINTMENT
Fluent Client search parameter constant for appointmentDescription: The appointment that scheduled this encounter
Type: reference
Path: Encounter.appointment
-
INCLUDE_APPOINTMENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_APPOINTMENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:appointment".
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: The patient present at the encounter
Type: reference
Path: Encounter.patient
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: The patient present at the encounter
Type: reference
Path: Encounter.patient
-
INCLUDE_PATIENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:patient".
-
SP_PRACTITIONER
public static final String SP_PRACTITIONER
Search parameter: practitionerDescription: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.individual
- See Also:
- Constant Field Values
-
PRACTITIONER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRACTITIONER
Fluent Client search parameter constant for practitionerDescription: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.individual
-
INCLUDE_PRACTITIONER
public static final ca.uhn.fhir.model.api.Include INCLUDE_PRACTITIONER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:practitioner".
-
SP_LENGTH
public static final String SP_LENGTH
Search parameter: lengthDescription: Length of encounter in days
Type: number
Path: Encounter.length
- See Also:
- Constant Field Values
-
LENGTH
public static final ca.uhn.fhir.rest.gclient.NumberClientParam LENGTH
Fluent Client search parameter constant for lengthDescription: Length of encounter in days
Type: number
Path: Encounter.length
-
SP_PARTICIPANT
public static final String SP_PARTICIPANT
Search parameter: participantDescription: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.individual
- See Also:
- Constant Field Values
-
PARTICIPANT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARTICIPANT
Fluent Client search parameter constant for participantDescription: Persons involved in the encounter other than the patient
Type: reference
Path: Encounter.participant.individual
-
INCLUDE_PARTICIPANT
public static final ca.uhn.fhir.model.api.Include INCLUDE_PARTICIPANT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:participant".
-
SP_INCOMINGREFERRAL
public static final String SP_INCOMINGREFERRAL
Search parameter: incomingreferralDescription: The ReferralRequest that initiated this encounter
Type: reference
Path: Encounter.incomingReferral
- See Also:
- Constant Field Values
-
INCOMINGREFERRAL
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INCOMINGREFERRAL
Fluent Client search parameter constant for incomingreferralDescription: The ReferralRequest that initiated this encounter
Type: reference
Path: Encounter.incomingReferral
-
INCLUDE_INCOMINGREFERRAL
public static final ca.uhn.fhir.model.api.Include INCLUDE_INCOMINGREFERRAL
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:incomingreferral".
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Identifier(s) by which this encounter is known
Type: token
Path: Encounter.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Identifier(s) by which this encounter is known
Type: token
Path: Encounter.identifier
-
SP_PROCEDURE
public static final String SP_PROCEDURE
Search parameter: procedureDescription: Reason the encounter takes place (resource)
Type: reference
Path: Encounter.indication
- See Also:
- Constant Field Values
-
PROCEDURE
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PROCEDURE
Fluent Client search parameter constant for procedureDescription: Reason the encounter takes place (resource)
Type: reference
Path: Encounter.indication
-
INCLUDE_PROCEDURE
public static final ca.uhn.fhir.model.api.Include INCLUDE_PROCEDURE
Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:procedure".
-
SP_LOCATION_PERIOD
public static final String SP_LOCATION_PERIOD
Search parameter: location-periodDescription: Time period during which the patient was present at the location
Type: date
Path: Encounter.location.period
- See Also:
- Constant Field Values
-
LOCATION_PERIOD
public static final ca.uhn.fhir.rest.gclient.DateClientParam LOCATION_PERIOD
Fluent Client search parameter constant for location-periodDescription: Time period during which the patient was present at the location
Type: date
Path: Encounter.location.period
-
-
Constructor Detail
-
Encounter
public Encounter()
Constructor
-
Encounter
public Encounter(Enumeration<Encounter.EncounterState> status)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Identifier(s) by which this encounter is known.)
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
- Returns:
identifier(Identifier(s) by which this encounter is known.)
-
addIdentifier
public Encounter addIdentifier(Identifier t)
-
getStatusElement
public Enumeration<Encounter.EncounterState> getStatusElement()
- Returns:
status(planned | arrived | in-progress | onleave | finished | cancelled.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public Encounter setStatusElement(Enumeration<Encounter.EncounterState> value)
- Parameters:
value-status(planned | arrived | in-progress | onleave | finished | cancelled.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Encounter.EncounterState getStatus()
- Returns:
- planned | arrived | in-progress | onleave | finished | cancelled.
-
setStatus
public Encounter setStatus(Encounter.EncounterState value)
- Parameters:
value- planned | arrived | in-progress | onleave | finished | cancelled.
-
getStatusHistory
public List<Encounter.EncounterStatusHistoryComponent> getStatusHistory()
- Returns:
statusHistory(The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.)
-
hasStatusHistory
public boolean hasStatusHistory()
-
addStatusHistory
public Encounter.EncounterStatusHistoryComponent addStatusHistory()
- Returns:
statusHistory(The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.)
-
addStatusHistory
public Encounter addStatusHistory(Encounter.EncounterStatusHistoryComponent t)
-
getClass_Element
public Enumeration<Encounter.EncounterClass> getClass_Element()
- Returns:
class_(inpatient | outpatient | ambulatory | emergency +.). This is the underlying object with id, value and extensions. The accessor "getClass_" gives direct access to the value
-
hasClass_Element
public boolean hasClass_Element()
-
hasClass_
public boolean hasClass_()
-
setClass_Element
public Encounter setClass_Element(Enumeration<Encounter.EncounterClass> value)
- Parameters:
value-class_(inpatient | outpatient | ambulatory | emergency +.). This is the underlying object with id, value and extensions. The accessor "getClass_" gives direct access to the value
-
getClass_
public Encounter.EncounterClass getClass_()
- Returns:
- inpatient | outpatient | ambulatory | emergency +.
-
setClass_
public Encounter setClass_(Encounter.EncounterClass value)
- Parameters:
value- inpatient | outpatient | ambulatory | emergency +.
-
getType
public List<CodeableConcept> getType()
- Returns:
type(Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).)
-
hasType
public boolean hasType()
-
addType
public CodeableConcept addType()
- Returns:
type(Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).)
-
addType
public Encounter addType(CodeableConcept t)
-
getPriority
public CodeableConcept getPriority()
- Returns:
priority(Indicates the urgency of the encounter.)
-
hasPriority
public boolean hasPriority()
-
setPriority
public Encounter setPriority(CodeableConcept value)
- Parameters:
value-priority(Indicates the urgency of the encounter.)
-
getPatient
public Reference getPatient()
- Returns:
patient(The patient present at the encounter.)
-
hasPatient
public boolean hasPatient()
-
setPatient
public Encounter setPatient(Reference value)
- Parameters:
value-patient(The patient present at the encounter.)
-
getPatientTarget
public Patient getPatientTarget()
- Returns:
patientThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The patient present at the encounter.)
-
setPatientTarget
public Encounter setPatientTarget(Patient value)
- Parameters:
value-patientThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The patient present at the encounter.)
-
getEpisodeOfCare
public List<Reference> getEpisodeOfCare()
- Returns:
episodeOfCare(Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).)
-
hasEpisodeOfCare
public boolean hasEpisodeOfCare()
-
addEpisodeOfCare
public Reference addEpisodeOfCare()
- Returns:
episodeOfCare(Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).)
-
addEpisodeOfCare
public Encounter addEpisodeOfCare(Reference t)
-
getEpisodeOfCareTarget
public List<EpisodeOfCare> getEpisodeOfCareTarget()
- Returns:
episodeOfCare(The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).)
-
addEpisodeOfCareTarget
public EpisodeOfCare addEpisodeOfCareTarget()
- Returns:
episodeOfCare(Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).)
-
getIncomingReferral
public List<Reference> getIncomingReferral()
- Returns:
incomingReferral(The referral request this encounter satisfies (incoming referral).)
-
hasIncomingReferral
public boolean hasIncomingReferral()
-
addIncomingReferral
public Reference addIncomingReferral()
- Returns:
incomingReferral(The referral request this encounter satisfies (incoming referral).)
-
addIncomingReferral
public Encounter addIncomingReferral(Reference t)
-
getIncomingReferralTarget
public List<ReferralRequest> getIncomingReferralTarget()
- Returns:
incomingReferral(The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. The referral request this encounter satisfies (incoming referral).)
-
addIncomingReferralTarget
public ReferralRequest addIncomingReferralTarget()
- Returns:
incomingReferral(Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. The referral request this encounter satisfies (incoming referral).)
-
getParticipant
public List<Encounter.EncounterParticipantComponent> getParticipant()
- Returns:
participant(The list of people responsible for providing the service.)
-
hasParticipant
public boolean hasParticipant()
-
addParticipant
public Encounter.EncounterParticipantComponent addParticipant()
- Returns:
participant(The list of people responsible for providing the service.)
-
addParticipant
public Encounter addParticipant(Encounter.EncounterParticipantComponent t)
-
getAppointment
public Reference getAppointment()
- Returns:
appointment(The appointment that scheduled this encounter.)
-
hasAppointment
public boolean hasAppointment()
-
setAppointment
public Encounter setAppointment(Reference value)
- Parameters:
value-appointment(The appointment that scheduled this encounter.)
-
getAppointmentTarget
public Appointment getAppointmentTarget()
- Returns:
appointmentThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The appointment that scheduled this encounter.)
-
setAppointmentTarget
public Encounter setAppointmentTarget(Appointment value)
- Parameters:
value-appointmentThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The appointment that scheduled this encounter.)
-
hasPeriod
public boolean hasPeriod()
-
setPeriod
public Encounter setPeriod(Period value)
- Parameters:
value-period(The start and end time of the encounter.)
-
getLength
public Duration getLength()
- Returns:
length(Quantity of time the encounter lasted. This excludes the time during leaves of absence.)
-
hasLength
public boolean hasLength()
-
setLength
public Encounter setLength(Duration value)
- Parameters:
value-length(Quantity of time the encounter lasted. This excludes the time during leaves of absence.)
-
getReason
public List<CodeableConcept> getReason()
- Returns:
reason(Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.)
-
hasReason
public boolean hasReason()
-
addReason
public CodeableConcept addReason()
- Returns:
reason(Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.)
-
addReason
public Encounter addReason(CodeableConcept t)
-
getIndication
public List<Reference> getIndication()
- Returns:
indication(Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.)
-
hasIndication
public boolean hasIndication()
-
addIndication
public Reference addIndication()
- Returns:
indication(Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.)
-
addIndication
public Encounter addIndication(Reference t)
-
getIndicationTarget
public List<Resource> getIndicationTarget()
- Returns:
indication(The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.)
-
getHospitalization
public Encounter.EncounterHospitalizationComponent getHospitalization()
- Returns:
hospitalization(Details about the admission to a healthcare service.)
-
hasHospitalization
public boolean hasHospitalization()
-
setHospitalization
public Encounter setHospitalization(Encounter.EncounterHospitalizationComponent value)
- Parameters:
value-hospitalization(Details about the admission to a healthcare service.)
-
getLocation
public List<Encounter.EncounterLocationComponent> getLocation()
- Returns:
location(List of locations where the patient has been during this encounter.)
-
hasLocation
public boolean hasLocation()
-
addLocation
public Encounter.EncounterLocationComponent addLocation()
- Returns:
location(List of locations where the patient has been during this encounter.)
-
addLocation
public Encounter addLocation(Encounter.EncounterLocationComponent t)
-
getServiceProvider
public Reference getServiceProvider()
- Returns:
serviceProvider(An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.)
-
hasServiceProvider
public boolean hasServiceProvider()
-
setServiceProvider
public Encounter setServiceProvider(Reference value)
- Parameters:
value-serviceProvider(An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.)
-
getServiceProviderTarget
public Organization getServiceProviderTarget()
- Returns:
serviceProviderThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.)
-
setServiceProviderTarget
public Encounter setServiceProviderTarget(Organization value)
- Parameters:
value-serviceProviderThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.)
-
getPartOf
public Reference getPartOf()
- Returns:
partOf(Another Encounter of which this encounter is a part of (administratively or in time).)
-
hasPartOf
public boolean hasPartOf()
-
setPartOf
public Encounter setPartOf(Reference value)
- Parameters:
value-partOf(Another Encounter of which this encounter is a part of (administratively or in time).)
-
getPartOfTarget
public Encounter getPartOfTarget()
- Returns:
partOfThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Another Encounter of which this encounter is a part of (administratively or in time).)
-
setPartOfTarget
public Encounter setPartOfTarget(Encounter value)
- Parameters:
value-partOfThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Another Encounter of which this encounter is a part of (administratively or in time).)
-
listChildren
protected void listChildren(List<Property> childrenList)
- Overrides:
listChildrenin classDomainResource
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
Description copied from class:Basemake an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property- Overrides:
makePropertyin classDomainResource- Returns:
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Encounter copy()
- Specified by:
copyin classDomainResource
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-