Class ReferralRequest

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class ReferralRequest
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR ReferralRequest Resource (clinical.careprovision)

    Definition: 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.

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/ReferralRequest

    See Also:
    Serialized Form
    • Field Detail

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter constant for 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

      • SP_DATE

        public static final String SP_DATE
        Search parameter constant for date

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

        See Also:
        Constant Field Values
      • DATE

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

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

      • SP_TYPE

        public static final String SP_TYPE
        Search parameter constant for 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_SPECIALTY

        public static final String SP_SPECIALTY
        Search parameter constant for 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_PRIORITY

        public static final String SP_PRIORITY
        Search parameter constant for 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_RECIPIENT

        public static final String SP_RECIPIENT
        Search parameter constant for 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

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter constant for patient

        Description: Who the referral is about
        Type: reference
        Path: ReferralRequest.patient

        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.patient

      • REQUESTER

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

        Description:
        Type: reference
        Path: ReferralRequest.requester

      • 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".
      • 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".
      • 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".
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<ReferralStatusEnumgetStatusElement()
        Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

        Definition: The workflow status of the referral or transfer of care request

      • getStatus

        public String getStatus()
        Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

        Definition: The workflow status of the referral or transfer of care request

      • setStatus

        public ReferralRequest setStatus​(ca.uhn.fhir.model.primitive.BoundCodeDt<ReferralStatusEnum> theValue)
        Sets the value(s) for status (status)

        Definition: The workflow status of the referral or transfer of care request

      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

        Definition: Business identifier that uniquely identifies the referral/care transfer request instance

      • setIdentifier

        public ReferralRequest setIdentifier​(List<IdentifierDt> theValue)
        Sets the value(s) for identifier (id)

        Definition: Business identifier that uniquely identifies the referral/care transfer request instance

      • addIdentifier

        public IdentifierDt addIdentifier()
        Adds and returns a new value for identifier (id)

        Definition: Business identifier that uniquely identifies the referral/care transfer request instance

      • addIdentifier

        public ReferralRequest addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier (id)

        Definition: Business identifier that uniquely identifies the referral/care transfer request instance

        Parameters:
        theValue - The identifier to add (must not be null)
      • getIdentifierFirstRep

        public IdentifierDt getIdentifierFirstRep()
        Gets the first repetition for identifier (id), creating it if it does not already exist.

        Definition: Business identifier that uniquely identifies the referral/care transfer request instance

      • getDateElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getDateElement()
        Gets the value(s) for date (when.init). creating it if it does not exist. Will not return null.

        Definition: Date/DateTime of creation for draft requests and date of activation for active requests

      • getDate

        public Date getDate()
        Gets the value(s) for date (when.init). creating it if it does not exist. This method may return null.

        Definition: Date/DateTime of creation for draft requests and date of activation for active requests

      • setDate

        public ReferralRequest setDate​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for date (when.init)

        Definition: Date/DateTime of creation for draft requests and date of activation for active requests

      • setDate

        public ReferralRequest setDate​(Date theDate,
                                       ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for date (when.init)

        Definition: Date/DateTime of creation for draft requests and date of activation for active requests

      • setDateWithSecondsPrecision

        public ReferralRequest setDateWithSecondsPrecision​(Date theDate)
        Sets the value for date (when.init)

        Definition: Date/DateTime of creation for draft requests and date of activation for active requests

      • getType

        public CodeableConceptDt getType()
        Gets the value(s) for type (class). creating it if it does not exist. Will not return null.

        Definition: An indication of the type of referral (or where applicable the type of transfer of care) request

      • setType

        public ReferralRequest setType​(CodeableConceptDt theValue)
        Sets the value(s) for type (class)

        Definition: An indication of the type of referral (or where applicable the type of transfer of care) request

      • getSpecialty

        public CodeableConceptDt getSpecialty()
        Gets the value(s) for specialty (). creating it if it does not exist. Will not return null.

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

      • setSpecialty

        public ReferralRequest setSpecialty​(CodeableConceptDt theValue)
        Sets the value(s) for specialty ()

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

      • getPriority

        public CodeableConceptDt getPriority()
        Gets the value(s) for priority (grade). creating it if it does not exist. Will not return null.

        Definition: An indication of the urgency of referral (or where applicable the type of transfer of care) request

      • setPriority

        public ReferralRequest setPriority​(CodeableConceptDt theValue)
        Sets the value(s) for priority (grade)

        Definition: An indication of the urgency of referral (or where applicable the type of transfer of care) request

      • getPatient

        public ResourceReferenceDt getPatient()
        Gets the value(s) for patient (who.focus). creating it if it does not exist. Will not return null.

        Definition: The patient who is the subject of a referral or transfer of care request

      • getRequester

        public ResourceReferenceDt getRequester()
        Gets the value(s) for requester (who.author). creating it if it does not exist. Will not return null.

        Definition: The healthcare provider or provider organization who/which initiated the referral/transfer of care request. Can also be Patient (a self referral)

      • setRequester

        public ReferralRequest setRequester​(ResourceReferenceDt theValue)
        Sets the value(s) for requester (who.author)

        Definition: The healthcare provider or provider organization who/which initiated the referral/transfer of care request. Can also be Patient (a self referral)

      • getRecipient

        public List<ResourceReferenceDtgetRecipient()
        Gets the value(s) for recipient (who.actor). creating it if it does not exist. Will not return null.

        Definition: The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request

      • setRecipient

        public ReferralRequest setRecipient​(List<ResourceReferenceDt> theValue)
        Sets the value(s) for recipient (who.actor)

        Definition: The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request

      • addRecipient

        public ResourceReferenceDt addRecipient()
        Adds and returns a new value for recipient (who.actor)

        Definition: The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request

      • getEncounter

        public ResourceReferenceDt getEncounter()
        Gets the value(s) for encounter (context). creating it if it does not exist. Will not return null.

        Definition: The encounter at which the request for referral or transfer of care is initiated

      • getDateSentElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getDateSentElement()
        Gets the value(s) for dateSent (when.init). creating it if it does not exist. Will not return null.

        Definition: Date/DateTime the request for referral or transfer of care is sent by the author

      • getDateSent

        public Date getDateSent()
        Gets the value(s) for dateSent (when.init). creating it if it does not exist. This method may return null.

        Definition: Date/DateTime the request for referral or transfer of care is sent by the author

      • setDateSent

        public ReferralRequest setDateSent​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for dateSent (when.init)

        Definition: Date/DateTime the request for referral or transfer of care is sent by the author

      • setDateSent

        public ReferralRequest setDateSent​(Date theDate,
                                           ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for dateSent (when.init)

        Definition: Date/DateTime the request for referral or transfer of care is sent by the author

      • getReason

        public CodeableConceptDt getReason()
        Gets the value(s) for reason (why). creating it if it does not exist. Will not return null.

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

      • setReason

        public ReferralRequest setReason​(CodeableConceptDt theValue)
        Sets the value(s) for reason (why)

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

      • getDescriptionElement

        public ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
        Gets the value(s) for description (). creating it if it does not exist. Will not return null.

        Definition: 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

      • getDescription

        public String getDescription()
        Gets the value(s) for description (). creating it if it does not exist. This method may return null.

        Definition: 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

      • setDescription

        public ReferralRequest setDescription​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for description ()

        Definition: 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

      • setDescription

        public ReferralRequest setDescription​(String theString)
        Sets the value for description ()

        Definition: 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

      • getServiceRequested

        public List<CodeableConceptDtgetServiceRequested()
        Gets the value(s) for serviceRequested (what). creating it if it does not exist. Will not return null.

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

      • addServiceRequested

        public CodeableConceptDt addServiceRequested()
        Adds and returns a new value for serviceRequested (what)

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

      • addServiceRequested

        public ReferralRequest addServiceRequested​(CodeableConceptDt theValue)
        Adds a given new value for serviceRequested (what)

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

        Parameters:
        theValue - The serviceRequested to add (must not be null)
      • getServiceRequestedFirstRep

        public CodeableConceptDt getServiceRequestedFirstRep()
        Gets the first repetition for serviceRequested (what), creating it if it does not already exist.

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

      • getSupportingInformation

        public List<ResourceReferenceDtgetSupportingInformation()
        Gets the value(s) for supportingInformation (). creating it if it does not exist. Will not return null.

        Definition: 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

      • setSupportingInformation

        public ReferralRequest setSupportingInformation​(List<ResourceReferenceDt> theValue)
        Sets the value(s) for supportingInformation ()

        Definition: 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

      • addSupportingInformation

        public ResourceReferenceDt addSupportingInformation()
        Adds and returns a new value for supportingInformation ()

        Definition: 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

      • getFulfillmentTime

        public PeriodDt getFulfillmentTime()
        Gets the value(s) for fulfillmentTime (when.planned). creating it if it does not exist. Will not return null.

        Definition: The period of time within which the services identified in the referral/transfer of care is specified or required to occur

      • setFulfillmentTime

        public ReferralRequest setFulfillmentTime​(PeriodDt theValue)
        Sets the value(s) for fulfillmentTime (when.planned)

        Definition: The period of time within which the services identified in the referral/transfer of care is specified or required to occur

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource