SupplyRequest (HAPI FHIR Structures - HL7.org DSTU2 3.3.0 API)

java.lang.Object
- org.hl7.fhir.instance.model.Base
- - org.hl7.fhir.instance.model.BaseResource
  - - org.hl7.fhir.instance.model.Resource
    - - org.hl7.fhir.instance.model.DomainResource
      - org.hl7.fhir.instance.model.SupplyRequest

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 SupplyRequest
extends DomainResource
```
A record of a request for a medication, substance or device used in the healthcare setting.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SupplyRequest.SupplyRequestStatus`
`static class`	`SupplyRequest.SupplyRequestStatusEnumFactory`
`static class`	`SupplyRequest.SupplyRequestWhenComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`protected DateTimeType`	`date` When the request was made.
`protected Identifier`	`identifier` Unique identifier for this supply request.
`protected CodeableConcept`	`kind` Category of supply, e.g.
`protected Reference`	`orderedItem` The item that is requested to be supplied.
`protected Resource`	`orderedItemTarget` The actual object that is the target of the reference (The item that is requested to be supplied.)
`protected Reference`	`patient` A link to a resource representing the person whom the ordered item is for.
`protected Patient`	`patientTarget` The actual object that is the target of the reference (A link to a resource representing the person whom the ordered item is for.)
`protected Type`	`reason` Why the supply item was requested.
`protected Reference`	`source` The Practitioner , Organization or Patient who initiated this order for the supply.
`protected Resource`	`sourceTarget` The actual object that is the target of the reference (The Practitioner , Organization or Patient who initiated this order for the supply.)
`static String`	`SP_DATE`
`static String`	`SP_IDENTIFIER`
`static String`	`SP_KIND`
`static String`	`SP_PATIENT`
`static String`	`SP_SOURCE`
`static String`	`SP_STATUS`
`static String`	`SP_SUPPLIER`
`protected Enumeration<SupplyRequest.SupplyRequestStatus>`	`status` Status of the supply request.
`protected List<Reference>`	`supplier` Who is intended to fulfill the request.
`protected List<Organization>`	`supplierTarget` The actual objects that are the target of the reference (Who is intended to fulfill the request.)
`protected SupplyRequest.SupplyRequestWhenComponent`	`when` When the request should be fulfilled.

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

Fields inherited from class org.hl7.fhir.instance.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

SupplyRequest()

Constructors
Constructor and Description
`SupplyRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Reference`	`addSupplier()`
`SupplyRequest`	`addSupplier(Reference t)`
`Organization`	`addSupplierTarget()`
`SupplyRequest`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`Date`	`getDate()`
`DateTimeType`	`getDateElement()`
`Identifier`	`getIdentifier()`
`CodeableConcept`	`getKind()`
`Reference`	`getOrderedItem()`
`Resource`	`getOrderedItemTarget()`
`Reference`	`getPatient()`
`Patient`	`getPatientTarget()`
`Type`	`getReason()`
`CodeableConcept`	`getReasonCodeableConcept()`
`Reference`	`getReasonReference()`
`ResourceType`	`getResourceType()`
`Reference`	`getSource()`
`Resource`	`getSourceTarget()`
`SupplyRequest.SupplyRequestStatus`	`getStatus()`
`Enumeration<SupplyRequest.SupplyRequestStatus>`	`getStatusElement()`
`List<Reference>`	`getSupplier()`
`List<Organization>`	`getSupplierTarget()`
`SupplyRequest.SupplyRequestWhenComponent`	`getWhen()`
`boolean`	`hasDate()`
`boolean`	`hasDateElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasKind()`
`boolean`	`hasOrderedItem()`
`boolean`	`hasPatient()`
`boolean`	`hasReason()`
`boolean`	`hasReasonCodeableConcept()`
`boolean`	`hasReasonReference()`
`boolean`	`hasSource()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasSupplier()`
`boolean`	`hasWhen()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`SupplyRequest`	`setDate(Date value)`
`SupplyRequest`	`setDateElement(DateTimeType value)`
`SupplyRequest`	`setIdentifier(Identifier value)`
`SupplyRequest`	`setKind(CodeableConcept value)`
`SupplyRequest`	`setOrderedItem(Reference value)`
`SupplyRequest`	`setOrderedItemTarget(Resource value)`
`SupplyRequest`	`setPatient(Reference value)`
`SupplyRequest`	`setPatientTarget(Patient value)`
`void`	`setProperty(String name, Base value)`
`SupplyRequest`	`setReason(Type value)`
`SupplyRequest`	`setSource(Reference value)`
`SupplyRequest`	`setSourceTarget(Resource value)`
`SupplyRequest`	`setStatus(SupplyRequest.SupplyRequestStatus value)`
`SupplyRequest`	`setStatusElement(Enumeration<SupplyRequest.SupplyRequestStatus> value)`
`SupplyRequest`	`setWhen(SupplyRequest.SupplyRequestWhenComponent value)`
`protected SupplyRequest`	`typedCopy()`

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

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

