Package org.hl7.fhir.r5.model

Class CarePlan

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.CarePlan
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 CarePlan extends DomainResource
Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
See Also:

  • Field Details

    • identifier

      protected List<Identifier> identifier
      Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

    • instantiatesCanonical

      protected List<CanonicalType> instantiatesCanonical
      The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

    • instantiatesUri

      protected List<UriType> instantiatesUri
      The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

    • basedOn

      protected List<Reference> basedOn
      A higher-level request resource (i.e. a plan, proposal or order) that is fulfilled in whole or in part by this care plan.

    • replaces

      protected List<Reference> replaces
      Completed or terminated care plan whose function is taken by this new care plan.

    • partOf

      protected List<Reference> partOf
      A larger care plan of which this particular care plan is a component or step.

    • status

      protected Enumeration<Enumerations.RequestStatus> status
      Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

    • intent

      protected Enumeration<CarePlan.CarePlanIntent> intent
      Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.

    • category

      protected List<CodeableConcept> category
      Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.

    • title

      protected StringType title
      Human-friendly name for the care plan.

    • description

      protected StringType description
      A description of the scope and nature of the plan.

    • subject

      protected Reference subject
      Identifies the patient or group whose intended care is described by the plan.

    • encounter

      protected Reference encounter
      The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.

    • period

      protected Period period
      Indicates when the plan did (or is intended to) come into effect and end.

    • created

      protected DateTimeType created
      Represents when this particular CarePlan record was created in the system, which is often a system-generated date.

    • custodian

      protected Reference custodian
      When populated, the custodian is responsible for the care plan. The care plan is attributed to the custodian.

    • contributor

      protected List<Reference> contributor
      Identifies the individual(s), organization or device who provided the contents of the care plan.

    • careTeam

      protected List<Reference> careTeam
      Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

    • addresses

      protected List<CodeableReference> addresses
      Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.

    • supportingInfo

      protected List<Reference> supportingInfo
      Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.

    • goal

      protected List<Reference> goal
      Describes the intended objective(s) of carrying out the care plan.

    • activity

      protected List<CarePlan.CarePlanActivityComponent> activity
      Identifies an action that has occurred or is a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring that has occurred, education etc.

    • note

      protected List<Annotation> note
      General notes about the care plan not covered elsewhere.

    • SP_ACTIVITY_CODE

      public static final String SP_ACTIVITY_CODE
      Search parameter: activity-code

      Description: Detail type of activity
      Type: token
      Path: CarePlan.activity.plannedActivityDetail.code

      See Also:

    • ACTIVITY_CODE

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

      Description: Detail type of activity
      Type: token
      Path: CarePlan.activity.plannedActivityDetail.code

    • SP_ACTIVITY_REFERENCE

      public static final String SP_ACTIVITY_REFERENCE
      Search parameter: activity-reference

      Description: Activity that is intended to be part of the care plan
      Type: reference
      Path: CarePlan.activity.plannedActivityReference

      See Also:

    • ACTIVITY_REFERENCE

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

      Description: Activity that is intended to be part of the care plan
      Type: reference
      Path: CarePlan.activity.plannedActivityReference

    • INCLUDE_ACTIVITY_REFERENCE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ACTIVITY_REFERENCE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:activity-reference".

    • SP_ACTIVITY_SCHEDULED_DATE

      public static final String SP_ACTIVITY_SCHEDULED_DATE
      Search parameter: activity-scheduled-date

      Description: Specified date occurs within period specified by CarePlan.activity.plannedActivityDetail.scheduled[x]
      Type: date
      Path: CarePlan.activity.plannedActivityDetail.scheduled.ofType(Timing) | CarePlan.activity.plannedActivityDetail.scheduled.ofType(Period)

      See Also:

    • ACTIVITY_SCHEDULED_DATE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam ACTIVITY_SCHEDULED_DATE
      Fluent Client search parameter constant for activity-scheduled-date

      Description: Specified date occurs within period specified by CarePlan.activity.plannedActivityDetail.scheduled[x]
      Type: date
      Path: CarePlan.activity.plannedActivityDetail.scheduled.ofType(Timing) | CarePlan.activity.plannedActivityDetail.scheduled.ofType(Period)

    • SP_ACTIVITY_SCHEDULED_STRING

      public static final String SP_ACTIVITY_SCHEDULED_STRING
      Search parameter: activity-scheduled-string

      Description: When activity is to occur
      Type: string
      Path: CarePlan.activity.plannedActivityDetail.scheduled.ofType(string)

      See Also:

    • ACTIVITY_SCHEDULED_STRING

      public static final ca.uhn.fhir.rest.gclient.StringClientParam ACTIVITY_SCHEDULED_STRING
      Fluent Client search parameter constant for activity-scheduled-string

      Description: When activity is to occur
      Type: string
      Path: CarePlan.activity.plannedActivityDetail.scheduled.ofType(string)

    • SP_BASED_ON

      public static final String SP_BASED_ON
      Search parameter: based-on

      Description: Fulfills CarePlan
      Type: reference
      Path: CarePlan.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: Fulfills CarePlan
      Type: reference
      Path: CarePlan.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 "CarePlan:based-on".

    • SP_CARE_TEAM

      public static final String SP_CARE_TEAM
      Search parameter: care-team

      Description: Who's involved in plan?
      Type: reference
      Path: CarePlan.careTeam

      See Also:

    • CARE_TEAM

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CARE_TEAM
      Fluent Client search parameter constant for care-team

      Description: Who's involved in plan?
      Type: reference
      Path: CarePlan.careTeam

    • INCLUDE_CARE_TEAM

      public static final ca.uhn.fhir.model.api.Include INCLUDE_CARE_TEAM
      Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:care-team".

    • SP_CATEGORY

      public static final String SP_CATEGORY
      Search parameter: category

      Description: Type of plan
      Type: token
      Path: CarePlan.category

      See Also:

    • CATEGORY

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

      Description: Type of plan
      Type: token
      Path: CarePlan.category

    • SP_CONDITION

      public static final String SP_CONDITION
      Search parameter: condition

      Description: Reference to a resource (by instance)
      Type: reference
      Path: CarePlan.addresses.reference

      See Also:

    • CONDITION

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

      Description: Reference to a resource (by instance)
      Type: reference
      Path: CarePlan.addresses.reference

    • 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 "CarePlan:condition".

    • SP_CUSTODIAN

      public static final String SP_CUSTODIAN
      Search parameter: custodian

      Description: Who is the designated responsible party
      Type: reference
      Path: CarePlan.custodian

      See Also:

    • CUSTODIAN

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

      Description: Who is the designated responsible party
      Type: reference
      Path: CarePlan.custodian

    • INCLUDE_CUSTODIAN

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

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter: encounter

      Description: The Encounter during which this CarePlan was created
      Type: reference
      Path: CarePlan.encounter

      See Also:

    • ENCOUNTER

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

      Description: The Encounter during which this CarePlan was created
      Type: reference
      Path: CarePlan.encounter

    • INCLUDE_ENCOUNTER

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

    • SP_GOAL

      public static final String SP_GOAL
      Search parameter: goal

      Description: Desired outcome of plan
      Type: reference
      Path: CarePlan.goal

      See Also:

    • GOAL

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

      Description: Desired outcome of plan
      Type: reference
      Path: CarePlan.goal

    • INCLUDE_GOAL

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

    • SP_INSTANTIATES_CANONICAL

      public static final String SP_INSTANTIATES_CANONICAL
      Search parameter: instantiates-canonical

      Description: Instantiates FHIR protocol or definition
      Type: reference
      Path: CarePlan.instantiatesCanonical

      See Also:

    • INSTANTIATES_CANONICAL

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INSTANTIATES_CANONICAL
      Fluent Client search parameter constant for instantiates-canonical

      Description: Instantiates FHIR protocol or definition
      Type: reference
      Path: CarePlan.instantiatesCanonical

    • INCLUDE_INSTANTIATES_CANONICAL

      public static final ca.uhn.fhir.model.api.Include INCLUDE_INSTANTIATES_CANONICAL
      Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:instantiates-canonical".

    • SP_INSTANTIATES_URI

      public static final String SP_INSTANTIATES_URI
      Search parameter: instantiates-uri

      Description: Instantiates external protocol or definition
      Type: uri
      Path: CarePlan.instantiatesUri

      See Also:

    • INSTANTIATES_URI

      public static final ca.uhn.fhir.rest.gclient.UriClientParam INSTANTIATES_URI
      Fluent Client search parameter constant for instantiates-uri

      Description: Instantiates external protocol or definition
      Type: uri
      Path: CarePlan.instantiatesUri

    • SP_INTENT

      public static final String SP_INTENT
      Search parameter: intent

      Description: proposal | plan | order | option | directive
      Type: token
      Path: CarePlan.intent

      See Also:

    • INTENT

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

      Description: proposal | plan | order | option | directive
      Type: token
      Path: CarePlan.intent

    • SP_PART_OF

      public static final String SP_PART_OF
      Search parameter: part-of

      Description: Part of referenced CarePlan
      Type: reference
      Path: CarePlan.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: Part of referenced CarePlan
      Type: reference
      Path: CarePlan.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 "CarePlan:part-of".

    • SP_PERFORMER

      public static final String SP_PERFORMER
      Search parameter: performer

      Description: Matches if the practitioner is listed as a performer in any of the "simple" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)
      Type: reference
      Path: CarePlan.activity.plannedActivityDetail.performer

      See Also:

    • PERFORMER

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

      Description: Matches if the practitioner is listed as a performer in any of the "simple" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)
      Type: reference
      Path: CarePlan.activity.plannedActivityDetail.performer

    • INCLUDE_PERFORMER

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

    • SP_REPLACES

      public static final String SP_REPLACES
      Search parameter: replaces

      Description: CarePlan replaced by this CarePlan
      Type: reference
      Path: CarePlan.replaces

      See Also:

    • REPLACES

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

      Description: CarePlan replaced by this CarePlan
      Type: reference
      Path: CarePlan.replaces

    • INCLUDE_REPLACES

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

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: draft | active | on-hold | revoked | completed | entered-in-error | unknown
      Type: token
      Path: CarePlan.status

      See Also:

    • STATUS

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

      Description: draft | active | on-hold | revoked | completed | entered-in-error | unknown
      Type: token
      Path: CarePlan.status

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

      Description: Who the care plan is for
      Type: reference
      Path: CarePlan.subject

      See Also:

    • SUBJECT

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

      Description: Who the care plan is for
      Type: reference
      Path: CarePlan.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 "CarePlan: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 "CarePlan:patient".

  • Constructor Details

  • Method Details