ReferralRequest (HAPI FHIR Structures - DSTU2.1 (2016May) 3.3.0 API)

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

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ReferralRequest.ReferralCategory`
`static class`	`ReferralRequest.ReferralCategoryEnumFactory`
`static class`	`ReferralRequest.ReferralStatus`
`static class`	`ReferralRequest.ReferralStatusEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`protected DateTimeType`	`authored` Date/DateTime of creation for draft requests and date of activation for active requests.
`protected List<Reference>`	`basedOn` Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`BASEDON` Fluent Client search parameter constant for basedon
`protected List<Resource>`	`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.)
`protected Enumeration<ReferralRequest.ReferralCategory>`	`category` Distinguishes the "level" of authorization/demand implicit in this request.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`CATEGORY` Fluent Client search parameter constant for category
`protected Reference`	`context` The encounter at which the request for referral or transfer of care is initiated.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`CONTEXT` Fluent Client search parameter constant for context
`protected Resource`	`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.)
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`DATE` Fluent Client search parameter constant for date
`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.
`protected Period`	`fulfillmentTime` The period of time within which the services identified in the referral/transfer of care is specified or required to occur.
`protected List<Identifier>`	`identifier` Business identifier that uniquely identifies the referral/care transfer request instance.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_BASEDON` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_CONTEXT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_RECIPIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_REQUESTER` Constant for fluent queries to be used to add include statements.
`protected Identifier`	`parent` The business identifier of the logical "grouping" request/order that this referral is a part of.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`PARENT` Fluent Client search parameter constant for parent
`protected Reference`	`patient` The patient who is the subject of a referral or transfer of care request.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`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.)
`protected CodeableConcept`	`priority` An indication of the urgency of referral (or where applicable the type of transfer of care) request.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`PRIORITY` Fluent Client search parameter constant for priority
`protected CodeableConcept`	`reason` Description of clinical condition indicating why referral/transfer of care is requested.
`protected List<Reference>`	`recipient` The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`RECIPIENT` Fluent Client search parameter constant for recipient
`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.)
`protected Reference`	`requester` The healthcare provider or provider organization who/which initiated the referral/transfer of care request.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`REQUESTER` Fluent Client search parameter constant for requester
`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.
`protected List<CodeableConcept>`	`serviceRequested` The service(s) that is/are requested to be provided to the patient.
`static String`	`SP_BASEDON` Search parameter: basedon
`static String`	`SP_CATEGORY` Search parameter: category
`static String`	`SP_CONTEXT` Search parameter: context
`static String`	`SP_DATE` Search parameter: date
`static String`	`SP_PARENT` Search parameter: parent
`static String`	`SP_PATIENT` Search parameter: patient
`static String`	`SP_PRIORITY` Search parameter: priority
`static String`	`SP_RECIPIENT` Search parameter: recipient
`static String`	`SP_REQUESTER` Search parameter: requester
`static String`	`SP_SPECIALTY` Search parameter: specialty
`static String`	`SP_STATUS` Search parameter: status
`static String`	`SP_TYPE` Search parameter: type
`protected CodeableConcept`	`specialty` Indication of the clinical domain or discipline to which the referral or transfer of care request is sent.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`SPECIALTY` Fluent Client search parameter constant for specialty
`protected Enumeration<ReferralRequest.ReferralStatus>`	`status` The status of the authorization/intention reflected by the referral request record.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`protected List<Reference>`	`supportingInformation` Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care.
`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.
`protected CodeableConcept`	`type` An indication of the type of referral (or where applicable the type of transfer of care) request.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`TYPE` Fluent Client search parameter constant for type

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description
`ReferralRequest()` Constructor
`ReferralRequest(Enumeration<ReferralRequest.ReferralStatus> status, Enumeration<ReferralRequest.ReferralCategory> category)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Reference`	`addBasedOn()`
`ReferralRequest`	`addBasedOn(Reference t)`
`Base`	`addChild(String name)`
`Identifier`	`addIdentifier()`
`ReferralRequest`	`addIdentifier(Identifier t)`
`Reference`	`addRecipient()`
`ReferralRequest`	`addRecipient(Reference t)`
`CodeableConcept`	`addServiceRequested()`
`ReferralRequest`	`addServiceRequested(CodeableConcept t)`
`Reference`	`addSupportingInformation()`
`ReferralRequest`	`addSupportingInformation(Reference t)`
`ReferralRequest`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`Date`	`getAuthored()`
`DateTimeType`	`getAuthoredElement()`
`List<Reference>`	`getBasedOn()`
`List<Resource>`	`getBasedOnTarget()`
`ReferralRequest.ReferralCategory`	`getCategory()`
`Enumeration<ReferralRequest.ReferralCategory>`	`getCategoryElement()`
`Reference`	`getContext()`
`Resource`	`getContextTarget()`
`String`	`getDescription()`
`StringType`	`getDescriptionElement()`
`Period`	`getFulfillmentTime()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getParent()`
`Reference`	`getPatient()`
`Patient`	`getPatientTarget()`
`CodeableConcept`	`getPriority()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`CodeableConcept`	`getReason()`
`List<Reference>`	`getRecipient()`
`List<Resource>`	`getRecipientTarget()`
`Reference`	`getRequester()`
`Resource`	`getRequesterTarget()`
`ResourceType`	`getResourceType()`
`List<CodeableConcept>`	`getServiceRequested()`
`CodeableConcept`	`getSpecialty()`
`ReferralRequest.ReferralStatus`	`getStatus()`
`Enumeration<ReferralRequest.ReferralStatus>`	`getStatusElement()`
`List<Reference>`	`getSupportingInformation()`
`List<Resource>`	`getSupportingInformationTarget()`
`CodeableConcept`	`getType()`
`boolean`	`hasAuthored()`
`boolean`	`hasAuthoredElement()`
`boolean`	`hasBasedOn()`
`boolean`	`hasCategory()`
`boolean`	`hasCategoryElement()`
`boolean`	`hasContext()`
`boolean`	`hasDescription()`
`boolean`	`hasDescriptionElement()`
`boolean`	`hasFulfillmentTime()`
`boolean`	`hasIdentifier()`
`boolean`	`hasParent()`
`boolean`	`hasPatient()`
`boolean`	`hasPriority()`
`boolean`	`hasReason()`
`boolean`	`hasRecipient()`
`boolean`	`hasRequester()`
`boolean`	`hasServiceRequested()`
`boolean`	`hasSpecialty()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasSupportingInformation()`
`boolean`	`hasType()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`ReferralRequest`	`setAuthored(Date value)`
`ReferralRequest`	`setAuthoredElement(DateTimeType value)`
`ReferralRequest`	`setCategory(ReferralRequest.ReferralCategory value)`
`ReferralRequest`	`setCategoryElement(Enumeration<ReferralRequest.ReferralCategory> value)`
`ReferralRequest`	`setContext(Reference value)`
`ReferralRequest`	`setContextTarget(Resource value)`
`ReferralRequest`	`setDescription(String value)`
`ReferralRequest`	`setDescriptionElement(StringType value)`
`ReferralRequest`	`setFulfillmentTime(Period value)`
`ReferralRequest`	`setParent(Identifier value)`
`ReferralRequest`	`setPatient(Reference value)`
`ReferralRequest`	`setPatientTarget(Patient value)`
`ReferralRequest`	`setPriority(CodeableConcept value)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base value)`
`ReferralRequest`	`setReason(CodeableConcept value)`
`ReferralRequest`	`setRequester(Reference value)`
`ReferralRequest`	`setRequesterTarget(Resource value)`
`ReferralRequest`	`setSpecialty(CodeableConcept value)`
`ReferralRequest`	`setStatus(ReferralRequest.ReferralStatus value)`
`ReferralRequest`	`setStatusElement(Enumeration<ReferralRequest.ReferralStatus> value)`
`ReferralRequest`	`setType(CodeableConcept value)`
`protected ReferralRequest`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource
getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    Business identifier that uniquely identifies the referral/care transfer request instance.
  - basedOn
```
protected List<Reference> basedOn
```
    Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.
  - basedOnTarget
```
protected List<Resource> 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.)
  - parent
```
protected Identifier parent
```
    The business identifier of the logical "grouping" request/order that this referral is a part of.
  - status
```
protected Enumeration<ReferralRequest.ReferralStatus> status
```
    The status of the authorization/intention reflected by the referral request record.
  - category
```
protected Enumeration<ReferralRequest.ReferralCategory> category
```
    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
```
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.)
  - context
```
protected Reference context
```
    The encounter at which the request for referral or transfer of care is initiated.
  - contextTarget
```
protected Resource 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.)
  - 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.
  - authored
```
protected DateTimeType authored
```
    Date/DateTime of creation for draft requests and date of activation for active requests.
  - 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).)
  - 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.
  - 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.)
  - 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.)
  - SP_CATEGORY
```
public static final String SP_CATEGORY
```
    Search parameter: category
    Description: Proposal, plan or request
    Type: token
    Path: ReferralRequest.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: Proposal, plan or request
    Type: token
    Path: ReferralRequest.category
  - SP_REQUESTER
```
public static final String SP_REQUESTER
```
    Search parameter: requester
    Description: Requester of referral / transfer of care
    Type: reference
    Path: ReferralRequest.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: Requester of referral / transfer of care
    Type: reference
    Path: ReferralRequest.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 "ReferralRequest:requester".
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: 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
  - 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_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
  - 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_BASEDON