Methods inherited from class org.hl7.fhir.instance.model.BaseResource
setId

Methods inherited from class org.hl7.fhir.instance.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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
  - patient
```
protected Reference patient
```
    A link to a resource representing the person whom the ordered item is for.
  - patientTarget
```
protected Patient patientTarget
```
    The actual object that is the target of the reference (A link to a resource representing the person whom the ordered item is for.)
  - source
```
protected Reference source
```
    The Practitioner , Organization or Patient who initiated this order for the supply.
  - sourceTarget
```
protected Resource sourceTarget
```
    The actual object that is the target of the reference (The Practitioner , Organization or Patient who initiated this order for the supply.)
  - date
```
protected DateTimeType date
```
    When the request was made.
  - identifier
```
protected Identifier identifier
```
    Unique identifier for this supply request.
  - status
```
protected Enumeration<SupplyRequest.SupplyRequestStatus> status
```
    Status of the supply request.
  - kind
```
protected CodeableConcept kind
```
    Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
  - orderedItem
```
protected Reference orderedItem
```
    The item that is requested to be supplied.
  - orderedItemTarget
```
protected Resource orderedItemTarget
```
    The actual object that is the target of the reference (The item that is requested to be supplied.)
  - supplier
```
protected List<Reference> supplier
```
    Who is intended to fulfill the request.
  - supplierTarget
```
protected List<Organization> supplierTarget
```
    The actual objects that are the target of the reference (Who is intended to fulfill the request.)
  - reason
```
protected Type reason
```
    Why the supply item was requested.
  - when
```
protected SupplyRequest.SupplyRequestWhenComponent when
```
    When the request should be fulfilled.
  - SP_DATE
```
public static final String SP_DATE
```
    See Also:
    
    Constant Field Values
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - SP_KIND
```
public static final String SP_KIND
```
    See Also:
    
    Constant Field Values
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    See Also:
    
    Constant Field Values
  - SP_SUPPLIER
```
public static final String SP_SUPPLIER
```
    See Also:
    
    Constant Field Values
  - SP_SOURCE
```
public static final String SP_SOURCE
```
    See Also:
    
    Constant Field Values
  - SP_STATUS
```
public static final String SP_STATUS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SupplyRequest
```
public SupplyRequest()
```
- Method Detail
  - getPatient
```
public Reference getPatient()
```
    Returns:
    
    patient (A link to a resource representing the person whom the ordered item is for.)
  - hasPatient
```
public boolean hasPatient()
```
  - setPatient
```
public SupplyRequest setPatient(Reference value)
```
    Parameters:
    
    value - patient (A link to a resource representing the person whom the ordered item is for.)
  - 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. (A link to a resource representing the person whom the ordered item is for.)
  - setPatientTarget
```
public SupplyRequest 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. (A link to a resource representing the person whom the ordered item is for.)
  - getSource
```
public Reference getSource()
```
    Returns:
    
    source (The Practitioner , Organization or Patient who initiated this order for the supply.)
  - hasSource
```
public boolean hasSource()
```
  - setSource
```
public SupplyRequest setSource(Reference value)
```
    Parameters:
    
    value - source (The Practitioner , Organization or Patient who initiated this order for the supply.)
  - getSourceTarget
```
public Resource getSourceTarget()
```
    Returns:
    
    source 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 Practitioner , Organization or Patient who initiated this order for the supply.)
  - setSourceTarget
```
public SupplyRequest setSourceTarget(Resource value)
```
    Parameters:
    
    value - source 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 Practitioner , Organization or Patient who initiated this order for the supply.)
  - getDateElement
```
public DateTimeType getDateElement()
```
    Returns:
    
    date (When the request was made.). 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 SupplyRequest setDateElement(DateTimeType value)
