
Class SupplyRequest
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.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 Description static class
SupplyRequest.RequestPriority
static class
SupplyRequest.RequestPriorityEnumFactory
static class
SupplyRequest.SupplyRequestOrderedItemComponent
static class
SupplyRequest.SupplyRequestRequesterComponent
static class
SupplyRequest.SupplyRequestStatus
static class
SupplyRequest.SupplyRequestStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected DateTimeType
authoredOn
When the request was made.protected CodeableConcept
category
Category of supply, e.g.static ca.uhn.fhir.rest.gclient.TokenClientParam
CATEGORY
Fluent Client search parameter constant for categorystatic ca.uhn.fhir.rest.gclient.DateClientParam
DATE
Fluent Client search parameter constant for dateprotected Reference
deliverFrom
Where the supply is expected to come from.protected Resource
deliverFromTarget
The actual object that is the target of the reference (Where the supply is expected to come from.)protected Reference
deliverTo
Where the supply is destined to go.protected Resource
deliverToTarget
The actual object that is the target of the reference (Where the supply is destined to go.)protected Identifier
identifier
Unique identifier for this supply request.static ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.Include
INCLUDE_REQUESTER
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_SUPPLIER
Constant for fluent queries to be used to add include statements.protected Type
occurrence
When the request should be fulfilled.protected SupplyRequest.SupplyRequestOrderedItemComponent
orderedItem
The item being requested.protected Enumeration<SupplyRequest.RequestPriority>
priority
Indicates how quickly this SupplyRequest should be addressed with respect to other requests.protected Type
reason
Why the supply item was requested.protected SupplyRequest.SupplyRequestRequesterComponent
requester
The individual who initiated the request and has responsibility for its activation.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
REQUESTER
Fluent Client search parameter constant for requesterstatic String
SP_CATEGORY
Search parameter: categorystatic String
SP_DATE
Search parameter: datestatic String
SP_IDENTIFIER
Search parameter: identifierstatic String
SP_REQUESTER
Search parameter: requesterstatic String
SP_STATUS
Search parameter: statusstatic String
SP_SUPPLIER
Search parameter: supplierprotected Enumeration<SupplyRequest.SupplyRequestStatus>
status
Status of the supply request.static ca.uhn.fhir.rest.gclient.TokenClientParam
STATUS
Fluent Client search parameter constant for statusprotected List<Reference>
supplier
Who is intended to fulfill the request.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
SUPPLIER
Fluent Client search parameter constant for supplierprotected List<Organization>
supplierTarget
The actual objects that are the target of the reference (Who is intended to fulfill the request.)-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description SupplyRequest()
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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
-
-
-
-
Field Detail
-
identifier
protected Identifier identifier
Unique identifier for this supply request.
-
status
protected Enumeration<SupplyRequest.SupplyRequestStatus> status
Status of the supply request.
-
category
protected CodeableConcept category
Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
-
priority
protected Enumeration<SupplyRequest.RequestPriority> priority
Indicates how quickly this SupplyRequest should be addressed with respect to other requests.
-
orderedItem
protected SupplyRequest.SupplyRequestOrderedItemComponent orderedItem
The item being requested.
-
occurrence
protected Type occurrence
When the request should be fulfilled.
-
authoredOn
protected DateTimeType authoredOn
When the request was made.
-
requester
protected SupplyRequest.SupplyRequestRequesterComponent requester
The individual who initiated the request and has responsibility for its activation.
-
supplierTarget
protected List<Organization> supplierTarget
The actual objects that are the target of the reference (Who is intended to fulfill the request.)
-
deliverFrom
protected Reference deliverFrom
Where the supply is expected to come from.
-
deliverFromTarget
protected Resource deliverFromTarget
The actual object that is the target of the reference (Where the supply is expected to come from.)
-
deliverToTarget
protected Resource deliverToTarget
The actual object that is the target of the reference (Where the supply is destined to go.)
-
SP_REQUESTER
public static final String SP_REQUESTER
Search parameter: requesterDescription: Individual making the request
Type: reference
Path: SupplyRequest.requester.agent
- See Also:
- Constant Field Values
-
REQUESTER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REQUESTER
Fluent Client search parameter constant for requesterDescription: Individual making the request
Type: reference
Path: SupplyRequest.requester.agent
-
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 "SupplyRequest:requester".
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: When the request was made
Type: date
Path: SupplyRequest.authoredOn
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: When the request was made
Type: date
Path: SupplyRequest.authoredOn
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Unique identifier
Type: token
Path: SupplyRequest.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Unique identifier
Type: token
Path: SupplyRequest.identifier
-
SP_SUPPLIER
public static final String SP_SUPPLIER
Search parameter: supplierDescription: Who is intended to fulfill the request
Type: reference
Path: SupplyRequest.supplier
- See Also:
- Constant Field Values
-
SUPPLIER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUPPLIER
Fluent Client search parameter constant for supplierDescription: Who is intended to fulfill the request
Type: reference
Path: SupplyRequest.supplier
-
INCLUDE_SUPPLIER
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUPPLIER
Constant for fluent queries to be used to add include statements. Specifies the path value of "SupplyRequest:supplier".
-
SP_CATEGORY
public static final String SP_CATEGORY
Search parameter: categoryDescription: The kind of supply (central, non-stock, etc.)
Type: token
Path: SupplyRequest.category
- See Also:
- Constant Field Values
-
CATEGORY
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
Fluent Client search parameter constant for categoryDescription: The kind of supply (central, non-stock, etc.)
Type: token
Path: SupplyRequest.category
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: draft | active | suspended +
Type: token
Path: SupplyRequest.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: draft | active | suspended +
Type: token
Path: SupplyRequest.status
-
-
Constructor Detail
-
SupplyRequest
public SupplyRequest()
Constructor
-
-
Method Detail
-
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.
-
getCategory
public CodeableConcept getCategory()
- Returns:
category
(Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.)
-
hasCategory
public boolean hasCategory()
-
setCategory
public SupplyRequest setCategory(CodeableConcept value)
- Parameters:
value
-category
(Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.)
-
getPriorityElement
public Enumeration<SupplyRequest.RequestPriority> getPriorityElement()
- Returns:
priority
(Indicates how quickly this SupplyRequest should be addressed with respect to other requests.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
-
hasPriorityElement
public boolean hasPriorityElement()
-
hasPriority
public boolean hasPriority()
-
setPriorityElement
public SupplyRequest setPriorityElement(Enumeration<SupplyRequest.RequestPriority> value)
- Parameters:
value
-priority
(Indicates how quickly this SupplyRequest should be addressed with respect to other requests.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
-
getPriority
public SupplyRequest.RequestPriority getPriority()
- Returns:
- Indicates how quickly this SupplyRequest should be addressed with respect to other requests.
-
setPriority
public SupplyRequest setPriority(SupplyRequest.RequestPriority value)
- Parameters:
value
- Indicates how quickly this SupplyRequest should be addressed with respect to other requests.
-
getOrderedItem
public SupplyRequest.SupplyRequestOrderedItemComponent getOrderedItem()
- Returns:
orderedItem
(The item being requested.)
-
hasOrderedItem
public boolean hasOrderedItem()
-
setOrderedItem
public SupplyRequest setOrderedItem(SupplyRequest.SupplyRequestOrderedItemComponent value)
- Parameters:
value
-orderedItem
(The item being requested.)
-
getOccurrence
public Type getOccurrence()
- Returns:
occurrence
(When the request should be fulfilled.)
-
getOccurrenceDateTimeType
public DateTimeType getOccurrenceDateTimeType() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
occurrence
(When the request should be fulfilled.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrenceDateTimeType
public boolean hasOccurrenceDateTimeType()
-
getOccurrencePeriod
public Period getOccurrencePeriod() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
occurrence
(When the request should be fulfilled.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrencePeriod
public boolean hasOccurrencePeriod()
-
getOccurrenceTiming
public Timing getOccurrenceTiming() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
occurrence
(When the request should be fulfilled.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrenceTiming
public boolean hasOccurrenceTiming()
-
hasOccurrence
public boolean hasOccurrence()
-
setOccurrence
public SupplyRequest setOccurrence(Type value) throws org.hl7.fhir.exceptions.FHIRFormatError
- Parameters:
value
-occurrence
(When the request should be fulfilled.)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
getAuthoredOnElement
public DateTimeType getAuthoredOnElement()
- Returns:
authoredOn
(When the request was made.). This is the underlying object with id, value and extensions. The accessor "getAuthoredOn" gives direct access to the value
-
hasAuthoredOnElement
public boolean hasAuthoredOnElement()
-
hasAuthoredOn
public boolean hasAuthoredOn()
-
setAuthoredOnElement
public SupplyRequest setAuthoredOnElement(DateTimeType value)
- Parameters:
value
-authoredOn
(When the request was made.). This is the underlying object with id, value and extensions. The accessor "getAuthoredOn" gives direct access to the value
-
getAuthoredOn
public Date getAuthoredOn()
- Returns:
- When the request was made.
-
setAuthoredOn
public SupplyRequest setAuthoredOn(Date value)
- Parameters:
value
- When the request was made.
-
getRequester
public SupplyRequest.SupplyRequestRequesterComponent getRequester()
- Returns:
requester
(The individual who initiated the request and has responsibility for its activation.)
-
hasRequester
public boolean hasRequester()
-
setRequester
public SupplyRequest setRequester(SupplyRequest.SupplyRequestRequesterComponent value)
- Parameters:
value
-requester
(The individual who initiated the request and has responsibility for its activation.)
-
getSupplier
public List<Reference> getSupplier()
- Returns:
supplier
(Who is intended to fulfill the request.)
-
setSupplier
public SupplyRequest setSupplier(List<Reference> theSupplier)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSupplier
public boolean hasSupplier()
-
addSupplier
public Reference addSupplier()
-
addSupplier
public SupplyRequest addSupplier(Reference t)
-
getSupplierFirstRep
public Reference getSupplierFirstRep()
- Returns:
- The first repetition of repeating field
supplier
, creating it if it does not already exist
-
getSupplierTarget
@Deprecated public List<Organization> getSupplierTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addSupplierTarget
@Deprecated public Organization addSupplierTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
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) throws org.hl7.fhir.exceptions.FHIRFormatError
- Parameters:
value
-reason
(Why the supply item was requested.)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
getDeliverFrom
public Reference getDeliverFrom()
- Returns:
deliverFrom
(Where the supply is expected to come from.)
-
hasDeliverFrom
public boolean hasDeliverFrom()
-
setDeliverFrom
public SupplyRequest setDeliverFrom(Reference value)
- Parameters:
value
-deliverFrom
(Where the supply is expected to come from.)
-
getDeliverFromTarget
public Resource getDeliverFromTarget()
- Returns:
deliverFrom
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. (Where the supply is expected to come from.)
-
setDeliverFromTarget
public SupplyRequest setDeliverFromTarget(Resource value)
- Parameters:
value
-deliverFrom
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. (Where the supply is expected to come from.)
-
getDeliverTo
public Reference getDeliverTo()
- Returns:
deliverTo
(Where the supply is destined to go.)
-
hasDeliverTo
public boolean hasDeliverTo()
-
setDeliverTo
public SupplyRequest setDeliverTo(Reference value)
- Parameters:
value
-deliverTo
(Where the supply is destined to go.)
-
getDeliverToTarget
public Resource getDeliverToTarget()
- Returns:
deliverTo
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. (Where the supply is destined to go.)
-
setDeliverToTarget
public SupplyRequest setDeliverToTarget(Resource value)
- Parameters:
value
-deliverTo
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. (Where the supply is destined to go.)
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
public SupplyRequest copy()
- Specified by:
copy
in classDomainResource
-
typedCopy
protected SupplyRequest typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceType
in classResource
-
-