Package org.hl7.fhir.dstu2016may.model

Class 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

    • Field Detail

      • identifier

        protected Identifier identifier
        Identifier assigned by the dispensing facility when the item(s) is dispensed.

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

      • quantity

        protected SimpleQuantity quantity
        The amount of supply that has been dispensed. Includes unit of measure.

      • suppliedItem

        protected Reference suppliedItem
        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.

      • suppliedItemTarget

        protected Resource suppliedItemTarget
        The actual object that is the target of the reference (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.)

      • supplier

        protected Reference supplier
        The individual responsible for dispensing the medication, supplier or device.

      • supplierTarget

        protected Practitioner supplierTarget
        The actual object that is the target of the reference (The individual responsible for dispensing the medication, supplier or device.)

      • time

        protected DateTimeType time
        The time the dispensed item was sent or handed to the patient (or agent).

      • 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<Practitioner> receiverTarget
        The actual objects that are the target of the reference (Identifies the person who picked up the Supply.)

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: 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 patient

        Description: 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_RECEIVER

        public static final String SP_RECEIVER
        Search parameter: receiver

        Description: 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 receiver

        Description: 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_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: in-progress | completed | abandoned
        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 status

        Description: in-progress | completed | abandoned
        Type: token
        Path: SupplyDelivery.status

      • IDENTIFIER

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

        Description: External identifier
        Type: token
        Path: SupplyDelivery.identifier

      • SUPPLIER

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

        Description: 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".

    • Method Detail

      • getPatient

        public Reference getPatient()
        Returns:
        patient (A link to a resource representing the person whom the delivered 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 delivered item is for.)

      • setPatientTarget

        public SupplyDelivery 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 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 Reference getSuppliedItem()
        Returns:
        suppliedItem (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​(Reference value)
        Parameters:
        value - suppliedItem (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.)

      • getSuppliedItemTarget

        public Resource getSuppliedItemTarget()
        Returns:
        suppliedItem 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. (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.)

      • setSuppliedItemTarget

        public SupplyDelivery setSuppliedItemTarget​(Resource value)
        Parameters:
        value - suppliedItem 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. (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 Reference getSupplier()
        Returns:
        supplier (The individual responsible for dispensing the medication, supplier or device.)

      • getSupplierTarget

        public Practitioner getSupplierTarget()
        Returns:
        supplier 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 individual responsible for dispensing the medication, supplier or device.)

      • setSupplierTarget

        public SupplyDelivery setSupplierTarget​(Practitioner value)
        Parameters:
        value - supplier 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 individual responsible for dispensing the medication, supplier or device.)

      • getTimeElement

        public DateTimeType getTimeElement()
        Returns:
        time (The time the dispensed item was sent or handed to the patient (or agent).). This is the underlying object with id, value and extensions. The accessor "getTime" gives direct access to the value

      • hasTime

        public boolean hasTime()

      • setTimeElement

        public SupplyDelivery setTimeElement​(DateTimeType value)
        Parameters:
        value - time (The time the dispensed item was sent or handed to the patient (or agent).). This is the underlying object with id, value and extensions. The accessor "getTime" gives direct access to the value

      • getTime

        public Date getTime()
        Returns:
        The time the dispensed item was sent or handed to the patient (or agent).

      • setTime

        public SupplyDelivery setTime​(Date value)
        Parameters:
        value - The time the dispensed item was sent or handed to the patient (or agent).

      • getDestination

        public Reference getDestination()
        Returns:
        destination (Identification of the facility/location where the Supply was shipped to, as part of the dispense event.)

      • getDestinationTarget

        public Location getDestinationTarget()
        Returns:
        destination 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. (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 - destination 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. (Identification of the facility/location where the Supply was shipped to, as part of the dispense event.)

      • getReceiverTarget

        public List<Practitioner> getReceiverTarget()
        Returns:
        receiver (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. Identifies the person who picked up the Supply.)

      • addReceiverTarget

        public Practitioner addReceiverTarget()
        Returns:
        receiver (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. Identifies the person who picked up the Supply.)

      • getProperty

        public Base[] getProperty​(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • makeProperty

        public Base makeProperty​(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource