Class SupplyDelivery

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class SupplyDelivery
    extends BaseResource
    implements ca.uhn.fhir.model.api.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 Detail

      • SUPPLIER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUPPLIER
        Fluent Client search parameter constant for supplier

        Description:
        Type: reference
        Path: SupplyDelivery.supplier

      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description:
        Type: token
        Path: SupplyDelivery.identifier

      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description:
        Type: token
        Path: SupplyDelivery.status

      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description:
        Type: reference
        Path: SupplyDelivery.patient

      • RECEIVER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RECEIVER
        Fluent Client search parameter constant for receiver

        Description:
        Type: reference
        Path: SupplyDelivery.receiver

      • 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".
      • 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".
      • 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".
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.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 ca.uhn.fhir.model.primitive.BoundCodeDt<SupplyDeliveryStatusEnumgetStatusElement()
        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. This method may return null.

        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

      • 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.

      • 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.

      • 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.

      • getTimeElement

        public ca.uhn.fhir.model.primitive.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. This method may return null.

        Definition: The time the dispensed item was sent or handed to the patient (or agent).

      • setTime

        public SupplyDelivery setTime​(ca.uhn.fhir.model.primitive.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,
                                      ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        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<ResourceReferenceDtgetReceiver()
        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.

      • 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 ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource