Package org.hl7.fhir.r5.model

Class ServiceRequest

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.ServiceRequest
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 ServiceRequest extends DomainResource
A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
See Also:

  • Field Details

    • identifier

      protected List<Identifier> identifier
      Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.

    • instantiatesCanonical

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

    • instantiatesUri

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

    • basedOn

      protected List<Reference> basedOn
      Plan/proposal/order fulfilled by this request.

    • replaces

      protected List<Reference> replaces
      The request takes the place of the referenced completed or terminated request(s).

    • requisition

      protected Identifier requisition
      A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.

    • status

      protected Enumeration<Enumerations.RequestStatus> status
      The status of the order.

    • intent

      protected Enumeration<Enumerations.RequestIntent> intent
      Whether the request is a proposal, plan, an original order or a reflex order.

    • category

      protected List<CodeableConcept> category
      A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").

    • priority

      protected Enumeration<Enumerations.RequestPriority> priority
      Indicates how quickly the ServiceRequest should be addressed with respect to other requests.

    • doNotPerform

      protected BooleanType doNotPerform
      Set this to true if the record is saying that the service/procedure should NOT be performed.

    • code

      protected CodeableReference code
      A code or reference that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.

    • orderDetail

      protected List<CodeableConcept> orderDetail
      Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.

    • quantity

      protected DataType quantity
      An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).

    • subject

      protected Reference subject
      On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).

    • focus

      protected List<Reference> focus
      The actual focus of a service request when it is not the subject of record representing something or someone associated with the subject such as a spouse, parent, fetus, or donor. The focus of a service request could also be an existing condition, an intervention, the subject's diet, another service request on the subject, or a body structure such as tumor or implanted device.

    • encounter

      protected Reference encounter
      An encounter that provides additional information about the healthcare context in which this request is made.

    • occurrence

      protected DataType occurrence
      The date/time at which the requested service should occur.

    • asNeeded

      protected DataType asNeeded
      If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.

    • authoredOn

      protected DateTimeType authoredOn
      When the request transitioned to being actionable.

    • requester

      protected Reference requester
      The individual who initiated the request and has responsibility for its activation.

    • performerType

      protected CodeableConcept performerType
      Desired type of performer for doing the requested service.

    • performer

      protected List<Reference> performer
      The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.

    • location

      protected List<CodeableReference> location
      The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.

    • reason

      protected List<CodeableReference> reason
      An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`.

    • insurance

      protected List<Reference> insurance
      Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.

    • supportingInfo

      protected List<Reference> supportingInfo
      Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.

    • specimen

      protected List<Reference> specimen
      One or more specimens that the laboratory procedure will use.

    • bodySite

      protected List<CodeableConcept> bodySite
      Anatomic location where the procedure should be performed. This is the target site.

    • bodyStructure

      protected Reference bodyStructure
      Anatomic location where the procedure should be performed. This is the target site.

    • note

      protected List<Annotation> note
      Any other notes and comments made about the service request. For example, internal billing notes.

    • patientInstruction

      protected StringType patientInstruction
      Instructions in terms that are understood by the patient or consumer.

    • relevantHistory

      protected List<Reference> relevantHistory
      Key events in the history of the request.

    • SP_AUTHORED

      public static final String SP_AUTHORED
      Search parameter: authored

      Description: Date request signed
      Type: date
      Path: ServiceRequest.authoredOn

      See Also:

    • AUTHORED

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

      Description: Date request signed
      Type: date
      Path: ServiceRequest.authoredOn

    • SP_BASED_ON

      public static final String SP_BASED_ON
      Search parameter: based-on

      Description: What request fulfills
      Type: reference
      Path: ServiceRequest.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: What request fulfills
      Type: reference
      Path: ServiceRequest.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 "ServiceRequest:based-on".

    • SP_BODY_SITE

      public static final String SP_BODY_SITE
      Search parameter: body-site

      Description: Where procedure is going to be done
      Type: token
      Path: ServiceRequest.bodySite

      See Also:

    • BODY_SITE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam BODY_SITE
      Fluent Client search parameter constant for body-site

      Description: Where procedure is going to be done
      Type: token
      Path: ServiceRequest.bodySite

    • SP_BODY_STRUCTURE

      public static final String SP_BODY_STRUCTURE
      Search parameter: body-structure

      Description: Body structure Where procedure is going to be done
      Type: reference
      Path: ServiceRequest.bodyStructure

      See Also:

    • BODY_STRUCTURE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BODY_STRUCTURE
      Fluent Client search parameter constant for body-structure

      Description: Body structure Where procedure is going to be done
      Type: reference
      Path: ServiceRequest.bodyStructure

    • INCLUDE_BODY_STRUCTURE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_BODY_STRUCTURE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ServiceRequest:body-structure".

    • SP_CATEGORY

      public static final String SP_CATEGORY
      Search parameter: category

      Description: Classification of service
      Type: token
      Path: ServiceRequest.category

      See Also:

    • CATEGORY

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

      Description: Classification of service
      Type: token
      Path: ServiceRequest.category

    • SP_CODE_CONCEPT

      public static final String SP_CODE_CONCEPT
      Search parameter: code-concept

      Description: What is being requested/ordered
      Type: token
      Path: ServiceRequest.code.concept

      See Also:

    • CODE_CONCEPT

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

      Description: What is being requested/ordered
      Type: token
      Path: ServiceRequest.code.concept

    • SP_CODE_REFERENCE

      public static final String SP_CODE_REFERENCE
      Search parameter: code-reference

      Description: What is being requested/ordered
      Type: reference
      Path: ServiceRequest.code.reference

      See Also:

    • CODE_REFERENCE

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

      Description: What is being requested/ordered
      Type: reference
      Path: ServiceRequest.code.reference

    • INCLUDE_CODE_REFERENCE

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

    • SP_INSTANTIATES_CANONICAL

      public static final String SP_INSTANTIATES_CANONICAL
      Search parameter: instantiates-canonical

      Description: Instantiates FHIR protocol or definition
      Type: reference
      Path: ServiceRequest.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: ServiceRequest.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 "ServiceRequest: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: ServiceRequest.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: ServiceRequest.instantiatesUri

    • SP_INTENT

      public static final String SP_INTENT
      Search parameter: intent

      Description: proposal | plan | directive | order +
      Type: token
      Path: ServiceRequest.intent

      See Also:

    • INTENT

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

      Description: proposal | plan | directive | order +
      Type: token
      Path: ServiceRequest.intent

    • SP_OCCURRENCE

      public static final String SP_OCCURRENCE
      Search parameter: occurrence

      Description: When service should occur
      Type: date
      Path: ServiceRequest.occurrence.as(dateTime) | ServiceRequest.occurrence.as(Period) | ServiceRequest.occurrence.as(Timing)

      See Also:

    • OCCURRENCE

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

      Description: When service should occur
      Type: date
      Path: ServiceRequest.occurrence.as(dateTime) | ServiceRequest.occurrence.as(Period) | ServiceRequest.occurrence.as(Timing)

    • SP_PERFORMER_TYPE

      public static final String SP_PERFORMER_TYPE
      Search parameter: performer-type

      Description: Performer role
      Type: token
      Path: ServiceRequest.performerType

      See Also:

    • PERFORMER_TYPE

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

      Description: Performer role
      Type: token
      Path: ServiceRequest.performerType

    • SP_PERFORMER

      public static final String SP_PERFORMER
      Search parameter: performer

      Description: Requested performer
      Type: reference
      Path: ServiceRequest.performer

      See Also:

    • PERFORMER

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

      Description: Requested performer
      Type: reference
      Path: ServiceRequest.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 "ServiceRequest:performer".

    • SP_PRIORITY

      public static final String SP_PRIORITY
      Search parameter: priority

      Description: routine | urgent | asap | stat
      Type: token
      Path: ServiceRequest.priority

      See Also:

    • PRIORITY

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

      Description: routine | urgent | asap | stat
      Type: token
      Path: ServiceRequest.priority

    • SP_REPLACES

      public static final String SP_REPLACES
      Search parameter: replaces

      Description: What request replaces
      Type: reference
      Path: ServiceRequest.replaces

      See Also:

    • REPLACES

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

      Description: What request replaces
      Type: reference
      Path: ServiceRequest.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 "ServiceRequest:replaces".

    • SP_REQUESTER

      public static final String SP_REQUESTER
      Search parameter: requester

      Description: Who/what is requesting service
      Type: reference
      Path: ServiceRequest.requester

      See Also:

    • REQUESTER

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

      Description: Who/what is requesting service
      Type: reference
      Path: ServiceRequest.requester

    • INCLUDE_REQUESTER

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

    • SP_REQUISITION

      public static final String SP_REQUISITION
      Search parameter: requisition

      Description: Composite Request ID
      Type: token
      Path: ServiceRequest.requisition

      See Also:

    • REQUISITION

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

      Description: Composite Request ID
      Type: token
      Path: ServiceRequest.requisition

    • SP_SPECIMEN

      public static final String SP_SPECIMEN
      Search parameter: specimen

      Description: Specimen to be tested
      Type: reference
      Path: ServiceRequest.specimen

      See Also:

    • SPECIMEN

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

      Description: Specimen to be tested
      Type: reference
      Path: ServiceRequest.specimen

    • INCLUDE_SPECIMEN

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

    • 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: ServiceRequest.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: ServiceRequest.status

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

      Description: Search by subject
      Type: reference
      Path: ServiceRequest.subject

      See Also:

    • SUBJECT

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

      Description: Search by subject
      Type: reference
      Path: ServiceRequest.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 "ServiceRequest:subject".

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter: encounter

      Description: Multiple Resources: [Composition](composition.html): Context of the Composition [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [Flag](flag.html): Alert relevant during encounter [List](list.html): Context in which list created [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
      Type: reference
      Path: Composition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | Flag.encounter | List.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | RiskAssessment.encounter | ServiceRequest.encounter | VisionPrescription.encounter

      See Also:

    • ENCOUNTER

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

      Description: Multiple Resources: [Composition](composition.html): Context of the Composition [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [Flag](flag.html): Alert relevant during encounter [List](list.html): Context in which list created [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
      Type: reference
      Path: Composition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | Flag.encounter | List.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | RiskAssessment.encounter | ServiceRequest.encounter | VisionPrescription.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 "ServiceRequest:encounter".

    • 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 "ServiceRequest:patient".

  • Constructor Details

  • Method Details