```
public static final String SP_BASEDON
```
    Search parameter: basedon
    Description: Request being fulfilled
    Type: reference
    Path: ReferralRequest.basedOn
    
    See Also:
    
    Constant Field Values
  - BASEDON
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASEDON
```
    Fluent Client search parameter constant for basedon
    Description: Request being fulfilled
    Type: reference
    Path: ReferralRequest.basedOn
  - INCLUDE_BASEDON
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_BASEDON
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ReferralRequest:basedon".
  - 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_PARENT
```
public static final String SP_PARENT
```
    Search parameter: parent
    Description: Part of common request
    Type: token
    Path: ReferralRequest.parent
    
    See Also:
    
    Constant Field Values
  - PARENT
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam PARENT
```
    Fluent Client search parameter constant for parent
    Description: Part of common request
    Type: token
    Path: ReferralRequest.parent
  - 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_DATE
```
public static final String SP_DATE
```
    Search parameter: date
    Description: Creation or activation date
    Type: date
    Path: ReferralRequest.authored
    
    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.authored
  - 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_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".
- Constructor Detail
  - ReferralRequest
```
public ReferralRequest()
```
    Constructor
  - ReferralRequest
```
public ReferralRequest(Enumeration<ReferralRequest.ReferralStatus> status,
                       Enumeration<ReferralRequest.ReferralCategory> category)
```
    Constructor
- Method Detail
  - 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)
