Class 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:
    Serialized Form
    • Field Detail

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

        protected List<Resource> basedOnTarget
        The actual objects that are the target of the reference (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).
      • replacesTarget

        protected List<ServiceRequest> replacesTarget
        The actual objects that are the target of the reference (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.
      • category

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

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

        protected CodeableConcept code
        A code 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 Type 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).
      • subjectTarget

        protected Resource subjectTarget
        The actual object that is the target of the reference (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).)
      • encounter

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

        protected Encounter encounterTarget
        The actual object that is the target of the reference (An encounter that provides additional information about the healthcare context in which this request is made.)
      • occurrence

        protected Type occurrence
        The date/time at which the requested service should occur.
      • asNeeded

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

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

        protected Resource requesterTarget
        The actual object that is the target of the reference (The individual who initiated the request and has responsibility for its activation.)
      • performer

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

        protected List<Resource> performerTarget
        The actual objects that are the target of the reference (The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.)
      • locationCode

        protected List<CodeableConcept> locationCode
        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.
      • locationReference

        protected List<Reference> locationReference
        A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.
      • locationReferenceTarget

        protected List<Location> locationReferenceTarget
        The actual objects that are the target of the reference (A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.)
      • reasonCode

        protected List<CodeableConcept> reasonCode
        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`.
      • reasonReference

        protected List<Reference> reasonReference
        Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`.
      • reasonReferenceTarget

        protected List<Resource> reasonReferenceTarget
        The actual objects that are the target of the reference (Indicates another resource that provides a justification for why this service is being requested. 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.
      • insuranceTarget

        protected List<Resource> insuranceTarget
        The actual objects that are the target of the reference (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.
      • supportingInfoTarget

        protected List<Resource> supportingInfoTarget
        The actual objects that are the target of the reference (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.
      • specimenTarget

        protected List<Specimen> specimenTarget
        The actual objects that are the target of the reference (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.
      • note

        protected List<Annotation> note
        Any other notes and comments made about the service request. For example, internal billing notes.
      • 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_REQUESTER

        public static final String SP_REQUESTER
        Search parameter: requester

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

        See Also:
        Constant Field Values
      • 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_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: Identifiers assigned to this order
        Type: token
        Path: ServiceRequest.identifier

        See Also:
        Constant Field Values
      • IDENTIFIER

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

        Description: Identifiers assigned to this order
        Type: token
        Path: ServiceRequest.identifier

      • SP_CODE

        public static final String SP_CODE
        Search parameter: code

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

        See Also:
        Constant Field Values
      • CODE

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

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

      • SP_PERFORMER

        public static final String SP_PERFORMER
        Search parameter: performer

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

        See Also:
        Constant Field Values
      • 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".
      • 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_REPLACES

        public static final String SP_REPLACES
        Search parameter: replaces

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

        See Also:
        Constant Field Values
      • 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_SUBJECT

        public static final String SP_SUBJECT
        Search parameter: subject

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

        See Also:
        Constant Field Values
      • SUBJECT

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

        Description: 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_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:
        Constant Field Values
      • 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_ENCOUNTER

        public static final String SP_ENCOUNTER
        Search parameter: encounter

        Description: An encounter in which this request is made
        Type: reference
        Path: ServiceRequest.encounter

        See Also:
        Constant Field Values
      • ENCOUNTER

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

        Description: An encounter in which this request is made
        Type: reference
        Path: ServiceRequest.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_OCCURRENCE

        public static final String SP_OCCURRENCE
        Search parameter: occurrence

        Description: When service should occur
        Type: date
        Path: ServiceRequest.occurrence[x]

        See Also:
        Constant Field Values
      • 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[x]

      • SP_PRIORITY

        public static final String SP_PRIORITY
        Search parameter: priority

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

        See Also:
        Constant Field Values
      • 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_INTENT

        public static final String SP_INTENT
        Search parameter: intent

        Description: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
        Type: token
        Path: ServiceRequest.intent

        See Also:
        Constant Field Values
      • INTENT

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

        Description: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
        Type: token
        Path: ServiceRequest.intent

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

        public static final String SP_BASED_ON
        Search parameter: based-on

        Description: What request fulfills
        Type: reference
        Path: ServiceRequest.basedOn

        See Also:
        Constant Field Values
      • 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_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: Search by subject - a patient
        Type: reference
        Path: ServiceRequest.subject

        See Also:
        Constant Field Values
      • PATIENT

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

        Description: Search by subject - a patient
        Type: reference
        Path: ServiceRequest.subject

      • INCLUDE_PATIENT

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

        public static final String SP_SPECIMEN
        Search parameter: specimen

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

        See Also:
        Constant Field Values
      • 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_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:
        Constant Field Values
      • 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_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:
        Constant Field Values
      • 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_CATEGORY

        public static final String SP_CATEGORY
        Search parameter: category

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

        See Also:
        Constant Field Values
      • 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_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:
        Constant Field Values
      • 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