Class SupplyDelivery
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.model.SupplyDelivery
-
- 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 SupplyDelivery extends DomainResource
Record of delivery of what is supplied.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSupplyDelivery.SupplyDeliveryStatusstatic classSupplyDelivery.SupplyDeliveryStatusEnumFactorystatic classSupplyDelivery.SupplyDeliverySuppliedItemComponent
-
Field Summary
Fields Modifier and Type Field Description protected List<Reference>basedOnA plan, proposal or order that is fulfilled in whole or in part by this event.protected List<SupplyRequest>basedOnTargetThe actual objects that are the target of the reference (A plan, proposal or order that is fulfilled in whole or in part by this event.)protected ReferencedestinationIdentification of the facility/location where the Supply was shipped to, as part of the dispense event.protected LocationdestinationTargetThe actual object that is the target of the reference (Identification of the facility/location where the Supply was shipped to, as part of the dispense event.)protected List<Identifier>identifierIdentifier for the supply delivery event that is used to identify it across multiple disparate systems.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_RECEIVERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUPPLIERConstant for fluent queries to be used to add include statements.protected TypeoccurrenceThe date or time(s) the activity occurred.protected List<Reference>partOfA larger event of which this particular event is a component or step.protected List<Resource>partOfTargetThe actual objects that are the target of the reference (A larger event of which this particular event is a component or step.)protected ReferencepatientA link to a resource representing the person whom the delivered item is for.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected PatientpatientTargetThe actual object that is the target of the reference (A link to a resource representing the person whom the delivered item is for.)protected List<Reference>receiverIdentifies the person who picked up the Supply.static ca.uhn.fhir.rest.gclient.ReferenceClientParamRECEIVERFluent Client search parameter constant for receiverprotected List<Resource>receiverTargetThe actual objects that are the target of the reference (Identifies the person who picked up the Supply.)static StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_RECEIVERSearch parameter: receiverstatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUPPLIERSearch parameter: supplierprotected Enumeration<SupplyDelivery.SupplyDeliveryStatus>statusA code specifying the state of the dispense event.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected SupplyDelivery.SupplyDeliverySuppliedItemComponentsuppliedItemThe item that is being delivered or has been supplied.protected ReferencesupplierThe individual responsible for dispensing the medication, supplier or device.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUPPLIERFluent Client search parameter constant for supplierprotected ResourcesupplierTargetThe actual object that is the target of the reference (The individual responsible for dispensing the medication, supplier or device.)protected CodeableConcepttypeIndicates the type of dispensing event that is performed.-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description SupplyDelivery()Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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 List<Identifier> identifier
Identifier for the supply delivery event that is used to identify it across multiple disparate systems.
-
basedOn
protected List<Reference> basedOn
A plan, proposal or order that is fulfilled in whole or in part by this event.
-
basedOnTarget
protected List<SupplyRequest> basedOnTarget
The actual objects that are the target of the reference (A plan, proposal or order that is fulfilled in whole or in part by this event.)
-
partOf
protected List<Reference> partOf
A larger event of which this particular event is a component or step.
-
partOfTarget
protected List<Resource> partOfTarget
The actual objects that are the target of the reference (A larger event of which this particular event is a component or step.)
-
status
protected Enumeration<SupplyDelivery.SupplyDeliveryStatus> status
A code specifying the state of the dispense event.
-
patient
protected Reference patient
A link to a resource representing the person whom the delivered 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 delivered item is for.)
-
type
protected CodeableConcept type
Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
-
suppliedItem
protected SupplyDelivery.SupplyDeliverySuppliedItemComponent suppliedItem
The item that is being delivered or has been supplied.
-
occurrence
protected Type occurrence
The date or time(s) the activity occurred.
-
supplier
protected Reference supplier
The individual responsible for dispensing the medication, supplier or device.
-
supplierTarget
protected Resource supplierTarget
The actual object that is the target of the reference (The individual responsible for dispensing the medication, supplier or device.)
-
destination
protected Reference destination
Identification of the facility/location where the Supply was shipped to, as part of the dispense event.
-
destinationTarget
protected Location destinationTarget
The actual object that is the target of the reference (Identification of the facility/location where the Supply was shipped to, as part of the dispense event.)
-
receiverTarget
protected List<Resource> receiverTarget
The actual objects that are the target of the reference (Identifies the person who picked up the Supply.)
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: External identifier
Type: token
Path: SupplyDelivery.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External identifier
Type: token
Path: SupplyDelivery.identifier
-
SP_RECEIVER
public static final String SP_RECEIVER
Search parameter: receiverDescription: Who collected the Supply
Type: reference
Path: SupplyDelivery.receiver
- See Also:
- Constant Field Values
-
RECEIVER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RECEIVER
Fluent Client search parameter constant for receiverDescription: Who collected the Supply
Type: reference
Path: SupplyDelivery.receiver
-
INCLUDE_RECEIVER
public static final ca.uhn.fhir.model.api.Include INCLUDE_RECEIVER
Constant for fluent queries to be used to add include statements. Specifies the path value of "SupplyDelivery:receiver".
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: Patient for whom the item is supplied
Type: reference
Path: SupplyDelivery.patient
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: Patient for whom the item is supplied
Type: reference
Path: SupplyDelivery.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 "SupplyDelivery:patient".
-
SP_SUPPLIER
public static final String SP_SUPPLIER
Search parameter: supplierDescription: Dispenser
Type: reference
Path: SupplyDelivery.supplier
- See Also:
- Constant Field Values
-
SUPPLIER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUPPLIER
Fluent Client search parameter constant for supplierDescription: Dispenser
Type: reference
Path: SupplyDelivery.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 "SupplyDelivery:supplier".
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: in-progress | completed | abandoned | entered-in-error
Type: token
Path: SupplyDelivery.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: in-progress | completed | abandoned | entered-in-error
Type: token
Path: SupplyDelivery.status
-
-
Constructor Detail
-
SupplyDelivery
public SupplyDelivery()
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Identifier for the supply delivery event that is used to identify it across multiple disparate systems.)
-
setIdentifier
public SupplyDelivery setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public SupplyDelivery addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
getBasedOn
public List<Reference> getBasedOn()
- Returns:
basedOn(A plan, proposal or order that is fulfilled in whole or in part by this event.)
-
setBasedOn
public SupplyDelivery setBasedOn(List<Reference> theBasedOn)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasBasedOn
public boolean hasBasedOn()
-
addBasedOn
public Reference addBasedOn()
-
addBasedOn
public SupplyDelivery addBasedOn(Reference t)
-
getBasedOnFirstRep
public Reference getBasedOnFirstRep()
- Returns:
- The first repetition of repeating field
basedOn, creating it if it does not already exist
-
getBasedOnTarget
@Deprecated public List<SupplyRequest> getBasedOnTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addBasedOnTarget
@Deprecated public SupplyRequest addBasedOnTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getPartOf
public List<Reference> getPartOf()
- Returns:
partOf(A larger event of which this particular event is a component or step.)
-
setPartOf
public SupplyDelivery setPartOf(List<Reference> thePartOf)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPartOf
public boolean hasPartOf()
-
addPartOf
public SupplyDelivery addPartOf(Reference t)
-
getPartOfFirstRep
public Reference getPartOfFirstRep()
- Returns:
- The first repetition of repeating field
partOf, creating it if it does not already exist
-
getPartOfTarget
@Deprecated public List<Resource> getPartOfTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getStatusElement
public Enumeration<SupplyDelivery.SupplyDeliveryStatus> getStatusElement()
- Returns:
status(A code specifying the state of the dispense event.). 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 SupplyDelivery setStatusElement(Enumeration<SupplyDelivery.SupplyDeliveryStatus> value)
- Parameters:
value-status(A code specifying the state of the dispense event.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public SupplyDelivery.SupplyDeliveryStatus getStatus()
- Returns:
- A code specifying the state of the dispense event.
-
setStatus
public SupplyDelivery setStatus(SupplyDelivery.SupplyDeliveryStatus value)
- Parameters:
value- A code specifying the state of the dispense event.
-
getPatient
public Reference getPatient()
- Returns:
patient(A link to a resource representing the person whom the delivered item is for.)
-
hasPatient
public boolean hasPatient()
-
setPatient
public SupplyDelivery setPatient(Reference value)
- Parameters:
value-patient(A link to a resource representing the person whom the delivered item is for.)
-
getPatientTarget
public Patient getPatientTarget()
- Returns:
patientThe 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 delivered item is for.)
-
setPatientTarget
public SupplyDelivery setPatientTarget(Patient value)
- Parameters:
value-patientThe 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 delivered item is for.)
-
getType
public CodeableConcept getType()
- Returns:
type(Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.)
-
hasType
public boolean hasType()
-
setType
public SupplyDelivery setType(CodeableConcept value)
- Parameters:
value-type(Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.)
-
getSuppliedItem
public SupplyDelivery.SupplyDeliverySuppliedItemComponent getSuppliedItem()
- Returns:
suppliedItem(The item that is being delivered or has been supplied.)
-
hasSuppliedItem
public boolean hasSuppliedItem()
-
setSuppliedItem
public SupplyDelivery setSuppliedItem(SupplyDelivery.SupplyDeliverySuppliedItemComponent value)
- Parameters:
value-suppliedItem(The item that is being delivered or has been supplied.)
-
getOccurrence
public Type getOccurrence()
- Returns:
occurrence(The date or time(s) the activity occurred.)
-
getOccurrenceDateTimeType
public DateTimeType getOccurrenceDateTimeType() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
occurrence(The date or time(s) the activity occurred.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrenceDateTimeType
public boolean hasOccurrenceDateTimeType()
-
getOccurrencePeriod
public Period getOccurrencePeriod() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
occurrence(The date or time(s) the activity occurred.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrencePeriod
public boolean hasOccurrencePeriod()
-
getOccurrenceTiming
public Timing getOccurrenceTiming() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
occurrence(The date or time(s) the activity occurred.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrenceTiming
public boolean hasOccurrenceTiming()
-
hasOccurrence
public boolean hasOccurrence()
-
setOccurrence
public SupplyDelivery setOccurrence(Type value)
- Parameters:
value-occurrence(The date or time(s) the activity occurred.)
-
getSupplier
public Reference getSupplier()
- Returns:
supplier(The individual responsible for dispensing the medication, supplier or device.)
-
hasSupplier
public boolean hasSupplier()
-
setSupplier
public SupplyDelivery setSupplier(Reference value)
- Parameters:
value-supplier(The individual responsible for dispensing the medication, supplier or device.)
-
getSupplierTarget
public Resource getSupplierTarget()
- Returns:
supplierThe 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 individual responsible for dispensing the medication, supplier or device.)
-
setSupplierTarget
public SupplyDelivery setSupplierTarget(Resource value)
- Parameters:
value-supplierThe 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 individual responsible for dispensing the medication, supplier or device.)
-
getDestination
public Reference getDestination()
- Returns:
destination(Identification of the facility/location where the Supply was shipped to, as part of the dispense event.)
-
hasDestination
public boolean hasDestination()
-
setDestination
public SupplyDelivery setDestination(Reference value)
- Parameters:
value-destination(Identification of the facility/location where the Supply was shipped to, as part of the dispense event.)
-
getDestinationTarget
public Location getDestinationTarget()
- Returns:
destinationThe 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. (Identification of the facility/location where the Supply was shipped to, as part of the dispense event.)
-
setDestinationTarget
public SupplyDelivery setDestinationTarget(Location value)
- Parameters:
value-destinationThe 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. (Identification of the facility/location where the Supply was shipped to, as part of the dispense event.)
-
getReceiver
public List<Reference> getReceiver()
- Returns:
receiver(Identifies the person who picked up the Supply.)
-
setReceiver
public SupplyDelivery setReceiver(List<Reference> theReceiver)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReceiver
public boolean hasReceiver()
-
addReceiver
public Reference addReceiver()
-
addReceiver
public SupplyDelivery addReceiver(Reference t)
-
getReceiverFirstRep
public Reference getReceiverFirstRep()
- Returns:
- The first repetition of repeating field
receiver, creating it if it does not already exist
-
getReceiverTarget
@Deprecated public List<Resource> getReceiverTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public SupplyDelivery copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(SupplyDelivery dst)
-
typedCopy
protected SupplyDelivery typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-