public class Encounter extends BaseResource implements IResource
Definition: 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.
Requirements:
Profile Definition: http://hl7.org/fhir/profiles/Encounter
| Modifier and Type | Class and Description |
|---|---|
static class |
Encounter.Hospitalization
Block class for child element: Encounter.hospitalization (Details about an admission to a clinic)
|
static class |
Encounter.HospitalizationAccomodation
Block class for child element: Encounter.hospitalization.accomodation (Where the patient stays during this encounter)
|
static class |
Encounter.Location
Block class for child element: Encounter.location (List of locations the patient has been at)
|
static class |
Encounter.Participant
Block class for child element: Encounter.participant (List of participants involved in the encounter)
|
| Modifier and Type | Field and Description |
|---|---|
static DateClientParam |
DATE
Fluent Client search parameter constant for date
|
static TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static Include |
INCLUDE_INDICATION
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_LOCATION_LOCATION
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.
|
static ReferenceClientParam |
INDICATION
Fluent Client search parameter constant for indication
|
static NumberClientParam |
LENGTH
Fluent Client search parameter constant for length
|
static ReferenceClientParam |
LOCATION
Fluent Client search parameter constant for location
|
static DateClientParam |
LOCATION_PERIOD
Fluent Client search parameter constant for location-period
|
static String |
SP_DATE
Search parameter constant for date
|
static String |
SP_IDENTIFIER
Search parameter constant for identifier
|
static String |
SP_INDICATION
Search parameter constant for indication
|
static String |
SP_LENGTH
Search parameter constant for length
|
static String |
SP_LOCATION
Search parameter constant for location
|
static String |
SP_LOCATION_PERIOD
Search parameter constant for location-period
|
static String |
SP_STATUS
Search parameter constant for status
|
static String |
SP_SUBJECT
Search parameter constant for subject
|
static TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
static ReferenceClientParam |
SUBJECT
Fluent Client search parameter constant for subject
|
SP_RES_ID, SP_RES_LANGUAGE| Constructor and Description |
|---|
Encounter() |
| Modifier and Type | Method and Description |
|---|---|
IdentifierDt |
addIdentifier()
Adds and returns a new value for identifier (Identifier(s) by which this encounter is known)
|
Encounter |
addIdentifier(IdentifierUseEnum theUse,
String theSystem,
String theValue,
String theLabel)
Adds a new value for identifier (Identifier(s) by which this encounter is known)
|
Encounter |
addIdentifier(String theSystem,
String theValue)
Adds a new value for identifier (Identifier(s) by which this encounter is known)
|
Encounter.Location |
addLocation()
Adds and returns a new value for location (List of locations the patient has been at)
|
Encounter.Participant |
addParticipant()
Adds and returns a new value for participant (List of participants involved in the encounter)
|
BoundCodeableConceptDt<EncounterTypeEnum> |
addType()
Add a value for type (Specific type of encounter)
|
BoundCodeableConceptDt<EncounterTypeEnum> |
addType(EncounterTypeEnum theValue)
Add a value for type (Specific type of encounter) using an enumerated type.
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType)
Returns a list containing all child elements matching a given type
|
BoundCodeDt<EncounterClassEnum> |
getClassElement()
Gets the value(s) for class (inpatient | outpatient | ambulatory | emergency +).
|
Encounter.Hospitalization |
getHospitalization()
Gets the value(s) for hospitalization (Details about an admission to a clinic).
|
List<IdentifierDt> |
getIdentifier()
Gets the value(s) for identifier (Identifier(s) by which this encounter is known).
|
IdentifierDt |
getIdentifierFirstRep()
Gets the first repetition for identifier (Identifier(s) by which this encounter is known),
creating it if it does not already exist.
|
ResourceReferenceDt |
getIndication()
Gets the value(s) for indication (Reason the encounter takes place (resource)).
|
DurationDt |
getLength()
Gets the value(s) for length (Quantity of time the encounter lasted).
|
List<Encounter.Location> |
getLocation()
Gets the value(s) for location (List of locations the patient has been at).
|
Encounter.Location |
getLocationFirstRep()
Gets the first repetition for location (List of locations the patient has been at),
creating it if it does not already exist.
|
List<Encounter.Participant> |
getParticipant()
Gets the value(s) for participant (List of participants involved in the encounter).
|
Encounter.Participant |
getParticipantFirstRep()
Gets the first repetition for participant (List of participants involved in the encounter),
creating it if it does not already exist.
|
ResourceReferenceDt |
getPartOf()
Gets the value(s) for partOf (Another Encounter this encounter is part of).
|
PeriodDt |
getPeriod()
Gets the value(s) for period (The start and end time of the encounter).
|
CodeableConceptDt |
getPriority()
Gets the value(s) for priority (Indicates the urgency of the encounter).
|
BoundCodeableConceptDt<EncounterReasonCodesEnum> |
getReason()
Gets the value(s) for reason (Reason the encounter takes place (code)).
|
ResourceReferenceDt |
getServiceProvider()
Gets the value(s) for serviceProvider (Department or team providing care).
|
BoundCodeDt<EncounterStateEnum> |
getStatus()
Gets the value(s) for status (planned | in progress | onleave | finished | cancelled).
|
ResourceReferenceDt |
getSubject()
Gets the value(s) for subject (The patient present at the encounter).
|
List<BoundCodeableConceptDt<EncounterTypeEnum>> |
getType()
Gets the value(s) for type (Specific type of encounter).
|
BoundCodeableConceptDt<EncounterTypeEnum> |
getTypeFirstRep()
Gets the first repetition for type (Specific type of encounter),
creating it if it does not already exist.
|
boolean |
isEmpty() |
Encounter |
setClassElement(BoundCodeDt<EncounterClassEnum> theValue)
Sets the value(s) for class (inpatient | outpatient | ambulatory | emergency +)
|
Encounter |
setClassElement(EncounterClassEnum theValue)
Sets the value(s) for class (inpatient | outpatient | ambulatory | emergency +)
|
Encounter |
setHospitalization(Encounter.Hospitalization theValue)
Sets the value(s) for hospitalization (Details about an admission to a clinic)
|
Encounter |
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier (Identifier(s) by which this encounter is known)
|
Encounter |
setIndication(ResourceReferenceDt theValue)
Sets the value(s) for indication (Reason the encounter takes place (resource))
|
Encounter |
setLength(DurationDt theValue)
Sets the value(s) for length (Quantity of time the encounter lasted)
|
Encounter |
setLocation(List<Encounter.Location> theValue)
Sets the value(s) for location (List of locations the patient has been at)
|
Encounter |
setParticipant(List<Encounter.Participant> theValue)
Sets the value(s) for participant (List of participants involved in the encounter)
|
Encounter |
setPartOf(ResourceReferenceDt theValue)
Sets the value(s) for partOf (Another Encounter this encounter is part of)
|
Encounter |
setPeriod(PeriodDt theValue)
Sets the value(s) for period (The start and end time of the encounter)
|
Encounter |
setPriority(CodeableConceptDt theValue)
Sets the value(s) for priority (Indicates the urgency of the encounter)
|
Encounter |
setReason(BoundCodeableConceptDt<EncounterReasonCodesEnum> theValue)
Sets the value(s) for reason (Reason the encounter takes place (code))
|
Encounter |
setReason(EncounterReasonCodesEnum theValue)
Sets the value(s) for reason (Reason the encounter takes place (code))
|
Encounter |
setServiceProvider(ResourceReferenceDt theValue)
Sets the value(s) for serviceProvider (Department or team providing care)
|
Encounter |
setStatus(BoundCodeDt<EncounterStateEnum> theValue)
Sets the value(s) for status (planned | in progress | onleave | finished | cancelled)
|
Encounter |
setStatus(EncounterStateEnum theValue)
Sets the value(s) for status (planned | in progress | onleave | finished | cancelled)
|
Encounter |
setSubject(ResourceReferenceDt theValue)
Sets the value(s) for subject (The patient present at the encounter)
|
Encounter |
setType(EncounterTypeEnum theValue)
Sets the value(s), and clears any existing value(s) for type (Specific type of encounter)
|
Encounter |
setType(List<BoundCodeableConceptDt<EncounterTypeEnum>> theValue)
Sets the value(s) for type (Specific type of encounter)
|
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatapublic static final String SP_IDENTIFIER
Description:
Type: token
Path: Encounter.identifier
public static final TokenClientParam IDENTIFIER
Description:
Type: token
Path: Encounter.identifier
public static final String SP_STATUS
Description:
Type: token
Path: Encounter.status
public static final TokenClientParam STATUS
Description:
Type: token
Path: Encounter.status
public static final String SP_DATE
Description: A date within the period the Encounter lasted
Type: date
Path: Encounter.period
public static final DateClientParam DATE
Description: A date within the period the Encounter lasted
Type: date
Path: Encounter.period
public static final String SP_SUBJECT
Description:
Type: reference
Path: Encounter.subject
public static final ReferenceClientParam SUBJECT
Description:
Type: reference
Path: Encounter.subject
public static final Include INCLUDE_SUBJECT
public static final String SP_LENGTH
Description: Length of encounter in days
Type: number
Path: Encounter.length
public static final NumberClientParam LENGTH
Description: Length of encounter in days
Type: number
Path: Encounter.length
public static final String SP_INDICATION
Description:
Type: reference
Path: Encounter.indication
public static final ReferenceClientParam INDICATION
Description:
Type: reference
Path: Encounter.indication
public static final Include INCLUDE_INDICATION
public static final String SP_LOCATION
Description:
Type: reference
Path: Encounter.location.location
public static final ReferenceClientParam LOCATION
Description:
Type: reference
Path: Encounter.location.location
public static final Include INCLUDE_LOCATION_LOCATION
public static final String SP_LOCATION_PERIOD
Description:
Type: date
Path: Encounter.location.period
public static final DateClientParam LOCATION_PERIOD
Description:
Type: date
Path: Encounter.location.period
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
ICompositeElementgetAllPopulatedChildElementsOfType in interface ICompositeElementtheType - The type to match. If set to null, all child elements will be returnedpublic List<IdentifierDt> getIdentifier()
null.
Definition:
public Encounter setIdentifier(List<IdentifierDt> theValue)
Definition:
public IdentifierDt addIdentifier()
Definition:
public IdentifierDt getIdentifierFirstRep()
Definition:
public Encounter addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)
Definition:
public Encounter addIdentifier(String theSystem, String theValue)
Definition:
public BoundCodeDt<EncounterStateEnum> getStatus()
null.
Definition:
public Encounter setStatus(BoundCodeDt<EncounterStateEnum> theValue)
Definition:
public Encounter setStatus(EncounterStateEnum theValue)
Definition:
public BoundCodeDt<EncounterClassEnum> getClassElement()
null.
Definition:
public Encounter setClassElement(BoundCodeDt<EncounterClassEnum> theValue)
Definition:
public Encounter setClassElement(EncounterClassEnum theValue)
Definition:
public List<BoundCodeableConceptDt<EncounterTypeEnum>> getType()
null.
Definition: Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)
public Encounter setType(List<BoundCodeableConceptDt<EncounterTypeEnum>> theValue)
Definition: Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)
public BoundCodeableConceptDt<EncounterTypeEnum> addType(EncounterTypeEnum theValue)
addType() method.
Definition: Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)
public BoundCodeableConceptDt<EncounterTypeEnum> getTypeFirstRep()
Definition: Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)
public BoundCodeableConceptDt<EncounterTypeEnum> addType()
Definition: Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)
public Encounter setType(EncounterTypeEnum theValue)
Definition: Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)
public ResourceReferenceDt getSubject()
null.
Definition:
public Encounter setSubject(ResourceReferenceDt theValue)
Definition:
public List<Encounter.Participant> getParticipant()
null.
Definition: The main practitioner responsible for providing the service
public Encounter setParticipant(List<Encounter.Participant> theValue)
Definition: The main practitioner responsible for providing the service
public Encounter.Participant addParticipant()
Definition: The main practitioner responsible for providing the service
public Encounter.Participant getParticipantFirstRep()
Definition: The main practitioner responsible for providing the service
public PeriodDt getPeriod()
null.
Definition: The start and end time of the encounter
public Encounter setPeriod(PeriodDt theValue)
Definition: The start and end time of the encounter
public DurationDt getLength()
null.
Definition: Quantity of time the encounter lasted. This excludes the time during leaves of absence.
public Encounter setLength(DurationDt theValue)
Definition: Quantity of time the encounter lasted. This excludes the time during leaves of absence.
public BoundCodeableConceptDt<EncounterReasonCodesEnum> getReason()
null.
Definition: Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
public Encounter setReason(BoundCodeableConceptDt<EncounterReasonCodesEnum> theValue)
Definition: Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
public Encounter setReason(EncounterReasonCodesEnum theValue)
Definition: Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
public ResourceReferenceDt getIndication()
null.
Definition: Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis.
public Encounter setIndication(ResourceReferenceDt theValue)
Definition: Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis.
public CodeableConceptDt getPriority()
null.
Definition:
public Encounter setPriority(CodeableConceptDt theValue)
Definition:
public Encounter.Hospitalization getHospitalization()
null.
Definition: Details about an admission to a clinic
public Encounter setHospitalization(Encounter.Hospitalization theValue)
Definition: Details about an admission to a clinic
public List<Encounter.Location> getLocation()
null.
Definition: List of locations at which the patient has been
public Encounter setLocation(List<Encounter.Location> theValue)
Definition: List of locations at which the patient has been
public Encounter.Location addLocation()
Definition: List of locations at which the patient has been
public Encounter.Location getLocationFirstRep()
Definition: List of locations at which the patient has been
public ResourceReferenceDt getServiceProvider()
null.
Definition:
public Encounter setServiceProvider(ResourceReferenceDt theValue)
Definition:
public ResourceReferenceDt getPartOf()
null.
Definition: Another Encounter of which this encounter is a part of (administratively or in time).
public Encounter setPartOf(ResourceReferenceDt theValue)
Definition: Another Encounter of which this encounter is a part of (administratively or in time).
Copyright © 2014 University Health Network. All rights reserved.