blob: a4ad3da2c4674ced47fe8f5240bb9e8524e78c82 [file] [log] [blame]
/**
*/
package org.hl7.fhir;
import org.eclipse.emf.common.util.EList;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Supply Delivery</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* Record of delivery of what is supplied.
* If the element is present, it must have either a @value, an @id, or extensions
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.hl7.fhir.SupplyDelivery#getIdentifier <em>Identifier</em>}</li>
* <li>{@link org.hl7.fhir.SupplyDelivery#getBasedOn <em>Based On</em>}</li>
* <li>{@link org.hl7.fhir.SupplyDelivery#getPartOf <em>Part Of</em>}</li>
* <li>{@link org.hl7.fhir.SupplyDelivery#getStatus <em>Status</em>}</li>
* <li>{@link org.hl7.fhir.SupplyDelivery#getPatient <em>Patient</em>}</li>
* <li>{@link org.hl7.fhir.SupplyDelivery#getType <em>Type</em>}</li>
* <li>{@link org.hl7.fhir.SupplyDelivery#getSuppliedItem <em>Supplied Item</em>}</li>
* <li>{@link org.hl7.fhir.SupplyDelivery#getOccurrenceDateTime <em>Occurrence Date Time</em>}</li>
* <li>{@link org.hl7.fhir.SupplyDelivery#getOccurrencePeriod <em>Occurrence Period</em>}</li>
* <li>{@link org.hl7.fhir.SupplyDelivery#getOccurrenceTiming <em>Occurrence Timing</em>}</li>
* <li>{@link org.hl7.fhir.SupplyDelivery#getSupplier <em>Supplier</em>}</li>
* <li>{@link org.hl7.fhir.SupplyDelivery#getDestination <em>Destination</em>}</li>
* <li>{@link org.hl7.fhir.SupplyDelivery#getReceiver <em>Receiver</em>}</li>
* </ul>
*
* @see org.hl7.fhir.FhirPackage#getSupplyDelivery()
* @model extendedMetaData="name='SupplyDelivery' kind='elementOnly'"
* @generated
*/
public interface SupplyDelivery extends DomainResource {
/**
* Returns the value of the '<em><b>Identifier</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.Identifier}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Identifier for the supply delivery event that is used to identify it across multiple disparate systems.
* <!-- end-model-doc -->
* @return the value of the '<em>Identifier</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getSupplyDelivery_Identifier()
* @model containment="true"
* extendedMetaData="kind='element' name='identifier' namespace='##targetNamespace'"
* @generated
*/
EList<Identifier> getIdentifier();
/**
* Returns the value of the '<em><b>Based On</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.Reference}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A plan, proposal or order that is fulfilled in whole or in part by this event.
* <!-- end-model-doc -->
* @return the value of the '<em>Based On</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getSupplyDelivery_BasedOn()
* @model containment="true"
* extendedMetaData="kind='element' name='basedOn' namespace='##targetNamespace'"
* @generated
*/
EList<Reference> getBasedOn();
/**
* Returns the value of the '<em><b>Part Of</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.Reference}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A larger event of which this particular event is a component or step.
* <!-- end-model-doc -->
* @return the value of the '<em>Part Of</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getSupplyDelivery_PartOf()
* @model containment="true"
* extendedMetaData="kind='element' name='partOf' namespace='##targetNamespace'"
* @generated
*/
EList<Reference> getPartOf();
/**
* Returns the value of the '<em><b>Status</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A code specifying the state of the dispense event.
* <!-- end-model-doc -->
* @return the value of the '<em>Status</em>' containment reference.
* @see #setStatus(SupplyDeliveryStatus)
* @see org.hl7.fhir.FhirPackage#getSupplyDelivery_Status()
* @model containment="true"
* extendedMetaData="kind='element' name='status' namespace='##targetNamespace'"
* @generated
*/
SupplyDeliveryStatus getStatus();
/**
* Sets the value of the '{@link org.hl7.fhir.SupplyDelivery#getStatus <em>Status</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Status</em>' containment reference.
* @see #getStatus()
* @generated
*/
void setStatus(SupplyDeliveryStatus value);
/**
* Returns the value of the '<em><b>Patient</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A link to a resource representing the person whom the delivered item is for.
* <!-- end-model-doc -->
* @return the value of the '<em>Patient</em>' containment reference.
* @see #setPatient(Reference)
* @see org.hl7.fhir.FhirPackage#getSupplyDelivery_Patient()
* @model containment="true"
* extendedMetaData="kind='element' name='patient' namespace='##targetNamespace'"
* @generated
*/
Reference getPatient();
/**
* Sets the value of the '{@link org.hl7.fhir.SupplyDelivery#getPatient <em>Patient</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Patient</em>' containment reference.
* @see #getPatient()
* @generated
*/
void setPatient(Reference value);
/**
* Returns the value of the '<em><b>Type</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
* <!-- end-model-doc -->
* @return the value of the '<em>Type</em>' containment reference.
* @see #setType(CodeableConcept)
* @see org.hl7.fhir.FhirPackage#getSupplyDelivery_Type()
* @model containment="true"
* extendedMetaData="kind='element' name='type' namespace='##targetNamespace'"
* @generated
*/
CodeableConcept getType();
/**
* Sets the value of the '{@link org.hl7.fhir.SupplyDelivery#getType <em>Type</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Type</em>' containment reference.
* @see #getType()
* @generated
*/
void setType(CodeableConcept value);
/**
* Returns the value of the '<em><b>Supplied Item</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The item that is being delivered or has been supplied.
* <!-- end-model-doc -->
* @return the value of the '<em>Supplied Item</em>' containment reference.
* @see #setSuppliedItem(SupplyDeliverySuppliedItem)
* @see org.hl7.fhir.FhirPackage#getSupplyDelivery_SuppliedItem()
* @model containment="true"
* extendedMetaData="kind='element' name='suppliedItem' namespace='##targetNamespace'"
* @generated
*/
SupplyDeliverySuppliedItem getSuppliedItem();
/**
* Sets the value of the '{@link org.hl7.fhir.SupplyDelivery#getSuppliedItem <em>Supplied Item</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Supplied Item</em>' containment reference.
* @see #getSuppliedItem()
* @generated
*/
void setSuppliedItem(SupplyDeliverySuppliedItem value);
/**
* Returns the value of the '<em><b>Occurrence Date Time</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Occurrence Date Time</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Occurrence Date Time</em>' containment reference.
* @see #setOccurrenceDateTime(DateTime)
* @see org.hl7.fhir.FhirPackage#getSupplyDelivery_OccurrenceDateTime()
* @model containment="true"
* extendedMetaData="kind='element' name='occurrenceDateTime' namespace='##targetNamespace'"
* @generated
*/
DateTime getOccurrenceDateTime();
/**
* Sets the value of the '{@link org.hl7.fhir.SupplyDelivery#getOccurrenceDateTime <em>Occurrence Date Time</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Occurrence Date Time</em>' containment reference.
* @see #getOccurrenceDateTime()
* @generated
*/
void setOccurrenceDateTime(DateTime value);
/**
* Returns the value of the '<em><b>Occurrence Period</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Occurrence Period</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Occurrence Period</em>' containment reference.
* @see #setOccurrencePeriod(Period)
* @see org.hl7.fhir.FhirPackage#getSupplyDelivery_OccurrencePeriod()
* @model containment="true"
* extendedMetaData="kind='element' name='occurrencePeriod' namespace='##targetNamespace'"
* @generated
*/
Period getOccurrencePeriod();
/**
* Sets the value of the '{@link org.hl7.fhir.SupplyDelivery#getOccurrencePeriod <em>Occurrence Period</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Occurrence Period</em>' containment reference.
* @see #getOccurrencePeriod()
* @generated
*/
void setOccurrencePeriod(Period value);
/**
* Returns the value of the '<em><b>Occurrence Timing</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Occurrence Timing</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Occurrence Timing</em>' containment reference.
* @see #setOccurrenceTiming(Timing)
* @see org.hl7.fhir.FhirPackage#getSupplyDelivery_OccurrenceTiming()
* @model containment="true"
* extendedMetaData="kind='element' name='occurrenceTiming' namespace='##targetNamespace'"
* @generated
*/
Timing getOccurrenceTiming();
/**
* Sets the value of the '{@link org.hl7.fhir.SupplyDelivery#getOccurrenceTiming <em>Occurrence Timing</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Occurrence Timing</em>' containment reference.
* @see #getOccurrenceTiming()
* @generated
*/
void setOccurrenceTiming(Timing value);
/**
* Returns the value of the '<em><b>Supplier</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The individual responsible for dispensing the medication, supplier or device.
* <!-- end-model-doc -->
* @return the value of the '<em>Supplier</em>' containment reference.
* @see #setSupplier(Reference)
* @see org.hl7.fhir.FhirPackage#getSupplyDelivery_Supplier()
* @model containment="true"
* extendedMetaData="kind='element' name='supplier' namespace='##targetNamespace'"
* @generated
*/
Reference getSupplier();
/**
* Sets the value of the '{@link org.hl7.fhir.SupplyDelivery#getSupplier <em>Supplier</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Supplier</em>' containment reference.
* @see #getSupplier()
* @generated
*/
void setSupplier(Reference value);
/**
* Returns the value of the '<em><b>Destination</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Identification of the facility/location where the Supply was shipped to, as part of the dispense event.
* <!-- end-model-doc -->
* @return the value of the '<em>Destination</em>' containment reference.
* @see #setDestination(Reference)
* @see org.hl7.fhir.FhirPackage#getSupplyDelivery_Destination()
* @model containment="true"
* extendedMetaData="kind='element' name='destination' namespace='##targetNamespace'"
* @generated
*/
Reference getDestination();
/**
* Sets the value of the '{@link org.hl7.fhir.SupplyDelivery#getDestination <em>Destination</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Destination</em>' containment reference.
* @see #getDestination()
* @generated
*/
void setDestination(Reference value);
/**
* Returns the value of the '<em><b>Receiver</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.Reference}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Identifies the person who picked up the Supply.
* <!-- end-model-doc -->
* @return the value of the '<em>Receiver</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getSupplyDelivery_Receiver()
* @model containment="true"
* extendedMetaData="kind='element' name='receiver' namespace='##targetNamespace'"
* @generated
*/
EList<Reference> getReceiver();
} // SupplyDelivery