SupplyDelivery (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.SupplyDelivery

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class SupplyDelivery
extends BaseResource
implements IResource
```
HAPI/FHIR SupplyDelivery Resource ()
Definition: Record of delivery of what is supplied.

Requirements:

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

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`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_RECEIVER` 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 ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static ReferenceClientParam`	`RECEIVER` Fluent Client search parameter constant for receiver
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_RECEIVER` Search parameter constant for receiver
`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

SupplyDelivery()

Constructors
Constructor and Description
`SupplyDelivery()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResourceReferenceDt`	`addReceiver()` Adds and returns a new value for receiver ()
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`ResourceReferenceDt`	`getDestination()` Gets the value(s) for destination ().
`IdentifierDt`	`getIdentifier()` Gets the value(s) for identifier ().
`ResourceReferenceDt`	`getPatient()` Gets the value(s) for patient ().
`SimpleQuantityDt`	`getQuantity()` Gets the value(s) for quantity ().
`List<ResourceReferenceDt>`	`getReceiver()` Gets the value(s) for receiver ().
`String`	`getResourceName()`
`String`	`getStatus()` Gets the value(s) for status ().
`BoundCodeDt<SupplyDeliveryStatusEnum>`	`getStatusElement()` Gets the value(s) for status ().
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`ResourceReferenceDt`	`getSuppliedItem()` Gets the value(s) for suppliedItem ().
`ResourceReferenceDt`	`getSupplier()` Gets the value(s) for supplier ().
`Date`	`getTime()` Gets the value(s) for time ().
`DateTimeDt`	`getTimeElement()` Gets the value(s) for time ().
`CodeableConceptDt`	`getType()` Gets the value(s) for type ().
`PeriodDt`	`getWhenPrepared()` Gets the value(s) for whenPrepared ().
`boolean`	`isEmpty()`
`SupplyDelivery`	`setDestination(ResourceReferenceDt theValue)` Sets the value(s) for destination ()
`SupplyDelivery`	`setIdentifier(IdentifierDt theValue)` Sets the value(s) for identifier ()
`SupplyDelivery`	`setPatient(ResourceReferenceDt theValue)` Sets the value(s) for patient ()
`SupplyDelivery`	`setQuantity(SimpleQuantityDt theValue)` Sets the value(s) for quantity ()
`SupplyDelivery`	`setReceiver(List<ResourceReferenceDt> theValue)` Sets the value(s) for receiver ()
`SupplyDelivery`	`setStatus(BoundCodeDt<SupplyDeliveryStatusEnum> theValue)` Sets the value(s) for status ()
`SupplyDelivery`	`setStatus(SupplyDeliveryStatusEnum theValue)` Sets the value(s) for status ()
`SupplyDelivery`	`setSuppliedItem(ResourceReferenceDt theValue)` Sets the value(s) for suppliedItem ()
`SupplyDelivery`	`setSupplier(ResourceReferenceDt theValue)` Sets the value(s) for supplier ()
`SupplyDelivery`	`setTime(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for time ()
`SupplyDelivery`	`setTime(DateTimeDt theValue)` Sets the value(s) for time ()
`SupplyDelivery`	`setTimeWithSecondsPrecision(Date theDate)` Sets the value for time ()
`SupplyDelivery`	`setType(CodeableConceptDt theValue)` Sets the value(s) for type ()
`SupplyDelivery`	`setWhenPrepared(PeriodDt theValue)` Sets the value(s) for whenPrepared ()

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_SUPPLIER
```
public static final String SP_SUPPLIER
```
    Search parameter constant for supplier
    Description:
    Type: reference
    Path: SupplyDelivery.supplier
    
    See Also:
    
    Constant Field Values
  - SUPPLIER
```
public static final ReferenceClientParam SUPPLIER
```
    Fluent Client search parameter constant for supplier
    Description:
    Type: reference
    Path: SupplyDelivery.supplier
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description:
    Type: token
    Path: SupplyDelivery.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description:
    Type: token
    Path: SupplyDelivery.identifier
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter constant for status
    Description:
    Type: token
    Path: SupplyDelivery.status
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description:
    Type: token
    Path: SupplyDelivery.status
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description:
    Type: reference
    Path: SupplyDelivery.patient
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description:
    Type: reference
    Path: SupplyDelivery.patient
  - SP_RECEIVER
```
public static final String SP_RECEIVER
```
    Search parameter constant for receiver
    Description:
    Type: reference
    Path: SupplyDelivery.receiver
    
    See Also:
    
    Constant Field Values
  - RECEIVER
```
public static final ReferenceClientParam RECEIVER
```
    Fluent Client search parameter constant for receiver
    Description:
    Type: reference
    Path: SupplyDelivery.receiver
  - INCLUDE_PATIENT
```
public static final Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "SupplyDelivery:patient".
  - INCLUDE_RECEIVER
```
public static final Include INCLUDE_RECEIVER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "SupplyDelivery:receiver".
  - INCLUDE_SUPPLIER
```
public static final Include INCLUDE_SUPPLIER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "SupplyDelivery:supplier".
- Constructor Detail
  - SupplyDelivery
```
public SupplyDelivery()
```
- 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
  - getIdentifier
```
public IdentifierDt getIdentifier()
```
    Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.
    Definition: Identifier assigned by the dispensing facility when the item(s) is dispensed.
  - setIdentifier
```
public SupplyDelivery setIdentifier(IdentifierDt theValue)
```
    Sets the value(s) for identifier ()
    Definition: Identifier assigned by the dispensing facility when the item(s) is dispensed.
  - getStatusElement
```
public BoundCodeDt<SupplyDeliveryStatusEnum> getStatusElement()
```
    Gets the value(s) for status (). creating it if it does not exist. Will not return null.
    Definition: A code specifying the state of the dispense event.
  - getStatus
```
public String getStatus()
```
    Gets the value(s) for status (). creating it if it does not exist. Will not return null.
    Definition: A code specifying the state of the dispense event.
  - setStatus
```
public SupplyDelivery setStatus(BoundCodeDt<SupplyDeliveryStatusEnum> theValue)
```
    Sets the value(s) for status ()
    Definition: A code specifying the state of the dispense event.
  - setStatus
```
public SupplyDelivery setStatus(SupplyDeliveryStatusEnum theValue)
```
    Sets the value(s) for status ()
    Definition: A code specifying the state of the dispense event.
  - 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 delivered item is for
  - setPatient
```
public SupplyDelivery setPatient(ResourceReferenceDt theValue)
```
    Sets the value(s) for patient ()
    Definition: A link to a resource representing the person whom the delivered item is for
  - getType
```
public CodeableConceptDt getType()
```
    Gets the value(s) for type (). creating it if it does not exist. Will not return null.
    Definition: Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
  - setType
```
public SupplyDelivery setType(CodeableConceptDt theValue)
```
    Sets the value(s) for type ()
    Definition: Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
  - getQuantity
```
public SimpleQuantityDt getQuantity()
```
    Gets the value(s) for quantity (). creating it if it does not exist. Will not return null.
    Definition: The amount of supply that has been dispensed. Includes unit of measure.
  - setQuantity
```
public SupplyDelivery setQuantity(SimpleQuantityDt theValue)
```
    Sets the value(s) for quantity ()
    Definition: The amount of supply that has been dispensed. Includes unit of measure.
  - getSuppliedItem
```
public ResourceReferenceDt getSuppliedItem()
```
    Gets the value(s) for suppliedItem (). creating it if it does not exist. Will not return null.
    Definition: Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a simple attribute carrying a code that identifies the item from a known list.
  - setSuppliedItem
```
public SupplyDelivery setSuppliedItem(ResourceReferenceDt theValue)
```
    Sets the value(s) for suppliedItem ()
    Definition: Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a simple attribute carrying a code that identifies the item from a known list.
  - getSupplier
```
public ResourceReferenceDt getSupplier()
```
    Gets the value(s) for supplier (). creating it if it does not exist. Will not return null.
    Definition: The individual responsible for dispensing the medication, supplier or device.
  - setSupplier
```
public SupplyDelivery setSupplier(ResourceReferenceDt theValue)
```
    Sets the value(s) for supplier ()
    Definition: The individual responsible for dispensing the medication, supplier or device.
  - getWhenPrepared
```
public PeriodDt getWhenPrepared()
```
    Gets the value(s) for whenPrepared (). creating it if it does not exist. Will not return null.
    Definition: The time the dispense event occurred.
  - setWhenPrepared
```
public SupplyDelivery setWhenPrepared(PeriodDt theValue)
```
    Sets the value(s) for whenPrepared ()
    Definition: The time the dispense event occurred.
  - getTimeElement
```
public DateTimeDt getTimeElement()
```
    Gets the value(s) for time (). creating it if it does not exist. Will not return null.
    Definition: The time the dispensed item was sent or handed to the patient (or agent).
  - getTime
```
public Date getTime()
```
    Gets the value(s) for time (). creating it if it does not exist. Will not return null.
    Definition: The time the dispensed item was sent or handed to the patient (or agent).
  - setTime
```
public SupplyDelivery setTime(DateTimeDt theValue)
```
    Sets the value(s) for time ()
    Definition: The time the dispensed item was sent or handed to the patient (or agent).
  - setTime
```
public SupplyDelivery setTime(Date theDate,
                              TemporalPrecisionEnum thePrecision)
```
    Sets the value for time ()
    Definition: The time the dispensed item was sent or handed to the patient (or agent).
  - setTimeWithSecondsPrecision
```
public SupplyDelivery setTimeWithSecondsPrecision(Date theDate)
```
    Sets the value for time ()
    Definition: The time the dispensed item was sent or handed to the patient (or agent).
  - getDestination
```
public ResourceReferenceDt getDestination()
```
    Gets the value(s) for destination (). creating it if it does not exist. Will not return null.
    Definition: Identification of the facility/location where the Supply was shipped to, as part of the dispense event.
  - setDestination
```
public SupplyDelivery setDestination(ResourceReferenceDt theValue)
```
    Sets the value(s) for destination ()
    Definition: Identification of the facility/location where the Supply was shipped to, as part of the dispense event.
  - getReceiver
```
public List<ResourceReferenceDt> getReceiver()
```
    Gets the value(s) for receiver (). creating it if it does not exist. Will not return null.
    Definition: Identifies the person who picked up the Supply.
  - setReceiver
```
public SupplyDelivery setReceiver(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for receiver ()
    Definition: Identifies the person who picked up the Supply.
  - addReceiver
```
public ResourceReferenceDt addReceiver()
```
    Adds and returns a new value for receiver ()
    Definition: Identifies the person who picked up the Supply.
  - 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 SupplyDelivery

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_SUPPLIER

SUPPLIER

SP_IDENTIFIER

IDENTIFIER

SP_STATUS

STATUS

SP_PATIENT

PATIENT

SP_RECEIVER

RECEIVER

INCLUDE_PATIENT

INCLUDE_RECEIVER

INCLUDE_SUPPLIER

Constructor Detail

SupplyDelivery

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

getStatusElement

getStatus

setStatus

setStatus

getPatient

setPatient

getType

setType

getQuantity

setQuantity

getSuppliedItem

setSuppliedItem

getSupplier

setSupplier

getWhenPrepared

setWhenPrepared

getTimeElement

getTime

setTime

setTime

setTimeWithSecondsPrecision

getDestination

setDestination

getReceiver

setReceiver

addReceiver

getResourceName

getStructureFhirVersionEnum