Class MedicationAdministration
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.MedicationAdministration
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class MedicationAdministration extends DomainResource
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.Maturity level: FMM2 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MedicationAdministration.Builder
static class
MedicationAdministration.Dosage
Describes the medication dosage information details e.g.static class
MedicationAdministration.Performer
Indicates who or what performed the medication administration and how they were involved.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static MedicationAdministration.Builder
builder()
boolean
equals(java.lang.Object obj)
CodeableConcept
getCategory()
Indicates where the medication is expected to be consumed or administered.Reference
getContext()
The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.java.util.List<Reference>
getDevice()
The device used in administering the medication to the patient.MedicationAdministration.Dosage
getDosage()
Describes the medication dosage information details e.g.Element
getEffective()
A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true).java.util.List<Reference>
getEventHistory()
A summary of the events of interest that have occurred, such as when the administration was verified.java.util.List<Identifier>
getIdentifier()
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.java.util.List<Uri>
getInstantiates()
A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.Element
getMedication()
Identifies the medication that was administered.java.util.List<Annotation>
getNote()
Extra information about the medication administration that is not conveyed by the other attributes.java.util.List<Reference>
getPartOf()
A larger event of which this particular event is a component or step.java.util.List<MedicationAdministration.Performer>
getPerformer()
Indicates who or what performed the medication administration and how they were involved.java.util.List<CodeableConcept>
getReasonCode()
A code indicating why the medication was given.java.util.List<Reference>
getReasonReference()
Condition or observation that supports why the medication was administered.Reference
getRequest()
The original request, instruction or authority to perform the administration.MedicationAdministrationStatus
getStatus()
Will generally be set to show that the administration has been completed.java.util.List<CodeableConcept>
getStatusReason()
A code indicating why the administration was not performed.Reference
getSubject()
The person or animal or group receiving the medication.java.util.List<Reference>
getSupportingInformation()
Additional information (for example, patient height and weight) that supports the administration of the medication.boolean
hasChildren()
int
hashCode()
MedicationAdministration.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getInstantiates
public java.util.List<Uri> getInstantiates()
A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.- Returns:
- An unmodifiable list containing immutable objects of type
Uri
that may be empty.
-
getPartOf
public java.util.List<Reference> getPartOf()
A larger event of which this particular event is a component or step.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getStatus
public MedicationAdministrationStatus getStatus()
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.- Returns:
- An immutable object of type
MedicationAdministrationStatus
that is non-null.
-
getStatusReason
public java.util.List<CodeableConcept> getStatusReason()
A code indicating why the administration was not performed.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getCategory
public CodeableConcept getCategory()
Indicates where the medication is expected to be consumed or administered.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getMedication
public Element getMedication()
Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.- Returns:
- An immutable object of type
CodeableConcept
orReference
that is non-null.
-
getSubject
public Reference getSubject()
The person or animal or group receiving the medication.- Returns:
- An immutable object of type
Reference
that is non-null.
-
getContext
public Reference getContext()
The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.- Returns:
- An immutable object of type
Reference
that may be null.
-
getSupportingInformation
public java.util.List<Reference> getSupportingInformation()
Additional information (for example, patient height and weight) that supports the administration of the medication.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getEffective
public Element getEffective()
A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
-
getPerformer
public java.util.List<MedicationAdministration.Performer> getPerformer()
Indicates who or what performed the medication administration and how they were involved.- Returns:
- An unmodifiable list containing immutable objects of type
MedicationAdministration.Performer
that may be empty.
-
getReasonCode
public java.util.List<CodeableConcept> getReasonCode()
A code indicating why the medication was given.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getReasonReference
public java.util.List<Reference> getReasonReference()
Condition or observation that supports why the medication was administered.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getRequest
public Reference getRequest()
The original request, instruction or authority to perform the administration.- Returns:
- An immutable object of type
Reference
that may be null.
-
getDevice
public java.util.List<Reference> getDevice()
The device used in administering the medication to the patient. For example, a particular infusion pump.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getNote
public java.util.List<Annotation> getNote()
Extra information about the medication administration that is not conveyed by the other attributes.- Returns:
- An unmodifiable list containing immutable objects of type
Annotation
that may be empty.
-
getDosage
public MedicationAdministration.Dosage getDosage()
Describes the medication dosage information details e.g. dose, rate, site, route, etc.- Returns:
- An immutable object of type
MedicationAdministration.Dosage
that may be null.
-
getEventHistory
public java.util.List<Reference> getEventHistory()
A summary of the events of interest that have occurred, such as when the administration was verified.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public MedicationAdministration.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static MedicationAdministration.Builder builder()
-
-