Package org.hl7.fhir.dstu2.model

Class ReferralRequest

java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.BaseResource
org.hl7.fhir.dstu2.model.Resource
org.hl7.fhir.dstu2.model.DomainResource
org.hl7.fhir.dstu2.model.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:

  • Field Details

    • status

      protected Enumeration<ReferralRequest.ReferralStatus> status
      The workflow status of the referral or transfer of care request.

    • identifier

      protected List<Identifier> identifier
      Business identifier that uniquely identifies the referral/care transfer request instance.

    • date

      protected DateTimeType date
      Date/DateTime of creation for draft requests and date of activation for active requests.

    • type

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

    • specialty

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

    • priority

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

    • patient

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

    • patientTarget

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

    • requester

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

    • requesterTarget

      protected Resource requesterTarget
      The actual object that is the target of the reference (The healthcare provider or provider organization who/which initiated the referral/transfer of care request. Can also be Patient (a self referral).)

    • 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

      protected List<Resource> 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.)

    • encounter

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

    • encounterTarget

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

    • dateSent

      protected DateTimeType dateSent
      Date/DateTime the request for referral or transfer of care is sent by the author.

    • reason

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

    • description

      protected StringType 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.

    • serviceRequested

      protected List<CodeableConcept> serviceRequested
      The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.

    • supportingInformation

      protected List<Reference> supportingInformation
      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.

    • supportingInformationTarget

      protected List<Resource> supportingInformationTarget
      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.)

    • fulfillmentTime

      protected Period fulfillmentTime
      The period of time within which the services identified in the referral/transfer of care is specified or required to occur.

    • SP_DATE

      public static final String SP_DATE
      See Also:

    • SP_REQUESTER

      public static final String SP_REQUESTER
      See Also:

    • SP_SPECIALTY

      public static final String SP_SPECIALTY
      See Also:

    • SP_PATIENT

      public static final String SP_PATIENT
      See Also:

    • SP_RECIPIENT

      public static final String SP_RECIPIENT
      See Also:

    • SP_TYPE

      public static final String SP_TYPE
      See Also:

    • SP_PRIORITY

      public static final String SP_PRIORITY
      See Also:

    • SP_STATUS

      public static final String SP_STATUS
      See Also:

  • Constructor Details

  • Method Details

    • getStatusElement

      public Enumeration<ReferralRequest.ReferralStatus> getStatusElement()
      Returns:
      status (The workflow status of the referral or transfer of care request.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • hasStatusElement

      public boolean hasStatusElement()

    • hasStatus

      public boolean hasStatus()

    • setStatusElement

      public ReferralRequest setStatusElement(Enumeration<ReferralRequest.ReferralStatus> value)
      Parameters:
      value - status (The workflow status of the referral or transfer of care request.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • getStatus

      public ReferralRequest.ReferralStatus getStatus()
      Returns:
      The workflow status of the referral or transfer of care request.

    • setStatus

      public ReferralRequest setStatus(ReferralRequest.ReferralStatus value)
      Parameters:
      value - The workflow status of the referral or transfer of care request.

    • getIdentifier

      public List<Identifier> getIdentifier()
      Returns:
      identifier (Business identifier that uniquely identifies the referral/care transfer request instance.)

    • hasIdentifier

      public boolean hasIdentifier()

    • addIdentifier

      public Identifier addIdentifier()
      Returns:
      identifier (Business identifier that uniquely identifies the referral/care transfer request instance.)

    • addIdentifier

      public ReferralRequest addIdentifier(Identifier t)

    • getDateElement

      public DateTimeType getDateElement()
      Returns:
      date (Date/DateTime of creation for draft requests and date of activation for active requests.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

    • hasDateElement

      public boolean hasDateElement()

    • hasDate

      public boolean hasDate()

    • setDateElement

      public ReferralRequest setDateElement(DateTimeType value)
      Parameters:
      value - date (Date/DateTime of creation for draft requests and date of activation for active requests.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

    • getDate

      public Date getDate()
      Returns:
      Date/DateTime of creation for draft requests and date of activation for active requests.

    • setDate

      public ReferralRequest setDate(Date value)
      Parameters:
      value - Date/DateTime of creation for draft requests and date of activation for active requests.

    • getType

      public CodeableConcept getType()
      Returns:
      type (An indication of the type of referral (or where applicable the type of transfer of care) request.)

    • hasType

      public boolean hasType()

    • setType

      public ReferralRequest setType(CodeableConcept value)
      Parameters:
      value - type (An indication of the type of referral (or where applicable the type of transfer of care) request.)

    • getSpecialty

      public CodeableConcept getSpecialty()
      Returns:
      specialty (Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.)

    • hasSpecialty

      public boolean hasSpecialty()

    • setSpecialty

      public ReferralRequest setSpecialty(CodeableConcept value)
      Parameters:
      value - specialty (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 CodeableConcept getPriority()
      Returns:
      priority (An indication of the urgency of referral (or where applicable the type of transfer of care) request.)

    • hasPriority

      public boolean hasPriority()

    • setPriority

      public ReferralRequest setPriority(CodeableConcept value)
      Parameters:
      value - priority (An indication of the urgency of referral (or where applicable the type of transfer of care) request.)

    • getPatient

      public Reference getPatient()
      Returns:
      patient (The patient who is the subject of a referral or transfer of care request.)

    • hasPatient

      public boolean hasPatient()

    • setPatient

      public ReferralRequest setPatient(Reference value)
      Parameters:
      value - patient (The patient who is the subject of a referral or transfer of care request.)

    • getPatientTarget

      public Patient getPatientTarget()
      Returns:
      patient The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The patient who is the subject of a referral or transfer of care request.)

    • setPatientTarget

      public ReferralRequest setPatientTarget(Patient value)
      Parameters:
      value - patient The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The patient who is the subject of a referral or transfer of care request.)

    • getRequester

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

    • hasRequester

      public boolean hasRequester()

    • setRequester

      public ReferralRequest setRequester(Reference value)
      Parameters:
      value - requester (The healthcare provider or provider organization who/which initiated the referral/transfer of care request. Can also be Patient (a self referral).)

    • getRequesterTarget

      public Resource getRequesterTarget()
      Returns:
      requester The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The healthcare provider or provider organization who/which initiated the referral/transfer of care request. Can also be Patient (a self referral).)

    • setRequesterTarget

      public ReferralRequest setRequesterTarget(Resource value)
      Parameters:
      value - requester The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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<Reference> getRecipient()
      Returns:
      recipient (The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.)

    • hasRecipient

      public boolean hasRecipient()

    • addRecipient

      public Reference addRecipient()
      Returns:
      recipient (The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.)

    • addRecipient

      public ReferralRequest addRecipient(Reference t)

    • getRecipientTarget

      public List<Resource> getRecipientTarget()
      Returns:
      recipient (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.)

    • getEncounter

      public Reference getEncounter()
      Returns:
      encounter (The encounter at which the request for referral or transfer of care is initiated.)

    • hasEncounter

      public boolean hasEncounter()

    • setEncounter

      public ReferralRequest setEncounter(Reference value)
      Parameters:
      value - encounter (The encounter at which the request for referral or transfer of care is initiated.)

    • getEncounterTarget

      public Encounter getEncounterTarget()
      Returns:
      encounter The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The encounter at which the request for referral or transfer of care is initiated.)

    • setEncounterTarget

      public ReferralRequest setEncounterTarget(Encounter value)
      Parameters:
      value - encounter The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The encounter at which the request for referral or transfer of care is initiated.)

    • getDateSentElement

      public DateTimeType getDateSentElement()
      Returns:
      dateSent (Date/DateTime the request for referral or transfer of care is sent by the author.). This is the underlying object with id, value and extensions. The accessor "getDateSent" gives direct access to the value

    • hasDateSentElement

      public boolean hasDateSentElement()

    • hasDateSent

      public boolean hasDateSent()

    • setDateSentElement

      public ReferralRequest setDateSentElement(DateTimeType value)
      Parameters:
      value - dateSent (Date/DateTime the request for referral or transfer of care is sent by the author.). This is the underlying object with id, value and extensions. The accessor "getDateSent" gives direct access to the value

    • getDateSent

      public Date getDateSent()
      Returns:
      Date/DateTime the request for referral or transfer of care is sent by the author.

    • setDateSent

      public ReferralRequest setDateSent(Date value)
      Parameters:
      value - Date/DateTime the request for referral or transfer of care is sent by the author.

    • getReason

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

    • hasReason

      public boolean hasReason()

    • setReason

      public ReferralRequest setReason(CodeableConcept value)
      Parameters:
      value - reason (Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management.)

    • getDescriptionElement

      public StringType getDescriptionElement()
      Returns:
      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.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

    • hasDescriptionElement

      public boolean hasDescriptionElement()

    • hasDescription

      public boolean hasDescription()

    • setDescriptionElement

      public ReferralRequest setDescriptionElement(StringType value)
      Parameters:
      value - 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.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

    • getDescription

      public String getDescription()
      Returns:
      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 value)
      Parameters:
      value - 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<CodeableConcept> getServiceRequested()
      Returns:
      serviceRequested (The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.)

    • hasServiceRequested

      public boolean hasServiceRequested()

    • addServiceRequested

      public CodeableConcept addServiceRequested()
      Returns:
      serviceRequested (The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.)

    • addServiceRequested

      public ReferralRequest addServiceRequested(CodeableConcept t)

    • getSupportingInformation

      public List<Reference> getSupportingInformation()
      Returns:
      supportingInformation (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.)

    • hasSupportingInformation

      public boolean hasSupportingInformation()

    • addSupportingInformation

      public Reference addSupportingInformation()
      Returns:
      supportingInformation (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 ReferralRequest addSupportingInformation(Reference t)

    • getSupportingInformationTarget

      public List<Resource> getSupportingInformationTarget()
      Returns:
      supportingInformation (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. 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 Period getFulfillmentTime()
      Returns:
      fulfillmentTime (The period of time within which the services identified in the referral/transfer of care is specified or required to occur.)

    • hasFulfillmentTime

      public boolean hasFulfillmentTime()

    • setFulfillmentTime

      public ReferralRequest setFulfillmentTime(Period value)
      Parameters:
      value - fulfillmentTime (The period of time within which the services identified in the referral/transfer of care is specified or required to occur.)

    • listChildren

      protected void listChildren(List<Property> childrenList)
      Overrides:
      listChildren in class DomainResource

    • setProperty

      public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class DomainResource

    • copy

      public ReferralRequest copy()
      Specified by:
      copy in class DomainResource

    • typedCopy

      protected ReferralRequest typedCopy()

    • equalsDeep

      public boolean equalsDeep(Base other)
      Overrides:
      equalsDeep in class DomainResource

    • equalsShallow

      public boolean equalsShallow(Base other)
      Overrides:
      equalsShallow in class DomainResource

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class DomainResource

    • getResourceType

      public ResourceType getResourceType()
      Specified by:
      getResourceType in class Resource