Package com.ibm.fhir.model.resource

Class ServiceRequest

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class ServiceRequest
extends DomainResource
    A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

    Maturity level: FMM2 (Trial Use)

    • Method Detail

      • getIdentifier

        public java.util.List<Identifier> getIdentifier()
        Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getInstantiatesCanonical

        public java.util.List<Canonical> getInstantiatesCanonical()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type Canonical that may be empty.

      • getInstantiatesUri

        public java.util.List<Uri> getInstantiatesUri()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type Uri that may be empty.

      • getBasedOn

        public java.util.List<Reference> getBasedOn()
        Plan/proposal/order fulfilled by this request.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getReplaces

        public java.util.List<Reference> getReplaces()
        The request takes the place of the referenced completed or terminated request(s).
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getRequisition

        public Identifier getRequisition()
        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.
        Returns:
        An immutable object of type Identifier that may be null.

      • getIntent

        public ServiceRequestIntent getIntent()
        Whether the request is a proposal, plan, an original order or a reflex order.
        Returns:
        An immutable object of type ServiceRequestIntent that is non-null.

      • getCategory

        public java.util.List<CodeableConcept> getCategory()
        A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getPriority

        public ServiceRequestPriority getPriority()
        Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
        Returns:
        An immutable object of type ServiceRequestPriority that may be null.

      • getDoNotPerform

        public Boolean getDoNotPerform()
        Set this to true if the record is saying that the service/procedure should NOT be performed.
        Returns:
        An immutable object of type Boolean that may be null.

      • getCode

        public CodeableConcept getCode()
        A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getOrderDetail

        public java.util.List<CodeableConcept> getOrderDetail()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getQuantity

        public Element getQuantity()
        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).
        Returns:
        An immutable object of type Quantity, Ratio or Range that may be null.

      • getSubject

        public Reference getSubject()
        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).
        Returns:
        An immutable object of type Reference that is non-null.

      • getEncounter

        public Reference getEncounter()
        An encounter that provides additional information about the healthcare context in which this request is made.
        Returns:
        An immutable object of type Reference that may be null.

      • getOccurrence

        public Element getOccurrence()
        The date/time at which the requested service should occur.
        Returns:
        An immutable object of type DateTime, Period or Timing that may be null.

      • getAsNeeded

        public Element getAsNeeded()
        If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
        Returns:
        An immutable object of type Boolean or CodeableConcept that may be null.

      • getAuthoredOn

        public DateTime getAuthoredOn()
        When the request transitioned to being actionable.
        Returns:
        An immutable object of type DateTime that may be null.

      • getRequester

        public Reference getRequester()
        The individual who initiated the request and has responsibility for its activation.
        Returns:
        An immutable object of type Reference that may be null.

      • getPerformerType

        public CodeableConcept getPerformerType()
        Desired type of performer for doing the requested service.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getPerformer

        public java.util.List<Reference> getPerformer()
        The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getLocationCode

        public java.util.List<CodeableConcept> getLocationCode()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getLocationReference

        public java.util.List<Reference> getLocationReference()
        A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getReasonCode

        public java.util.List<CodeableConcept> getReasonCode()
        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`.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getReasonReference

        public java.util.List<Reference> getReasonReference()
        Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getInsurance

        public java.util.List<Reference> getInsurance()
        Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getSupportingInfo

        public java.util.List<Reference> getSupportingInfo()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getSpecimen

        public java.util.List<Reference> getSpecimen()
        One or more specimens that the laboratory procedure will use.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getBodySite

        public java.util.List<CodeableConcept> getBodySite()
        Anatomic location where the procedure should be performed. This is the target site.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getNote

        public java.util.List<Annotation> getNote()
        Any other notes and comments made about the service request. For example, internal billing notes.
        Returns:
        An unmodifiable list containing immutable objects of type Annotation that may be empty.

      • getPatientInstruction

        public String getPatientInstruction()
        Instructions in terms that are understood by the patient or consumer.
        Returns:
        An immutable object of type String that may be null.

      • getRelevantHistory

        public java.util.List<Reference> getRelevantHistory()
        Key events in the history of the request.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • accept

        public void accept​(java.lang.String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object