SupplyRequest (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.SupplyRequest

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class SupplyRequest
extends BaseResource
implements IResource
```
HAPI/FHIR SupplyRequest Resource ()
Definition: A record of a request for a medication, substance or device used in the healthcare setting.

Requirements:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SupplyRequest.When
Block class for child element: SupplyRequest.when ()

Nested Classes
Modifier and Type	Class and Description
`static class`	`SupplyRequest.When` Block class for child element: SupplyRequest.when ()

Field Summary

Fields
Modifier and Type	Field and Description
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_SOURCE` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_SUPPLIER` Constant for fluent queries to be used to add include statements.
`static TokenClientParam`	`KIND` Fluent Client search parameter constant for kind
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static ReferenceClientParam`	`SOURCE` Fluent Client search parameter constant for source
`static String`	`SP_DATE` Search parameter constant for date
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_KIND` Search parameter constant for kind
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_SOURCE` Search parameter constant for source
`static String`	`SP_STATUS` Search parameter constant for status
`static String`	`SP_SUPPLIER` Search parameter constant for supplier
`static TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`static ReferenceClientParam`	`SUPPLIER` Fluent Client search parameter constant for supplier

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
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

SupplyRequest()

Constructors
Constructor and Description
`SupplyRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResourceReferenceDt`	`addSupplier()` Adds and returns a new value for supplier ()
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`Date`	`getDate()` Gets the value(s) for date ().
`DateTimeDt`	`getDateElement()` Gets the value(s) for date ().
`IdentifierDt`	`getIdentifier()` Gets the value(s) for identifier ().
`CodeableConceptDt`	`getKind()` Gets the value(s) for kind ().
`ResourceReferenceDt`	`getOrderedItem()` Gets the value(s) for orderedItem ().
`ResourceReferenceDt`	`getPatient()` Gets the value(s) for patient ().
`IDatatype`	`getReason()` Gets the value(s) for reason[x] ().
`String`	`getResourceName()`
`ResourceReferenceDt`	`getSource()` Gets the value(s) for source ().
`String`	`getStatus()` Gets the value(s) for status ().
`BoundCodeDt<SupplyRequestStatusEnum>`	`getStatusElement()` Gets the value(s) for status ().
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`List<ResourceReferenceDt>`	`getSupplier()` Gets the value(s) for supplier ().
`SupplyRequest.When`	`getWhen()` Gets the value(s) for when ().
`boolean`	`isEmpty()`
`SupplyRequest`	`setDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for date ()
`SupplyRequest`	`setDate(DateTimeDt theValue)` Sets the value(s) for date ()
`SupplyRequest`	`setDateWithSecondsPrecision(Date theDate)` Sets the value for date ()
`SupplyRequest`	`setIdentifier(IdentifierDt theValue)` Sets the value(s) for identifier ()
`SupplyRequest`	`setKind(CodeableConceptDt theValue)` Sets the value(s) for kind ()
`SupplyRequest`	`setOrderedItem(ResourceReferenceDt theValue)` Sets the value(s) for orderedItem ()
`SupplyRequest`	`setPatient(ResourceReferenceDt theValue)` Sets the value(s) for patient ()
`SupplyRequest`	`setReason(IDatatype theValue)` Sets the value(s) for reason[x] ()
`SupplyRequest`	`setSource(ResourceReferenceDt theValue)` Sets the value(s) for source ()
`SupplyRequest`	`setStatus(BoundCodeDt<SupplyRequestStatusEnum> theValue)` Sets the value(s) for status ()
`SupplyRequest`	`setStatus(SupplyRequestStatusEnum theValue)` Sets the value(s) for status ()
`SupplyRequest`	`setSupplier(List<ResourceReferenceDt> theValue)` Sets the value(s) for supplier ()
`SupplyRequest`	`setWhen(SupplyRequest.When theValue)` Sets the value(s) for when ()

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

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

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

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

- Field Detail
  - SP_KIND
```
public static final String SP_KIND
```
    Search parameter constant for kind
    Description:
    Type: token
    Path: SupplyRequest.kind
    
    See Also:
    
    Constant Field Values
  - KIND
```
public static final TokenClientParam KIND
```
    Fluent Client search parameter constant for kind
    Description:
    Type: token
    Path: SupplyRequest.kind
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description:
    Type: token
    Path: SupplyRequest.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description:
    Type: token
    Path: SupplyRequest.identifier
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter constant for status
    Description:
    Type: token
    Path: SupplyRequest.status
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description:
    Type: token
    Path: SupplyRequest.status
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description:
    Type: reference
    Path: SupplyRequest.patient
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description:
    Type: reference
    Path: SupplyRequest.patient
  - SP_SOURCE
```
public static final String SP_SOURCE
```
    Search parameter constant for source
    Description:
    Type: reference
    Path: SupplyRequest.source
    
    See Also:
    
    Constant Field Values
  - SOURCE
```
public static final ReferenceClientParam SOURCE
```
    Fluent Client search parameter constant for source
    Description:
    Type: reference
    Path: SupplyRequest.source
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter constant for date
    Description:
    Type: date
    Path: SupplyRequest.date
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description:
    Type: date
    Path: SupplyRequest.date
  - SP_SUPPLIER
```
public static final String SP_SUPPLIER
```
    Search parameter constant for supplier
    Description:
    Type: reference
    Path: SupplyRequest.supplier
    
    See Also:
    
    Constant Field Values
  - SUPPLIER
```
public static final ReferenceClientParam SUPPLIER
```
    Fluent Client search parameter constant for supplier
    Description:
    Type: reference
    Path: SupplyRequest.supplier
  - INCLUDE_PATIENT
```
public static final Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "SupplyRequest:patient".
  - INCLUDE_SOURCE
```
public static final Include INCLUDE_SOURCE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "SupplyRequest:source".
  - INCLUDE_SUPPLIER
```
public static final Include INCLUDE_SUPPLIER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "SupplyRequest:supplier".
- Constructor Detail
  - SupplyRequest
```
public SupplyRequest()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getPatient
```
public ResourceReferenceDt getPatient()
```
    Gets the value(s) for patient (). creating it if it does not exist. Will not return null.
    Definition: A link to a resource representing the person whom the ordered item is for
  - setPatient
```
public SupplyRequest setPatient(ResourceReferenceDt theValue)
```
    Sets the value(s) for patient ()
    Definition: A link to a resource representing the person whom the ordered item is for
  - getSource
```
public ResourceReferenceDt getSource()
```
    Gets the value(s) for source (). creating it if it does not exist. Will not return null.
    Definition: The Practitioner , Organization or Patient who initiated this order for the supply
  - setSource
```
public SupplyRequest setSource(ResourceReferenceDt theValue)
```
    Sets the value(s) for source ()
    Definition: The Practitioner , Organization or Patient who initiated this order for the supply
  - getDateElement
```
public DateTimeDt getDateElement()
```
    Gets the value(s) for date (). creating it if it does not exist. Will not return null.
    Definition: When the request was made
  - getDate
```
public Date getDate()
```
    Gets the value(s) for date (). creating it if it does not exist. Will not return null.
    Definition: When the request was made
  - setDate
```
public SupplyRequest setDate(DateTimeDt theValue)
```
    Sets the value(s) for date ()
    Definition: When the request was made
  - setDate
```
public SupplyRequest setDate(Date theDate,
                             TemporalPrecisionEnum thePrecision)
```
    Sets the value for date ()
    Definition: When the request was made
  - setDateWithSecondsPrecision
```
public SupplyRequest setDateWithSecondsPrecision(Date theDate)
```
    Sets the value for date ()
    Definition: When the request was made
  - getIdentifier
```
public IdentifierDt getIdentifier()
```
    Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.
    Definition: Unique identifier for this supply request
  - setIdentifier
```
public SupplyRequest setIdentifier(IdentifierDt theValue)
```
    Sets the value(s) for identifier ()
    Definition: Unique identifier for this supply request
  - getStatusElement
```
public BoundCodeDt<SupplyRequestStatusEnum> getStatusElement()
```
    Gets the value(s) for status (). creating it if it does not exist. Will not return null.
    Definition: Status of the supply request
  - getStatus
```
public String getStatus()
```
    Gets the value(s) for status (). creating it if it does not exist. Will not return null.
    Definition: Status of the supply request
  - setStatus
```
public SupplyRequest setStatus(BoundCodeDt<SupplyRequestStatusEnum> theValue)
```
    Sets the value(s) for status ()
    Definition: Status of the supply request
  - setStatus
```
public SupplyRequest setStatus(SupplyRequestStatusEnum theValue)
```
    Sets the value(s) for status ()
    Definition: Status of the supply request
  - getKind
```
public CodeableConceptDt getKind()
```
    Gets the value(s) for kind (). creating it if it does not exist. Will not return null.
    Definition: Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process
  - setKind
```
public SupplyRequest setKind(CodeableConceptDt theValue)
```
    Sets the value(s) for kind ()
    Definition: Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process
  - getOrderedItem
```
public ResourceReferenceDt getOrderedItem()
```
    Gets the value(s) for orderedItem (). creating it if it does not exist. Will not return null.
    Definition: The item that is requested to be supplied
  - setOrderedItem
```
public SupplyRequest setOrderedItem(ResourceReferenceDt theValue)
```
    Sets the value(s) for orderedItem ()
    Definition: The item that is requested to be supplied
  - getSupplier
```
public List<ResourceReferenceDt> getSupplier()
```
    Gets the value(s) for supplier (). creating it if it does not exist. Will not return null.
    Definition: Who is intended to fulfill the request
  - setSupplier
```
public SupplyRequest setSupplier(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for supplier ()
    Definition: Who is intended to fulfill the request
  - addSupplier
```
public ResourceReferenceDt addSupplier()
```
    Adds and returns a new value for supplier ()
    Definition: Who is intended to fulfill the request
  - getReason
```
public IDatatype getReason()
```
    Gets the value(s) for reason[x] (). creating it if it does not exist. Will not return null.
    Definition: Why the supply item was requested
  - setReason
```
public SupplyRequest setReason(IDatatype theValue)
```
    Sets the value(s) for reason[x] ()
    Definition: Why the supply item was requested
  - getWhen
```
public SupplyRequest.When getWhen()
```
    Gets the value(s) for when (). creating it if it does not exist. Will not return null.
    Definition: When the request should be fulfilled
  - setWhen
```
public SupplyRequest setWhen(SupplyRequest.When theValue)
```
    Sets the value(s) for when ()
    Definition: When the request should be fulfilled
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class SupplyRequest

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

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

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

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

Field Detail

SP_KIND

KIND

SP_IDENTIFIER

IDENTIFIER

SP_STATUS

STATUS

SP_PATIENT

PATIENT

SP_SOURCE

SOURCE

SP_DATE

DATE

SP_SUPPLIER

SUPPLIER

INCLUDE_PATIENT

INCLUDE_SOURCE

INCLUDE_SUPPLIER

Constructor Detail

SupplyRequest

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getPatient

setPatient

getSource

setSource

getDateElement

getDate

setDate

setDate

setDateWithSecondsPrecision

getIdentifier

setIdentifier

getStatusElement

getStatus

setStatus

setStatus

getKind

setKind

getOrderedItem

setOrderedItem

getSupplier

setSupplier

addSupplier

getReason

setReason

getWhen

setWhen

getResourceName

getStructureFhirVersionEnum