blob: e9d3dec1120e6baadfbcc87831fcff510a373d58 [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>Medication Administration</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.
* 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.MedicationAdministration#getIdentifier <em>Identifier</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getInstantiates <em>Instantiates</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getPartOf <em>Part Of</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getStatus <em>Status</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getStatusReason <em>Status Reason</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getCategory <em>Category</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getMedicationCodeableConcept <em>Medication Codeable Concept</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getMedicationReference <em>Medication Reference</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getSubject <em>Subject</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getContext <em>Context</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getSupportingInformation <em>Supporting Information</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getEffectiveDateTime <em>Effective Date Time</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getEffectivePeriod <em>Effective Period</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getPerformer <em>Performer</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getReasonCode <em>Reason Code</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getReasonReference <em>Reason Reference</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getRequest <em>Request</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getDevice <em>Device</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getNote <em>Note</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getDosage <em>Dosage</em>}</li>
* <li>{@link org.hl7.fhir.MedicationAdministration#getEventHistory <em>Event History</em>}</li>
* </ul>
*
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration()
* @model extendedMetaData="name='MedicationAdministration' kind='elementOnly'"
* @generated
*/
public interface MedicationAdministration 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 -->
* Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
* <!-- end-model-doc -->
* @return the value of the '<em>Identifier</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_Identifier()
* @model containment="true"
* extendedMetaData="kind='element' name='identifier' namespace='##targetNamespace'"
* @generated
*/
EList<Identifier> getIdentifier();
/**
* Returns the value of the '<em><b>Instantiates</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.Uri}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.
* <!-- end-model-doc -->
* @return the value of the '<em>Instantiates</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_Instantiates()
* @model containment="true"
* extendedMetaData="kind='element' name='instantiates' namespace='##targetNamespace'"
* @generated
*/
EList<Uri> getInstantiates();
/**
* 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#getMedicationAdministration_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 -->
* Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
* <!-- end-model-doc -->
* @return the value of the '<em>Status</em>' containment reference.
* @see #setStatus(Code)
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_Status()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='status' namespace='##targetNamespace'"
* @generated
*/
Code getStatus();
/**
* Sets the value of the '{@link org.hl7.fhir.MedicationAdministration#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(Code value);
/**
* Returns the value of the '<em><b>Status Reason</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.CodeableConcept}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A code indicating why the administration was not performed.
* <!-- end-model-doc -->
* @return the value of the '<em>Status Reason</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_StatusReason()
* @model containment="true"
* extendedMetaData="kind='element' name='statusReason' namespace='##targetNamespace'"
* @generated
*/
EList<CodeableConcept> getStatusReason();
/**
* Returns the value of the '<em><b>Category</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Indicates where the medication is expected to be consumed or administered.
* <!-- end-model-doc -->
* @return the value of the '<em>Category</em>' containment reference.
* @see #setCategory(CodeableConcept)
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_Category()
* @model containment="true"
* extendedMetaData="kind='element' name='category' namespace='##targetNamespace'"
* @generated
*/
CodeableConcept getCategory();
/**
* Sets the value of the '{@link org.hl7.fhir.MedicationAdministration#getCategory <em>Category</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Category</em>' containment reference.
* @see #getCategory()
* @generated
*/
void setCategory(CodeableConcept value);
/**
* Returns the value of the '<em><b>Medication Codeable Concept</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Medication Codeable Concept</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>Medication Codeable Concept</em>' containment reference.
* @see #setMedicationCodeableConcept(CodeableConcept)
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_MedicationCodeableConcept()
* @model containment="true"
* extendedMetaData="kind='element' name='medicationCodeableConcept' namespace='##targetNamespace'"
* @generated
*/
CodeableConcept getMedicationCodeableConcept();
/**
* Sets the value of the '{@link org.hl7.fhir.MedicationAdministration#getMedicationCodeableConcept <em>Medication Codeable Concept</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Medication Codeable Concept</em>' containment reference.
* @see #getMedicationCodeableConcept()
* @generated
*/
void setMedicationCodeableConcept(CodeableConcept value);
/**
* Returns the value of the '<em><b>Medication Reference</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Medication Reference</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>Medication Reference</em>' containment reference.
* @see #setMedicationReference(Reference)
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_MedicationReference()
* @model containment="true"
* extendedMetaData="kind='element' name='medicationReference' namespace='##targetNamespace'"
* @generated
*/
Reference getMedicationReference();
/**
* Sets the value of the '{@link org.hl7.fhir.MedicationAdministration#getMedicationReference <em>Medication Reference</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Medication Reference</em>' containment reference.
* @see #getMedicationReference()
* @generated
*/
void setMedicationReference(Reference value);
/**
* Returns the value of the '<em><b>Subject</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The person or animal or group receiving the medication.
* <!-- end-model-doc -->
* @return the value of the '<em>Subject</em>' containment reference.
* @see #setSubject(Reference)
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_Subject()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='subject' namespace='##targetNamespace'"
* @generated
*/
Reference getSubject();
/**
* Sets the value of the '{@link org.hl7.fhir.MedicationAdministration#getSubject <em>Subject</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Subject</em>' containment reference.
* @see #getSubject()
* @generated
*/
void setSubject(Reference value);
/**
* Returns the value of the '<em><b>Context</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.
* <!-- end-model-doc -->
* @return the value of the '<em>Context</em>' containment reference.
* @see #setContext(Reference)
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_Context()
* @model containment="true"
* extendedMetaData="kind='element' name='context' namespace='##targetNamespace'"
* @generated
*/
Reference getContext();
/**
* Sets the value of the '{@link org.hl7.fhir.MedicationAdministration#getContext <em>Context</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Context</em>' containment reference.
* @see #getContext()
* @generated
*/
void setContext(Reference value);
/**
* Returns the value of the '<em><b>Supporting Information</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 -->
* Additional information (for example, patient height and weight) that supports the administration of the medication.
* <!-- end-model-doc -->
* @return the value of the '<em>Supporting Information</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_SupportingInformation()
* @model containment="true"
* extendedMetaData="kind='element' name='supportingInformation' namespace='##targetNamespace'"
* @generated
*/
EList<Reference> getSupportingInformation();
/**
* Returns the value of the '<em><b>Effective Date Time</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Effective 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>Effective Date Time</em>' containment reference.
* @see #setEffectiveDateTime(DateTime)
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_EffectiveDateTime()
* @model containment="true"
* extendedMetaData="kind='element' name='effectiveDateTime' namespace='##targetNamespace'"
* @generated
*/
DateTime getEffectiveDateTime();
/**
* Sets the value of the '{@link org.hl7.fhir.MedicationAdministration#getEffectiveDateTime <em>Effective Date Time</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Effective Date Time</em>' containment reference.
* @see #getEffectiveDateTime()
* @generated
*/
void setEffectiveDateTime(DateTime value);
/**
* Returns the value of the '<em><b>Effective Period</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Effective 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>Effective Period</em>' containment reference.
* @see #setEffectivePeriod(Period)
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_EffectivePeriod()
* @model containment="true"
* extendedMetaData="kind='element' name='effectivePeriod' namespace='##targetNamespace'"
* @generated
*/
Period getEffectivePeriod();
/**
* Sets the value of the '{@link org.hl7.fhir.MedicationAdministration#getEffectivePeriod <em>Effective Period</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Effective Period</em>' containment reference.
* @see #getEffectivePeriod()
* @generated
*/
void setEffectivePeriod(Period value);
/**
* Returns the value of the '<em><b>Performer</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.MedicationAdministrationPerformer}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Indicates who or what performed the medication administration and how they were involved.
* <!-- end-model-doc -->
* @return the value of the '<em>Performer</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_Performer()
* @model containment="true"
* extendedMetaData="kind='element' name='performer' namespace='##targetNamespace'"
* @generated
*/
EList<MedicationAdministrationPerformer> getPerformer();
/**
* Returns the value of the '<em><b>Reason Code</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.CodeableConcept}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A code indicating why the medication was given.
* <!-- end-model-doc -->
* @return the value of the '<em>Reason Code</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_ReasonCode()
* @model containment="true"
* extendedMetaData="kind='element' name='reasonCode' namespace='##targetNamespace'"
* @generated
*/
EList<CodeableConcept> getReasonCode();
/**
* Returns the value of the '<em><b>Reason Reference</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 -->
* Condition or observation that supports why the medication was administered.
* <!-- end-model-doc -->
* @return the value of the '<em>Reason Reference</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_ReasonReference()
* @model containment="true"
* extendedMetaData="kind='element' name='reasonReference' namespace='##targetNamespace'"
* @generated
*/
EList<Reference> getReasonReference();
/**
* Returns the value of the '<em><b>Request</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The original request, instruction or authority to perform the administration.
* <!-- end-model-doc -->
* @return the value of the '<em>Request</em>' containment reference.
* @see #setRequest(Reference)
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_Request()
* @model containment="true"
* extendedMetaData="kind='element' name='request' namespace='##targetNamespace'"
* @generated
*/
Reference getRequest();
/**
* Sets the value of the '{@link org.hl7.fhir.MedicationAdministration#getRequest <em>Request</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Request</em>' containment reference.
* @see #getRequest()
* @generated
*/
void setRequest(Reference value);
/**
* Returns the value of the '<em><b>Device</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 -->
* The device used in administering the medication to the patient. For example, a particular infusion pump.
* <!-- end-model-doc -->
* @return the value of the '<em>Device</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_Device()
* @model containment="true"
* extendedMetaData="kind='element' name='device' namespace='##targetNamespace'"
* @generated
*/
EList<Reference> getDevice();
/**
* Returns the value of the '<em><b>Note</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.Annotation}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Extra information about the medication administration that is not conveyed by the other attributes.
* <!-- end-model-doc -->
* @return the value of the '<em>Note</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_Note()
* @model containment="true"
* extendedMetaData="kind='element' name='note' namespace='##targetNamespace'"
* @generated
*/
EList<Annotation> getNote();
/**
* Returns the value of the '<em><b>Dosage</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Describes the medication dosage information details e.g. dose, rate, site, route, etc.
* <!-- end-model-doc -->
* @return the value of the '<em>Dosage</em>' containment reference.
* @see #setDosage(MedicationAdministrationDosage)
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_Dosage()
* @model containment="true"
* extendedMetaData="kind='element' name='dosage' namespace='##targetNamespace'"
* @generated
*/
MedicationAdministrationDosage getDosage();
/**
* Sets the value of the '{@link org.hl7.fhir.MedicationAdministration#getDosage <em>Dosage</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Dosage</em>' containment reference.
* @see #getDosage()
* @generated
*/
void setDosage(MedicationAdministrationDosage value);
/**
* Returns the value of the '<em><b>Event History</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 summary of the events of interest that have occurred, such as when the administration was verified.
* <!-- end-model-doc -->
* @return the value of the '<em>Event History</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getMedicationAdministration_EventHistory()
* @model containment="true"
* extendedMetaData="kind='element' name='eventHistory' namespace='##targetNamespace'"
* @generated
*/
EList<Reference> getEventHistory();
} // MedicationAdministration