MedicationAdministration (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.instance.model.Base
- - org.hl7.fhir.instance.model.BaseResource
  - - org.hl7.fhir.instance.model.Resource
    - - org.hl7.fhir.instance.model.DomainResource
      - org.hl7.fhir.instance.model.MedicationAdministration

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MedicationAdministration.MedicationAdministrationDosageComponent`
`static class`	`MedicationAdministration.MedicationAdministrationStatus`
`static class`	`MedicationAdministration.MedicationAdministrationStatusEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<Reference>`	`device` The device used in administering the medication to the patient.
`protected List<Device>`	`deviceTarget` The actual objects that are the target of the reference (The device used in administering the medication to the patient.
`protected MedicationAdministration.MedicationAdministrationDosageComponent`	`dosage` Describes the medication dosage information details e.g.
`protected Type`	`effectiveTime` 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).
`protected Reference`	`encounter` The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.
`protected Encounter`	`encounterTarget` The actual object that is the target of the reference (The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.)
`protected List<Identifier>`	`identifier` External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource.
`protected Type`	`medication` Identifies the medication that was administered.
`protected StringType`	`note` Extra information about the medication administration that is not conveyed by the other attributes.
`protected Reference`	`patient` The person or animal receiving the medication.
`protected Patient`	`patientTarget` The actual object that is the target of the reference (The person or animal receiving the medication.)
`protected Reference`	`practitioner` The individual who was responsible for giving the medication to the patient.
`protected Resource`	`practitionerTarget` The actual object that is the target of the reference (The individual who was responsible for giving the medication to the patient.)
`protected Reference`	`prescription` The original request, instruction or authority to perform the administration.
`protected MedicationOrder`	`prescriptionTarget` The actual object that is the target of the reference (The original request, instruction or authority to perform the administration.)
`protected List<CodeableConcept>`	`reasonGiven` A code indicating why the medication was given.
`protected List<CodeableConcept>`	`reasonNotGiven` A code indicating why the administration was not performed.
`static String`	`SP_CODE`
`static String`	`SP_DEVICE`
`static String`	`SP_EFFECTIVETIME`
`static String`	`SP_ENCOUNTER`
`static String`	`SP_IDENTIFIER`
`static String`	`SP_MEDICATION`
`static String`	`SP_NOTGIVEN`
`static String`	`SP_PATIENT`
`static String`	`SP_PRACTITIONER`
`static String`	`SP_PRESCRIPTION`
`static String`	`SP_STATUS`
`protected Enumeration<MedicationAdministration.MedicationAdministrationStatus>`	`status` Will generally be set to show that the administration has been completed.
`protected BooleanType`	`wasNotGiven` Set this to true if the record is saying that the medication was NOT administered.

Fields inherited from class org.hl7.fhir.instance.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.instance.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description
`MedicationAdministration()`
`MedicationAdministration(Enumeration<MedicationAdministration.MedicationAdministrationStatus> status, Reference patient, Type effectiveTime, Type medication)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Reference`	`addDevice()`
`MedicationAdministration`	`addDevice(Reference t)`
`Device`	`addDeviceTarget()`
`Identifier`	`addIdentifier()`
`MedicationAdministration`	`addIdentifier(Identifier t)`
`CodeableConcept`	`addReasonGiven()`
`MedicationAdministration`	`addReasonGiven(CodeableConcept t)`
`CodeableConcept`	`addReasonNotGiven()`
`MedicationAdministration`	`addReasonNotGiven(CodeableConcept t)`
`MedicationAdministration`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`List<Reference>`	`getDevice()`
`List<Device>`	`getDeviceTarget()`
`MedicationAdministration.MedicationAdministrationDosageComponent`	`getDosage()`
`Type`	`getEffectiveTime()`
`DateTimeType`	`getEffectiveTimeDateTimeType()`
`Period`	`getEffectiveTimePeriod()`
`Reference`	`getEncounter()`
`Encounter`	`getEncounterTarget()`
`List<Identifier>`	`getIdentifier()`
`Type`	`getMedication()`
`CodeableConcept`	`getMedicationCodeableConcept()`
`Reference`	`getMedicationReference()`
`String`	`getNote()`
`StringType`	`getNoteElement()`
`Reference`	`getPatient()`
`Patient`	`getPatientTarget()`
`Reference`	`getPractitioner()`
`Resource`	`getPractitionerTarget()`
`Reference`	`getPrescription()`
`MedicationOrder`	`getPrescriptionTarget()`
`List<CodeableConcept>`	`getReasonGiven()`
`List<CodeableConcept>`	`getReasonNotGiven()`
`ResourceType`	`getResourceType()`
`MedicationAdministration.MedicationAdministrationStatus`	`getStatus()`
`Enumeration<MedicationAdministration.MedicationAdministrationStatus>`	`getStatusElement()`
`boolean`	`getWasNotGiven()`
`BooleanType`	`getWasNotGivenElement()`
`boolean`	`hasDevice()`
`boolean`	`hasDosage()`
`boolean`	`hasEffectiveTime()`
`boolean`	`hasEffectiveTimeDateTimeType()`
`boolean`	`hasEffectiveTimePeriod()`
`boolean`	`hasEncounter()`
`boolean`	`hasIdentifier()`
`boolean`	`hasMedication()`
`boolean`	`hasMedicationCodeableConcept()`
`boolean`	`hasMedicationReference()`
`boolean`	`hasNote()`
`boolean`	`hasNoteElement()`
`boolean`	`hasPatient()`
`boolean`	`hasPractitioner()`
`boolean`	`hasPrescription()`
`boolean`	`hasReasonGiven()`
`boolean`	`hasReasonNotGiven()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasWasNotGiven()`
`boolean`	`hasWasNotGivenElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`MedicationAdministration`	`setDosage(MedicationAdministration.MedicationAdministrationDosageComponent value)`
`MedicationAdministration`	`setEffectiveTime(Type value)`
`MedicationAdministration`	`setEncounter(Reference value)`
`MedicationAdministration`	`setEncounterTarget(Encounter value)`
`MedicationAdministration`	`setMedication(Type value)`
`MedicationAdministration`	`setNote(String value)`
`MedicationAdministration`	`setNoteElement(StringType value)`
`MedicationAdministration`	`setPatient(Reference value)`
`MedicationAdministration`	`setPatientTarget(Patient value)`
`MedicationAdministration`	`setPractitioner(Reference value)`
`MedicationAdministration`	`setPractitionerTarget(Resource value)`
`MedicationAdministration`	`setPrescription(Reference value)`
`MedicationAdministration`	`setPrescriptionTarget(MedicationOrder value)`
`void`	`setProperty(String name, Base value)`
`MedicationAdministration`	`setStatus(MedicationAdministration.MedicationAdministrationStatus value)`
`MedicationAdministration`	`setStatusElement(Enumeration<MedicationAdministration.MedicationAdministrationStatus> value)`
`MedicationAdministration`	`setWasNotGiven(boolean value)`
`MedicationAdministration`	`setWasNotGivenElement(BooleanType value)`
`protected MedicationAdministration`	`typedCopy()`

Methods inherited from class org.hl7.fhir.instance.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.instance.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, getStructureFhirVersionEnum, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.instance.model.BaseResource
setId

Methods inherited from class org.hl7.fhir.instance.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.
  - status
```
protected Enumeration<MedicationAdministration.MedicationAdministrationStatus> status
```
    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.
  - patient
```
protected Reference patient
```
    The person or animal receiving the medication.
  - patientTarget
```
protected Patient patientTarget
```
    The actual object that is the target of the reference (The person or animal receiving the medication.)
  - practitioner
```
protected Reference practitioner
```
    The individual who was responsible for giving the medication to the patient.
  - practitionerTarget
```
protected Resource practitionerTarget
```
    The actual object that is the target of the reference (The individual who was responsible for giving the medication to the patient.)
  - encounter
```
protected Reference encounter
```
    The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.
  - encounterTarget
```
protected Encounter encounterTarget
```
    The actual object that is the target of the reference (The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.)
  - prescription
```
protected Reference prescription
```
    The original request, instruction or authority to perform the administration.
  - prescriptionTarget
```
protected MedicationOrder prescriptionTarget
```
    The actual object that is the target of the reference (The original request, instruction or authority to perform the administration.)
  - wasNotGiven
```
protected BooleanType wasNotGiven
```
    Set this to true if the record is saying that the medication was NOT administered.
  - reasonNotGiven
```
protected List<CodeableConcept> reasonNotGiven
```
    A code indicating why the administration was not performed.
  - reasonGiven
```
protected List<CodeableConcept> reasonGiven
```
    A code indicating why the medication was given.
  - effectiveTime
```
protected Type effectiveTime
```
    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.
  - medication
```
protected Type medication
```
    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.
  - device
```
protected List<Reference> device
```
    The device used in administering the medication to the patient. For example, a particular infusion pump.
  - deviceTarget
```
protected List<Device> deviceTarget
```
    The actual objects that are the target of the reference (The device used in administering the medication to the patient. For example, a particular infusion pump.)
  - note
```
protected StringType note
```
    Extra information about the medication administration that is not conveyed by the other attributes.
  - dosage
```
protected MedicationAdministration.MedicationAdministrationDosageComponent dosage
```
    Describes the medication dosage information details e.g. dose, rate, site, route, etc.
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - SP_CODE
```
public static final String SP_CODE
```
    See Also:
    
    Constant Field Values
  - SP_PRESCRIPTION
```
public static final String SP_PRESCRIPTION
```
    See Also:
    
    Constant Field Values
  - SP_EFFECTIVETIME
```
public static final String SP_EFFECTIVETIME
```
    See Also:
    
    Constant Field Values
  - SP_PRACTITIONER
```
public static final String SP_PRACTITIONER
```
    See Also:
    
    Constant Field Values
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    See Also:
    
    Constant Field Values
  - SP_MEDICATION
```
public static final String SP_MEDICATION
```
    See Also:
    
    Constant Field Values
  - SP_ENCOUNTER
```
public static final String SP_ENCOUNTER
```
    See Also:
    
    Constant Field Values
  - SP_DEVICE
```
public static final String SP_DEVICE
```
    See Also:
    
    Constant Field Values
  - SP_NOTGIVEN
```
public static final String SP_NOTGIVEN
```
    See Also:
    
    Constant Field Values
  - SP_STATUS
```
public static final String SP_STATUS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MedicationAdministration
```
public MedicationAdministration()
```
  - MedicationAdministration
```
public MedicationAdministration(Enumeration<MedicationAdministration.MedicationAdministrationStatus> status,
                                Reference patient,
                                Type effectiveTime,
                                Type medication)
```
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    identifier (External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.)
  - addIdentifier
```
public MedicationAdministration addIdentifier(Identifier t)
```
  - getStatusElement
```
public Enumeration<MedicationAdministration.MedicationAdministrationStatus> getStatusElement()
```
    Returns:
    
    status (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.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - setStatusElement
```
public MedicationAdministration setStatusElement(Enumeration<MedicationAdministration.MedicationAdministrationStatus> value)
```
    Parameters:
    
    value - status (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.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public MedicationAdministration.MedicationAdministrationStatus getStatus()
```
    Returns:
    
    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.
  - setStatus
```
public MedicationAdministration setStatus(MedicationAdministration.MedicationAdministrationStatus value)
```
    Parameters:
    
    value - 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.
  - getPatient
```
public Reference getPatient()
```
    Returns:
    
    patient (The person or animal receiving the medication.)
  - hasPatient
```
public boolean hasPatient()
```
  - setPatient
```
public MedicationAdministration setPatient(Reference value)
```
    Parameters:
    
    value - patient (The person or animal receiving the medication.)
  - 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. (The person or animal receiving the medication.)
  - setPatientTarget
```
public MedicationAdministration 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. (The person or animal receiving the medication.)
  - getPractitioner
```
public Reference getPractitioner()
```
    Returns:
    
    practitioner (The individual who was responsible for giving the medication to the patient.)
  - hasPractitioner
```
public boolean hasPractitioner()
```
  - setPractitioner
```
public MedicationAdministration setPractitioner(Reference value)
```
    Parameters:
    
    value - practitioner (The individual who was responsible for giving the medication to the patient.)
  - getPractitionerTarget
```
public Resource getPractitionerTarget()
```
    Returns:
    
    practitioner 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 who was responsible for giving the medication to the patient.)
  - setPractitionerTarget
```
public MedicationAdministration setPractitionerTarget(Resource value)
```
    Parameters:
    
    value - practitioner 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 who was responsible for giving the medication to the patient.)
  - getEncounter
```
public Reference getEncounter()
```
    Returns:
    
    encounter (The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.)
  - hasEncounter
```
public boolean hasEncounter()
```
  - setEncounter
```
public MedicationAdministration setEncounter(Reference value)
```
    Parameters:
    
    value - encounter (The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.)
  - getEncounterTarget
```
public Encounter getEncounterTarget()
```
    Returns:
    
    encounter 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 visit, admission or other contact between patient and health care provider the medication administration was performed as part of.)
  - setEncounterTarget
```
public MedicationAdministration setEncounterTarget(Encounter value)
```
    Parameters:
    
    value - encounter 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 visit, admission or other contact between patient and health care provider the medication administration was performed as part of.)
  - getPrescription
```
public Reference getPrescription()
```
    Returns:
    
    prescription (The original request, instruction or authority to perform the administration.)
  - hasPrescription
```
public boolean hasPrescription()
```
  - setPrescription
```
public MedicationAdministration setPrescription(Reference value)
```
    Parameters:
    
    value - prescription (The original request, instruction or authority to perform the administration.)
  - getPrescriptionTarget
```
public MedicationOrder getPrescriptionTarget()
```
    Returns:
    
    prescription 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 original request, instruction or authority to perform the administration.)
  - setPrescriptionTarget
```
public MedicationAdministration setPrescriptionTarget(MedicationOrder value)
```
    Parameters:
    
    value - prescription 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 original request, instruction or authority to perform the administration.)
  - getWasNotGivenElement
```
public BooleanType getWasNotGivenElement()
```
    Returns:
    
    wasNotGiven (Set this to true if the record is saying that the medication was NOT administered.). This is the underlying object with id, value and extensions. The accessor "getWasNotGiven" gives direct access to the value
  - hasWasNotGivenElement
```
public boolean hasWasNotGivenElement()
```
  - hasWasNotGiven
```
public boolean hasWasNotGiven()
```
  - setWasNotGivenElement
```
public MedicationAdministration setWasNotGivenElement(BooleanType value)
```
    Parameters:
    
    value - wasNotGiven (Set this to true if the record is saying that the medication was NOT administered.). This is the underlying object with id, value and extensions. The accessor "getWasNotGiven" gives direct access to the value
  - getWasNotGiven
```
public boolean getWasNotGiven()
```
    Returns:
    
    Set this to true if the record is saying that the medication was NOT administered.
  - setWasNotGiven
```
public MedicationAdministration setWasNotGiven(boolean value)
```
    Parameters:
    
    value - Set this to true if the record is saying that the medication was NOT administered.
  - getReasonNotGiven
```
public List<CodeableConcept> getReasonNotGiven()
```
    Returns:
    
    reasonNotGiven (A code indicating why the administration was not performed.)
  - hasReasonNotGiven
```
public boolean hasReasonNotGiven()
```
  - addReasonNotGiven
```
public CodeableConcept addReasonNotGiven()
```
    Returns:
    
    reasonNotGiven (A code indicating why the administration was not performed.)
  - addReasonNotGiven
```
public MedicationAdministration addReasonNotGiven(CodeableConcept t)
```
  - getReasonGiven
```
public List<CodeableConcept> getReasonGiven()
```
    Returns:
    
    reasonGiven (A code indicating why the medication was given.)
  - hasReasonGiven
```
public boolean hasReasonGiven()
```
  - addReasonGiven
```
public CodeableConcept addReasonGiven()
```
    Returns:
    
    reasonGiven (A code indicating why the medication was given.)
  - addReasonGiven
```
public MedicationAdministration addReasonGiven(CodeableConcept t)
```
  - getEffectiveTime
```
public Type getEffectiveTime()
```
    Returns:
    
    effectiveTime (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.)
  - getEffectiveTimeDateTimeType
```
public DateTimeType getEffectiveTimeDateTimeType()
                                          throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    effectiveTime (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.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasEffectiveTimeDateTimeType
```
public boolean hasEffectiveTimeDateTimeType()
```
  - getEffectiveTimePeriod
```
public Period getEffectiveTimePeriod()
                              throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    effectiveTime (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.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasEffectiveTimePeriod
```
public boolean hasEffectiveTimePeriod()
```
  - hasEffectiveTime
```
public boolean hasEffectiveTime()
```
  - setEffectiveTime
```
public MedicationAdministration setEffectiveTime(Type value)
```
    Parameters:
    
    value - effectiveTime (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.)
  - getMedication
```
public Type getMedication()
```
    Returns:
    
    medication (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.)
  - getMedicationCodeableConcept
```
public CodeableConcept getMedicationCodeableConcept()
                                             throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    medication (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.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasMedicationCodeableConcept
```
public boolean hasMedicationCodeableConcept()
```
  - getMedicationReference
```
public Reference getMedicationReference()
                                 throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    medication (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.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasMedicationReference
```
public boolean hasMedicationReference()
```
  - hasMedication
```
public boolean hasMedication()
```
  - setMedication
```
public MedicationAdministration setMedication(Type value)
```
    Parameters:
    
    value - medication (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.)
  - getDevice
```
public List<Reference> getDevice()
```
    Returns:
    
    device (The device used in administering the medication to the patient. For example, a particular infusion pump.)
  - hasDevice
```
public boolean hasDevice()
```
  - addDevice
```
public Reference addDevice()
```
    Returns:
    
    device (The device used in administering the medication to the patient. For example, a particular infusion pump.)
  - addDevice
```
public MedicationAdministration addDevice(Reference t)
```
  - getDeviceTarget
```
public List<Device> getDeviceTarget()
```
    Returns:
    
    device (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. The device used in administering the medication to the patient. For example, a particular infusion pump.)
  - addDeviceTarget
```
public Device addDeviceTarget()
```
    Returns:
    
    device (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. The device used in administering the medication to the patient. For example, a particular infusion pump.)
  - getNoteElement
```
public StringType getNoteElement()
```
    Returns:
    
    note (Extra information about the medication administration that is not conveyed by the other attributes.). This is the underlying object with id, value and extensions. The accessor "getNote" gives direct access to the value
  - hasNoteElement
```
public boolean hasNoteElement()
```
  - hasNote
```
public boolean hasNote()
```
  - setNoteElement
```
public MedicationAdministration setNoteElement(StringType value)
```
    Parameters:
    
    value - note (Extra information about the medication administration that is not conveyed by the other attributes.). This is the underlying object with id, value and extensions. The accessor "getNote" gives direct access to the value
  - getNote
```
public String getNote()
```
    Returns:
    
    Extra information about the medication administration that is not conveyed by the other attributes.
  - setNote
```
public MedicationAdministration setNote(String value)
```
    Parameters:
    
    value - Extra information about the medication administration that is not conveyed by the other attributes.
  - getDosage
```
public MedicationAdministration.MedicationAdministrationDosageComponent getDosage()
```
    Returns:
    
    dosage (Describes the medication dosage information details e.g. dose, rate, site, route, etc.)
  - hasDosage
```
public boolean hasDosage()
```
  - setDosage
```
public MedicationAdministration setDosage(MedicationAdministration.MedicationAdministrationDosageComponent value)
```
    Parameters:
    
    value - dosage (Describes the medication dosage information details e.g. dose, rate, site, route, etc.)
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - setProperty
```
public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public MedicationAdministration copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected MedicationAdministration typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class MedicationAdministration

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.instance.model.DomainResource

Fields inherited from class org.hl7.fhir.instance.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.instance.model.DomainResource

Methods inherited from class org.hl7.fhir.instance.model.Resource

Methods inherited from class org.hl7.fhir.instance.model.BaseResource

Methods inherited from class org.hl7.fhir.instance.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Field Detail

identifier

status

patient

patientTarget

practitioner

practitionerTarget

encounter

encounterTarget

prescription

prescriptionTarget

wasNotGiven

reasonNotGiven

reasonGiven

effectiveTime

medication

device

deviceTarget

note

dosage

SP_IDENTIFIER

SP_CODE

SP_PRESCRIPTION

SP_EFFECTIVETIME

SP_PRACTITIONER

SP_PATIENT

SP_MEDICATION

SP_ENCOUNTER

SP_DEVICE

SP_NOTGIVEN

SP_STATUS

Constructor Detail

MedicationAdministration

MedicationAdministration

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getPatient

hasPatient

setPatient

getPatientTarget

setPatientTarget

getPractitioner

hasPractitioner

setPractitioner

getPractitionerTarget

setPractitionerTarget

getEncounter

hasEncounter

setEncounter

getEncounterTarget

setEncounterTarget

getPrescription

hasPrescription

setPrescription