```
  - getBasedOn
```
public List<Reference> getBasedOn()
```
    Returns:
    
    basedOn (Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.)
  - hasBasedOn
```
public boolean hasBasedOn()
```
  - addBasedOn
```
public Reference addBasedOn()
```
    Returns:
    
    basedOn (Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.)
  - addBasedOn
```
public ReferralRequest addBasedOn(Reference t)
```
  - getBasedOnTarget
```
public List<Resource> getBasedOnTarget()
```
    Returns:
    
    basedOn (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. Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.)
  - getParent
```
public Identifier getParent()
```
    Returns:
    
    parent (The business identifier of the logical "grouping" request/order that this referral is a part of.)
  - hasParent
```
public boolean hasParent()
```
  - setParent
```
public ReferralRequest setParent(Identifier value)
```
    Parameters:
    
    value - parent (The business identifier of the logical "grouping" request/order that this referral is a part of.)
  - getStatusElement
```
public Enumeration<ReferralRequest.ReferralStatus> getStatusElement()
```
    Returns:
    
    status (The status of the authorization/intention reflected by the referral request record.). 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 status of the authorization/intention reflected by the referral request record.). 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 status of the authorization/intention reflected by the referral request record.
  - setStatus
```
public ReferralRequest setStatus(ReferralRequest.ReferralStatus value)
```
    Parameters:
    
    value - The status of the authorization/intention reflected by the referral request record.
  - getCategoryElement
```
public Enumeration<ReferralRequest.ReferralCategory> getCategoryElement()
```
    Returns:
    
    category (Distinguishes the "level" of authorization/demand implicit in this request.). This is the underlying object with id, value and extensions. The accessor "getCategory" gives direct access to the value
  - hasCategoryElement
```
public boolean hasCategoryElement()
```
  - hasCategory
```
public boolean hasCategory()
```
  - setCategoryElement
```
public ReferralRequest setCategoryElement(Enumeration<ReferralRequest.ReferralCategory> value)
```
    Parameters:
    
    value - category (Distinguishes the "level" of authorization/demand implicit in this request.). This is the underlying object with id, value and extensions. The accessor "getCategory" gives direct access to the value
  - getCategory
```
public ReferralRequest.ReferralCategory getCategory()
```
    Returns:
    
    Distinguishes the "level" of authorization/demand implicit in this request.
  - setCategory
```
public ReferralRequest setCategory(ReferralRequest.ReferralCategory value)
```
    Parameters:
    
    value - Distinguishes the "level" of authorization/demand implicit in this request.
  - 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.)
  - 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.)
  - getContext
```
public Reference getContext()
```
    Returns:
    
    context (The encounter at which the request for referral or transfer of care is initiated.)
  - hasContext
```
public boolean hasContext()
```
  - setContext
```
public ReferralRequest setContext(Reference value)
```
    Parameters:
    
    value - context (The encounter at which the request for referral or transfer of care is initiated.)
  - getContextTarget
```
public Resource getContextTarget()
```
    Returns:
    
    context 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.)
  - setContextTarget
```
public ReferralRequest setContextTarget(Resource value)
```
    Parameters:
    
    value - context 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.)
  - 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.)
  - getAuthoredElement
```
public DateTimeType getAuthoredElement()
```
    Returns:
    
    authored (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 "getAuthored" gives direct access to the value
  - hasAuthoredElement
```
public boolean hasAuthoredElement()
```
  - hasAuthored
```
public boolean hasAuthored()
```
  - setAuthoredElement
```
public ReferralRequest setAuthoredElement(DateTimeType value)
```
    Parameters:
    
    value - authored (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 "getAuthored" gives direct access to the value
  - getAuthored
```
public Date getAuthored()
```
    Returns:
    
    Date/DateTime of creation for draft requests and date of activation for active requests.
  - setAuthored
```
public ReferralRequest setAuthored(Date value)
```
    Parameters:
    
    value - Date/DateTime of creation for draft requests and date of activation for active requests.
  - 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).)
  - 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.)
  - 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.)
  - 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.)
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - 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
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty 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()
```
    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

Class ReferralRequest

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Field Detail

identifier

basedOn

basedOnTarget

parent

status

category

type

priority

patient

patientTarget

context

contextTarget

fulfillmentTime

authored

requester

requesterTarget

specialty

recipient

recipientTarget

reason

description

serviceRequested

supportingInformation

supportingInformationTarget

SP_CATEGORY

CATEGORY

SP_REQUESTER

REQUESTER

INCLUDE_REQUESTER

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_STATUS

STATUS

SP_PRIORITY

PRIORITY

SP_BASEDON

BASEDON

INCLUDE_BASEDON

SP_CONTEXT

CONTEXT

INCLUDE_CONTEXT

SP_PARENT

PARENT

SP_TYPE

TYPE

SP_DATE

DATE

SP_SPECIALTY

SPECIALTY

SP_RECIPIENT

RECIPIENT

INCLUDE_RECIPIENT

Constructor Detail

ReferralRequest

ReferralRequest

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getBasedOn