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

    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
    • Field Detail

      • statusHistory

        protected List<Encounter.StatusHistoryComponent> statusHistory
        The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
      • class_

        protected Coding class_
        inpatient | outpatient | ambulatory | emergency +.
      • classHistory

        protected List<Encounter.ClassHistoryComponent> classHistory
        The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transisions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kindof discharge from emergency to inpatient.
      • type

        protected List<CodeableConcept> type
        Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
      • subject

        protected Reference subject
        The patient ro group present at the encounter.
      • subjectTarget

        protected Resource subjectTarget
        The actual object that is the target of the reference (The patient ro group present at the encounter.)
      • episodeOfCare

        protected List<Reference> episodeOfCare
        Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
      • episodeOfCareTarget

        protected List<EpisodeOfCare> episodeOfCareTarget
        The actual objects that are the target of the reference (Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).)
      • incomingReferralTarget

        protected List<ReferralRequest> incomingReferralTarget
        The actual objects that are the target of the reference (The referral request this encounter satisfies (incoming referral).)
      • appointmentTarget

        protected Appointment appointmentTarget
        The actual object that is the target of the reference (The appointment that scheduled this encounter.)
      • period

        protected Period period
        The start and end time of the 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.
      • account

        protected List<Reference> account
        The set of accounts that may be used for billing for this Encounter.
      • accountTarget

        protected List<Account> accountTarget
        The actual objects that are the target of the reference (The set of accounts that may be used for billing for this Encounter.)
      • serviceProvider

        protected Reference serviceProvider
        An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.
      • serviceProviderTarget

        protected Organization serviceProviderTarget
        The actual object that is the target of the reference (An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.)
      • partOf

        protected Reference partOf
        Another Encounter of which this encounter is a part of (administratively or in time).
      • partOfTarget

        protected Encounter partOfTarget
        The actual object that is the target of the reference (Another Encounter of which this encounter is a part of (administratively or in time).)
      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: 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 date

        Description: A date within the period the Encounter lasted
        Type: date
        Path: Encounter.period

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: 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 identifier

        Description: Identifier(s) by which this encounter is known
        Type: token
        Path: Encounter.identifier

      • SP_REASON

        public static final String SP_REASON
        Search parameter: reason

        Description: 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 reason

        Description: Reason the encounter takes place (code)
        Type: token
        Path: Encounter.reason

      • SP_EPISODEOFCARE

        public static final String SP_EPISODEOFCARE
        Search parameter: episodeofcare

        Description: 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 episodeofcare

        Description: 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".
      • PARTICIPANT_TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam PARTICIPANT_TYPE
        Fluent Client search parameter constant for participant-type

        Description: Role of participant in encounter
        Type: token
        Path: Encounter.participant.type

      • SP_INCOMINGREFERRAL

        public static final String SP_INCOMINGREFERRAL
        Search parameter: incomingreferral

        Description: 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 incomingreferral

        Description: The ReferralRequest that initiated this encounter
        Type: reference
        Path: Encounter.incomingReferral

      • INCLUDE_INCOMINGREFERRAL

        public static final ca.uhn.fhir.model.api.Include INCLUDE_INCOMINGREFERRAL
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:incomingreferral".
      • SP_PRACTITIONER

        public static final String SP_PRACTITIONER
        Search parameter: practitioner

        Description: 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 practitioner

        Description: Persons involved in the encounter other than the patient
        Type: reference
        Path: Encounter.participant.individual

      • INCLUDE_PRACTITIONER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PRACTITIONER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:practitioner".
      • SP_SUBJECT

        public static final String SP_SUBJECT
        Search parameter: subject

        Description: The patient ro group present at the encounter
        Type: reference
        Path: Encounter.subject

        See Also:
        Constant Field Values
      • SUBJECT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
        Fluent Client search parameter constant for subject

        Description: The patient ro group present at the encounter
        Type: reference
        Path: Encounter.subject

      • INCLUDE_SUBJECT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:subject".
      • SP_LENGTH

        public static final String SP_LENGTH
        Search parameter: length

        Description: 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 length

        Description: Length of encounter in days
        Type: number
        Path: Encounter.length

      • SP_DIAGNOSIS

        public static final String SP_DIAGNOSIS
        Search parameter: diagnosis

        Description: Reason the encounter takes place (resource)
        Type: reference
        Path: Encounter.diagnosis.condition

        See Also:
        Constant Field Values
      • DIAGNOSIS

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DIAGNOSIS
        Fluent Client search parameter constant for diagnosis

        Description: Reason the encounter takes place (resource)
        Type: reference
        Path: Encounter.diagnosis.condition

      • INCLUDE_DIAGNOSIS

        public static final ca.uhn.fhir.model.api.Include INCLUDE_DIAGNOSIS
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:diagnosis".
      • SP_APPOINTMENT

        public static final String SP_APPOINTMENT
        Search parameter: appointment

        Description: 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 appointment

        Description: The appointment that scheduled this encounter
        Type: reference
        Path: Encounter.appointment

      • INCLUDE_APPOINTMENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_APPOINTMENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:appointment".
      • SP_PART_OF

        public static final String SP_PART_OF
        Search parameter: part-of

        Description: 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-of

        Description: Another Encounter this encounter is part of
        Type: reference
        Path: Encounter.partOf

      • INCLUDE_PART_OF

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PART_OF
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:part-of".
      • SP_TYPE

        public static final String SP_TYPE
        Search parameter: type

        Description: 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 type

        Description: Specific type of encounter
        Type: token
        Path: Encounter.type

      • SP_PARTICIPANT

        public static final String SP_PARTICIPANT
        Search parameter: participant

        Description: 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 participant

        Description: Persons involved in the encounter other than the patient
        Type: reference
        Path: Encounter.participant.individual

      • INCLUDE_PARTICIPANT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PARTICIPANT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:participant".
      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: The patient ro group present at the encounter
        Type: reference
        Path: Encounter.subject

        See Also:
        Constant Field Values
      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description: The patient ro group present at the encounter
        Type: reference
        Path: Encounter.subject

      • INCLUDE_PATIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:patient".
      • SP_LOCATION_PERIOD

        public static final String SP_LOCATION_PERIOD
        Search parameter: location-period

        Description: 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-period

        Description: Time period during which the patient was present at the location
        Type: date
        Path: Encounter.location.period

      • SP_LOCATION

        public static final String SP_LOCATION
        Search parameter: location

        Description: 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 location

        Description: Location the encounter takes place
        Type: reference
        Path: Encounter.location.location

      • INCLUDE_LOCATION

        public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:location".
      • SP_SERVICE_PROVIDER

        public static final String SP_SERVICE_PROVIDER
        Search parameter: service-provider

        Description: The custodian organization of this Encounter record
        Type: reference
        Path: Encounter.serviceProvider

        See Also:
        Constant Field Values
      • SERVICE_PROVIDER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SERVICE_PROVIDER
        Fluent Client search parameter constant for service-provider

        Description: The custodian organization of this Encounter record
        Type: reference
        Path: Encounter.serviceProvider

      • INCLUDE_SERVICE_PROVIDER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SERVICE_PROVIDER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Encounter:service-provider".
      • SP_SPECIAL_ARRANGEMENT

        public static final String SP_SPECIAL_ARRANGEMENT
        Search parameter: special-arrangement

        Description: 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-arrangement

        Description: Wheelchair, translator, stretcher, etc.
        Type: token
        Path: Encounter.hospitalization.specialArrangement

      • SP_CLASS

        public static final String SP_CLASS
        Search parameter: class

        Description: inpatient | outpatient | ambulatory | emergency +
        Type: token
        Path: Encounter.class

        See Also:
        Constant Field Values
      • CLASS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CLASS
        Fluent Client search parameter constant for class

        Description: inpatient | outpatient | ambulatory | emergency +
        Type: token
        Path: Encounter.class

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
        Type: token
        Path: Encounter.status

        See Also:
        Constant Field Values
      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
        Type: token
        Path: Encounter.status