```
    Parameters:
    
    value - date (When the request was made.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
  - getDate
```
public Date getDate()
```
    Returns:
    
    When the request was made.
  - setDate
```
public SupplyRequest setDate(Date value)
```
    Parameters:
    
    value - When the request was made.
  - getIdentifier
```
public Identifier getIdentifier()
```
    Returns:
    
    identifier (Unique identifier for this supply request.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - setIdentifier
```
public SupplyRequest setIdentifier(Identifier value)
```
    Parameters:
    
    value - identifier (Unique identifier for this supply request.)
  - getStatusElement
```
public Enumeration<SupplyRequest.SupplyRequestStatus> getStatusElement()
```
    Returns:
    
    status (Status of the supply 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 SupplyRequest setStatusElement(Enumeration<SupplyRequest.SupplyRequestStatus> value)
```
    Parameters:
    
    value - status (Status of the supply request.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public SupplyRequest.SupplyRequestStatus getStatus()
```
    Returns:
    
    Status of the supply request.
  - setStatus
```
public SupplyRequest setStatus(SupplyRequest.SupplyRequestStatus value)
```
    Parameters:
    
    value - Status of the supply request.
  - getKind
```
public CodeableConcept getKind()
```
    Returns:
    
    kind (Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.)
  - hasKind
```
public boolean hasKind()
```
  - setKind
```
public SupplyRequest setKind(CodeableConcept value)
```
    Parameters:
    
    value - kind (Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.)
  - getOrderedItem
```
public Reference getOrderedItem()
```
    Returns:
    
    orderedItem (The item that is requested to be supplied.)
  - hasOrderedItem
```
public boolean hasOrderedItem()
```
  - setOrderedItem
```
public SupplyRequest setOrderedItem(Reference value)
```
    Parameters:
    
    value - orderedItem (The item that is requested to be supplied.)
  - getOrderedItemTarget
```
public Resource getOrderedItemTarget()
```
    Returns:
    
    orderedItem 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 item that is requested to be supplied.)
  - setOrderedItemTarget
```
public SupplyRequest setOrderedItemTarget(Resource value)
```
    Parameters:
    
    value - orderedItem 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 item that is requested to be supplied.)
  - getSupplier
```
public List<Reference> getSupplier()
```
    Returns:
    
    supplier (Who is intended to fulfill the request.)
  - hasSupplier
```
public boolean hasSupplier()
```
  - addSupplier
```
public Reference addSupplier()
```
    Returns:
    
    supplier (Who is intended to fulfill the request.)
  - addSupplier
```
public SupplyRequest addSupplier(Reference t)
```
  - getSupplierTarget
```
public List<Organization> getSupplierTarget()
```
    Returns:
    
    supplier (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. Who is intended to fulfill the request.)
  - addSupplierTarget
```
public Organization addSupplierTarget()
```
    Returns:
    
    supplier (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. Who is intended to fulfill the request.)
  - getReason
```
public Type getReason()
```
    Returns:
    
    reason (Why the supply item was requested.)
  - getReasonCodeableConcept
```
public CodeableConcept getReasonCodeableConcept()
                                         throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    reason (Why the supply item was requested.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasReasonCodeableConcept
```
public boolean hasReasonCodeableConcept()
```
  - getReasonReference
```
public Reference getReasonReference()
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    reason (Why the supply item was requested.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasReasonReference
```
public boolean hasReasonReference()
```
  - hasReason
```
public boolean hasReason()
```
  - setReason
```
public SupplyRequest setReason(Type value)
```
    Parameters:
    
    value - reason (Why the supply item was requested.)
  - getWhen
```
public SupplyRequest.SupplyRequestWhenComponent getWhen()
```
    Returns:
    
    when (When the request should be fulfilled.)
  - hasWhen
```
public boolean hasWhen()
```
  - setWhen
```
public SupplyRequest setWhen(SupplyRequest.SupplyRequestWhenComponent value)
```
    Parameters:
    
    value - when (When the request should be fulfilled.)
  - 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()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public SupplyRequest copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected SupplyRequest 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 SupplyRequest

Nested Class Summary

Field Summary

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

Fields inherited from class org.hl7.fhir.instance.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.instance.model.DomainResource

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

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

Methods inherited from class org.hl7.fhir.instance.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

patient

patientTarget

source

sourceTarget

date

identifier

status

kind

orderedItem

orderedItemTarget

supplier

supplierTarget

reason

when

SP_DATE

SP_IDENTIFIER

SP_KIND

SP_PATIENT

SP_SUPPLIER

SP_SOURCE

SP_STATUS

Constructor Detail

SupplyRequest

Method Detail

getPatient

hasPatient

setPatient

getPatientTarget

setPatientTarget

getSource

hasSource

setSource

getSourceTarget

setSourceTarget

getDateElement

hasDateElement

hasDate

setDateElement

getDate

setDate

getIdentifier

hasIdentifier

setIdentifier

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getKind

hasKind

setKind

getOrderedItem

hasOrderedItem

setOrderedItem

getOrderedItemTarget

setOrderedItemTarget

getSupplier

hasSupplier

addSupplier

addSupplier

getSupplierTarget