Class ReferralRequest

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 ReferralRequest extends DomainResource
Used to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.
See Also:
Serialized Form
  • Field Details

    • identifier

      Business identifier that uniquely identifies the referral/care transfer request instance.
    • definition

      A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
    • definitionTarget

      The actual objects that are the target of the reference (A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.)
    • basedOn

      protected List<Reference> basedOn
      Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.
    • basedOnTarget

      The actual objects that are the target of the reference (Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.)
    • replaces

      protected List<Reference> replaces
      Completed or terminated request(s) whose function is taken by this new request.
    • replacesTarget

      The actual objects that are the target of the reference (Completed or terminated request(s) whose function is taken by this new request.)
    • groupIdentifier

      The business identifier of the logical "grouping" request/order that this referral is a part of.
    • status

      The status of the authorization/intention reflected by the referral request record.
    • intent

      Distinguishes the "level" of authorization/demand implicit in this request.
    • type

      protected CodeableConcept type
      An indication of the type of referral (or where applicable the type of transfer of care) request.
    • priority

      An indication of the urgency of referral (or where applicable the type of transfer of care) request.
    • serviceRequested

      The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.
    • subject

      protected Reference subject
      The patient who is the subject of a referral or transfer of care request.
    • subjectTarget

      The actual object that is the target of the reference (The patient who is the subject of a referral or transfer of care request.)
    • context

      protected Reference context
      The encounter at which the request for referral or transfer of care is initiated.
    • contextTarget

      The actual object that is the target of the reference (The encounter at which the request for referral or transfer of care is initiated.)
    • occurrence

      protected Type occurrence
      The period of time within which the services identified in the referral/transfer of care is specified or required to occur.
    • authoredOn

      Date/DateTime of creation for draft requests and date of activation for active requests.
    • requester

      The individual who initiated the request and has responsibility for its activation.
    • specialty

      Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.
    • recipient

      protected List<Reference> recipient
      The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.
    • recipientTarget

      The actual objects that are the target of the reference (The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.)
    • reasonCode

      Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management.
    • reasonReference

      Indicates another resource whose existence justifies this request.
    • reasonReferenceTarget

      The actual objects that are the target of the reference (Indicates another resource whose existence justifies this request.)
    • description

      The reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.
    • supportingInfo

      Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan.
    • supportingInfoTarget

      The actual objects that are the target of the reference (Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan.)
    • note

      protected List<Annotation> note
      Comments made about the referral request by any of the participants.
    • relevantHistory

      Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.
    • relevantHistoryTarget

      The actual objects that are the target of the reference (Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.)
    • SP_REQUESTER

      public static final String SP_REQUESTER
      Search parameter: requester

      Description: Individual making the request
      Type: reference
      Path: ReferralRequest.requester.agent

      See Also:
      Constant Field Values
    • REQUESTER

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

      Description: Individual making the request
      Type: reference
      Path: ReferralRequest.requester.agent

    • 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 "ReferralRequest:requester".
    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: Business identifier
      Type: token
      Path: ReferralRequest.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: Business identifier
      Type: token
      Path: ReferralRequest.identifier

    • SP_SPECIALTY

      public static final String SP_SPECIALTY
      Search parameter: specialty

      Description: The specialty that the referral is for
      Type: token
      Path: ReferralRequest.specialty

      See Also:
      Constant Field Values
    • SPECIALTY

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

      Description: The specialty that the referral is for
      Type: token
      Path: ReferralRequest.specialty

    • SP_REPLACES

      public static final String SP_REPLACES
      Search parameter: replaces

      Description: Request(s) replaced by this request
      Type: reference
      Path: ReferralRequest.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: Request(s) replaced by this request
      Type: reference
      Path: ReferralRequest.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 "ReferralRequest:replaces".
    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

      Description: Patient referred to care or transfer
      Type: reference
      Path: ReferralRequest.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: Patient referred to care or transfer
      Type: reference
      Path: ReferralRequest.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 "ReferralRequest:subject".
    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter: encounter

      Description: Originating encounter
      Type: reference
      Path: ReferralRequest.context

      See Also:
      Constant Field Values
    • ENCOUNTER

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

      Description: Originating encounter
      Type: reference
      Path: ReferralRequest.context

    • 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 "ReferralRequest:encounter".
    • SP_AUTHORED_ON

      public static final String SP_AUTHORED_ON
      Search parameter: authored-on

      Description: Creation or activation date
      Type: date
      Path: ReferralRequest.authoredOn

      See Also:
      Constant Field Values
    • AUTHORED_ON

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

      Description: Creation or activation date
      Type: date
      Path: ReferralRequest.authoredOn

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter: type

      Description: The type of the referral
      Type: token
      Path: ReferralRequest.type

      See Also:
      Constant Field Values
    • TYPE

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

      Description: The type of the referral
      Type: token
      Path: ReferralRequest.type

    • SP_PRIORITY

      public static final String SP_PRIORITY
      Search parameter: priority

      Description: The priority assigned to the referral
      Type: token
      Path: ReferralRequest.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: The priority assigned to the referral
      Type: token
      Path: ReferralRequest.priority

    • SP_INTENT

      public static final String SP_INTENT
      Search parameter: intent

      Description: Proposal, plan or order
      Type: token
      Path: ReferralRequest.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 or order
      Type: token
      Path: ReferralRequest.intent

    • SP_GROUP_IDENTIFIER

      public static final String SP_GROUP_IDENTIFIER
      Search parameter: group-identifier

      Description: Part of common request
      Type: token
      Path: ReferralRequest.groupIdentifier

      See Also:
      Constant Field Values
    • GROUP_IDENTIFIER

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

      Description: Part of common request
      Type: token
      Path: ReferralRequest.groupIdentifier

    • SP_BASED_ON

      public static final String SP_BASED_ON
      Search parameter: based-on

      Description: Request being fulfilled
      Type: reference
      Path: ReferralRequest.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: Request being fulfilled
      Type: reference
      Path: ReferralRequest.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 "ReferralRequest:based-on".
    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: Who the referral is about
      Type: reference
      Path: ReferralRequest.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: Who the referral is about
      Type: reference
      Path: ReferralRequest.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 "ReferralRequest:patient".
    • SP_SERVICE

      public static final String SP_SERVICE
      Search parameter: service

      Description: Actions requested as part of the referral
      Type: token
      Path: ReferralRequest.serviceRequested

      See Also:
      Constant Field Values
    • SERVICE

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

      Description: Actions requested as part of the referral
      Type: token
      Path: ReferralRequest.serviceRequested

    • SP_OCCURRENCE_DATE

      public static final String SP_OCCURRENCE_DATE
      Search parameter: occurrence-date

      Description: When the service(s) requested in the referral should occur
      Type: date
      Path: ReferralRequest.occurrence[x]

      See Also:
      Constant Field Values
    • OCCURRENCE_DATE

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

      Description: When the service(s) requested in the referral should occur
      Type: date
      Path: ReferralRequest.occurrence[x]

    • SP_RECIPIENT

      public static final String SP_RECIPIENT
      Search parameter: recipient

      Description: The person that the referral was sent to
      Type: reference
      Path: ReferralRequest.recipient

      See Also:
      Constant Field Values
    • RECIPIENT

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

      Description: The person that the referral was sent to
      Type: reference
      Path: ReferralRequest.recipient

    • INCLUDE_RECIPIENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_RECIPIENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ReferralRequest:recipient".
    • SP_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: Part of encounter or episode of care
      Type: reference
      Path: ReferralRequest.context

      See Also:
      Constant Field Values
    • CONTEXT

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

      Description: Part of encounter or episode of care
      Type: reference
      Path: ReferralRequest.context

    • INCLUDE_CONTEXT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTEXT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ReferralRequest:context".
    • SP_DEFINITION

      public static final String SP_DEFINITION
      Search parameter: definition

      Description: Instantiates protocol or definition
      Type: reference
      Path: ReferralRequest.definition

      See Also:
      Constant Field Values
    • DEFINITION

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

      Description: Instantiates protocol or definition
      Type: reference
      Path: ReferralRequest.definition

    • INCLUDE_DEFINITION

      public static final ca.uhn.fhir.model.api.Include INCLUDE_DEFINITION
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ReferralRequest:definition".
    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The status of the referral
      Type: token
      Path: ReferralRequest.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: The status of the referral
      Type: token
      Path: ReferralRequest.status

  • Constructor Details

  • Method Details