Package org.hl7.fhir.r5.model

Class Encounter

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.BaseResource
org.hl7.fhir.r5.model.Resource
org.hl7.fhir.r5.model.DomainResource
org.hl7.fhir.r5.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 healthcare provider(s), and/or patient(s) for the purpose of providing healthcare service(s) or assessing the health status of patient(s).
See Also:

  • Field Details

    • identifier

      protected List<Identifier> identifier
      Identifier(s) by which this encounter is known.

    • status

      protected Enumeration<Encounter.EncounterStatus> status
      planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown.

    • 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 List<CodeableConcept> class_
      Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

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

      protected CodeableConcept priority
      Indicates the urgency of the encounter.

    • type

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

    • serviceType

      protected List<CodeableReference> serviceType
      Broad categorization of the service that is to be provided (e.g. cardiology).

    • subject

      protected Reference 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

      protected CodeableConcept 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

      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).

    • basedOn

      protected List<Reference> basedOn
      The request this encounter satisfies (e.g. incoming referral or procedure request).

    • careTeam

      protected List<Reference> 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

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

    • serviceProvider

      protected Reference 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

      protected List<Encounter.EncounterParticipantComponent> participant
      The list of people responsible for providing the service.

    • appointment

      protected List<Reference> appointment
      The appointment that scheduled this encounter.

    • virtualService

      protected List<VirtualServiceDetail> virtualService
      Connection details of a virtual service (e.g. conference call).

    • actualPeriod

      protected Period actualPeriod
      The actual start and end time of the encounter.

    • plannedStartDate

      protected DateTimeType plannedStartDate
      The planned start date/time (or admission date) of the encounter.

    • plannedEndDate

      protected DateTimeType plannedEndDate
      The planned end date/time (or discharge date) of the encounter.

    • length

      protected Duration 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

      protected List<CodeableReference> 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

      protected List<Encounter.DiagnosisComponent> diagnosis
      The list of diagnosis relevant to this encounter.

    • account

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

    • admission

      protected Encounter.EncounterAdmissionComponent admission
      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.

    • SP_ACCOUNT

      public static final String SP_ACCOUNT
      Search parameter: account

      Description: The set of accounts that may be used for billing for this Encounter
      Type: reference
      Path: Encounter.account

      See Also:

    • ACCOUNT

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

      Description: The set of accounts that may be used for billing for this Encounter
      Type: reference
      Path: Encounter.account

    • INCLUDE_ACCOUNT

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

    • 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:

    • 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_BASED_ON

      public static final String SP_BASED_ON
      Search parameter: based-on

      Description: The ServiceRequest that initiated this encounter
      Type: reference
      Path: Encounter.basedOn

      See Also:

    • BASED_ON

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON
      Fluent Client search parameter constant for based-on

      Description: The ServiceRequest that initiated this encounter
      Type: reference
      Path: Encounter.basedOn

    • INCLUDE_BASED_ON

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

    • SP_CARETEAM

      public static final String SP_CARETEAM
      Search parameter: careteam

      Description: Careteam allocated to participate in the encounter
      Type: reference
      Path: Encounter.careTeam

      See Also:

    • CARETEAM

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

      Description: Careteam allocated to participate in the encounter
      Type: reference
      Path: Encounter.careTeam

    • INCLUDE_CARETEAM

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

    • SP_CLASS

      public static final String SP_CLASS
      Search parameter: class

      Description: Classification of patient encounter
      Type: token
      Path: Encounter.class

      See Also:

    • CLASS

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

      Description: Classification of patient encounter
      Type: token
      Path: Encounter.class

    • SP_DATE_START

      public static final String SP_DATE_START
      Search parameter: date-start

      Description: The actual start date of the Encounter
      Type: date
      Path: Encounter.actualPeriod.start

      See Also:

    • DATE_START

      public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE_START
      Fluent Client search parameter constant for date-start

      Description: The actual start date of the Encounter
      Type: date
      Path: Encounter.actualPeriod.start

    • SP_DIAGNOSIS

      public static final String SP_DIAGNOSIS
      Search parameter: diagnosis

      Description: The diagnosis or procedure relevant to the encounter
      Type: reference
      Path: Encounter.diagnosis.condition

      See Also:

    • DIAGNOSIS

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

      Description: The diagnosis or procedure relevant to the encounter
      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_END_DATE

      public static final String SP_END_DATE
      Search parameter: end-date

      Description: The actual end date of the Encounter
      Type: date
      Path: Encounter.actualPeriod.end

      See Also:

    • END_DATE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam END_DATE
      Fluent Client search parameter constant for end-date

      Description: The actual end date of the Encounter
      Type: date
      Path: Encounter.actualPeriod.end

    • SP_EPISODE_OF_CARE

      public static final String SP_EPISODE_OF_CARE
      Search parameter: episode-of-care

      Description: Episode(s) of care that this encounter should be recorded against
      Type: reference
      Path: Encounter.episodeOfCare

      See Also:

    • EPISODE_OF_CARE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam EPISODE_OF_CARE
      Fluent Client search parameter constant for episode-of-care

      Description: Episode(s) of care that this encounter should be recorded against
      Type: reference
      Path: Encounter.episodeOfCare

    • INCLUDE_EPISODE_OF_CARE

      public static final ca.uhn.fhir.model.api.Include 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

      public static final String SP_LENGTH
      Search parameter: length

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

      See Also:

    • LENGTH

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam LENGTH
      Fluent Client search parameter constant for length

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

    • 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:

    • 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:

    • 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_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:

    • 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_PARTICIPANT_TYPE

      public static final String SP_PARTICIPANT_TYPE
      Search parameter: participant-type

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

      See Also:

    • 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_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.actor

      See Also:

    • 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.actor

    • 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_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.actor.where(resolve() is Practitioner)

      See Also:

    • 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.actor.where(resolve() is Practitioner)

    • 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_REASON_CODE

      public static final String SP_REASON_CODE
      Search parameter: reason-code

      Description: Reference to a concept (by class)
      Type: token
      Path: Encounter.reason.concept

      See Also:

    • REASON_CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam REASON_CODE
      Fluent Client search parameter constant for reason-code

      Description: Reference to a concept (by class)
      Type: token
      Path: Encounter.reason.concept

    • SP_REASON_REFERENCE

      public static final String SP_REASON_REFERENCE
      Search parameter: reason-reference

      Description: Reference to a resource (by instance)
      Type: reference
      Path: Encounter.reason.reference

      See Also:

    • REASON_REFERENCE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REASON_REFERENCE
      Fluent Client search parameter constant for reason-reference

      Description: Reference to a resource (by instance)
      Type: reference
      Path: Encounter.reason.reference

    • INCLUDE_REASON_REFERENCE

      public static final ca.uhn.fhir.model.api.Include 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

      public static final String SP_SERVICE_PROVIDER
      Search parameter: service-provider

      Description: The organization (facility) responsible for this encounter
      Type: reference
      Path: Encounter.serviceProvider

      See Also:

    • SERVICE_PROVIDER

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

      Description: The organization (facility) responsible for this encounter
      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.admission.specialArrangement

      See Also:

    • 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.admission.specialArrangement

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: planned | in-progress | on-hold | completed | cancelled | entered-in-error | unknown
      Type: token
      Path: Encounter.status

      See Also:

    • STATUS

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

      Description: planned | in-progress | on-hold | completed | cancelled | entered-in-error | unknown
      Type: token
      Path: Encounter.status

    • SP_SUBJECT_STATUS

      public static final String SP_SUBJECT_STATUS
      Search parameter: subject-status

      Description: The current status of the subject in relation to the Encounter
      Type: token
      Path: Encounter.subjectStatus

      See Also:

    • SUBJECT_STATUS

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

      Description: The current status of the subject in relation to the Encounter
      Type: token
      Path: Encounter.subjectStatus

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

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

      See Also:

    • SUBJECT

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

      Description: The patient or 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_DATE

      public static final String SP_DATE
      Search parameter: date

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

      public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
      Fluent Client search parameter constant for date

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

      public static final String SP_IDENTIFIER
      Search parameter: identifier

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

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

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

      public static final String SP_PATIENT
      Search parameter: patient

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

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

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

      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_TYPE

      public static final String SP_TYPE
      Search parameter: type

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

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

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

  • Method Details