MedicationAdministration (HAPI FHIR Structures - DSTU2.1 (2016May) 3.3.0 API)

java.lang.Object
- org.hl7.fhir.dstu2016may.model.Base
- - org.hl7.fhir.dstu2016may.model.BaseResource
  - - org.hl7.fhir.dstu2016may.model.Resource
    - - org.hl7.fhir.dstu2016may.model.DomainResource
      - org.hl7.fhir.dstu2016may.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
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`CODE` Fluent Client search parameter constant for code
`protected List<Reference>`	`device` The device used in administering the medication to the patient.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`DEVICE` Fluent Client search parameter constant for device
`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).
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`EFFECTIVETIME` Fluent Client search parameter constant for effectivetime
`protected Reference`	`encounter` The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ENCOUNTER` Fluent Client search parameter constant for encounter
`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.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_DEVICE` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ENCOUNTER` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_MEDICATION` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PRACTITIONER` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PRESCRIPTION` Constant for fluent queries to be used to add include statements.
`protected Type`	`medication` Identifies the medication that was administered.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`MEDICATION` Fluent Client search parameter constant for medication
`protected List<Annotation>`	`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.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`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.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PRACTITIONER` Fluent Client search parameter constant for practitioner
`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.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PRESCRIPTION` Fluent Client search parameter constant for prescription
`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` Search parameter: code
`static String`	`SP_DEVICE` Search parameter: device
`static String`	`SP_EFFECTIVETIME` Search parameter: effectivetime
`static String`	`SP_ENCOUNTER` Search parameter: encounter
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_MEDICATION` Search parameter: medication
`static String`	`SP_PATIENT` Search parameter: patient
`static String`	`SP_PRACTITIONER` Search parameter: practitioner
`static String`	`SP_PRESCRIPTION` Search parameter: prescription
`static String`	`SP_STATUS` Search parameter: status
`static String`	`SP_WASNOTGIVEN` Search parameter: wasnotgiven
`protected Enumeration<MedicationAdministration.MedicationAdministrationStatus>`	`status` Will generally be set to show that the administration has been completed.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`protected BooleanType`	`wasNotGiven` Set this to true if the record is saying that the medication was NOT administered.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`WASNOTGIVEN` Fluent Client search parameter constant for wasnotgiven

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

Fields inherited from class org.hl7.fhir.dstu2016may.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()` Constructor
`MedicationAdministration(Enumeration<MedicationAdministration.MedicationAdministrationStatus> status, Type medication, Reference patient, Type effectiveTime)` Constructor

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)`
`Annotation`	`addNote()`
`MedicationAdministration`	`addNote(Annotation 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()`
`List<Annotation>`	`getNote()`
`Reference`	`getPatient()`
`Patient`	`getPatientTarget()`
`Reference`	`getPractitioner()`
`Resource`	`getPractitionerTarget()`
`Reference`	`getPrescription()`
`MedicationOrder`	`getPrescriptionTarget()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`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`	`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)`
`Base`	`makeProperty(int hash, String name)`
`MedicationAdministration`	`setDosage(MedicationAdministration.MedicationAdministrationDosageComponent value)`
`MedicationAdministration`	`setEffectiveTime(Type value)`
`MedicationAdministration`	`setEncounter(Reference value)`
`MedicationAdministration`	`setEncounterTarget(Encounter value)`
`MedicationAdministration`	`setMedication(Type 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(int hash, String name, Base 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.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

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

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource
getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, 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.
  - 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.
  - 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.)
  - 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.)
  - 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.
  - 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.)
  - 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.
  - 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 List<Annotation> 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_MEDICATION
```
public static final String SP_MEDICATION
```
    Search parameter: medication
    Description: Return administrations of this medication resource
    Type: reference
    Path: MedicationAdministration.medicationReference
    
    See Also:
    
    Constant Field Values
  - MEDICATION
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MEDICATION
```
    Fluent Client search parameter constant for medication
    Description: Return administrations of this medication resource
    Type: reference
    Path: MedicationAdministration.medicationReference
  - INCLUDE_MEDICATION
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_MEDICATION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:medication".
  - SP_EFFECTIVETIME
```
public static final String SP_EFFECTIVETIME
```
    Search parameter: effectivetime
    Description: Date administration happened (or did not happen)
    Type: date
    Path: MedicationAdministration.effectiveTime[x]
    
    See Also:
    
    Constant Field Values
  - EFFECTIVETIME
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam EFFECTIVETIME
```
    Fluent Client search parameter constant for effectivetime
    Description: Date administration happened (or did not happen)
    Type: date
    Path: MedicationAdministration.effectiveTime[x]
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: patient
    Description: The identity of a patient to list administrations for
    Type: reference
    Path: MedicationAdministration.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: The identity of a patient to list administrations for
    Type: reference
    Path: MedicationAdministration.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 "MedicationAdministration:patient".
  - SP_PRACTITIONER
```
public static final String SP_PRACTITIONER
```
    Search parameter: practitioner
    Description: Who administered substance
    Type: reference
    Path: MedicationAdministration.practitioner
    
    See Also:
    
    Constant Field Values
  - PRACTITIONER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRACTITIONER
```
    Fluent Client search parameter constant for practitioner
    Description: Who administered substance
    Type: reference
    Path: MedicationAdministration.practitioner
  - INCLUDE_PRACTITIONER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PRACTITIONER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:practitioner".
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter: status
    Description: MedicationAdministration event status (for example one of active/paused/completed/nullified)
    Type: token
    Path: MedicationAdministration.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: MedicationAdministration event status (for example one of active/paused/completed/nullified)
    Type: token
    Path: MedicationAdministration.status
  - SP_PRESCRIPTION
```
public static final String SP_PRESCRIPTION
```
    Search parameter: prescription
    Description: The identity of a prescription to list administrations from
    Type: reference
    Path: MedicationAdministration.prescription
    
    See Also:
    
    Constant Field Values
  - PRESCRIPTION
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRESCRIPTION
```
    Fluent Client search parameter constant for prescription
    Description: The identity of a prescription to list administrations from
    Type: reference
    Path: MedicationAdministration.prescription
  - INCLUDE_PRESCRIPTION
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PRESCRIPTION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:prescription".
  - SP_DEVICE
```
public static final String SP_DEVICE
```
    Search parameter: device
    Description: Return administrations with this administration device identity
    Type: reference
    Path: MedicationAdministration.device
    
    See Also:
    
    Constant Field Values
  - DEVICE
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEVICE
```
    Fluent Client search parameter constant for device
    Description: Return administrations with this administration device identity
    Type: reference
    Path: MedicationAdministration.device
  - INCLUDE_DEVICE
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_DEVICE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:device".
  - SP_CODE
```
public static final String SP_CODE
```
    Search parameter: code
    Description: Return administrations of this medication code
    Type: token
    Path: MedicationAdministration.medicationCodeableConcept
    
    See Also:
    
    Constant Field Values
  - CODE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
```
    Fluent Client search parameter constant for code
    Description: Return administrations of this medication code
    Type: token
    Path: MedicationAdministration.medicationCodeableConcept
  - SP_ENCOUNTER
```
public static final String SP_ENCOUNTER
```
    Search parameter: encounter
    Description: Return administrations that share this encounter
    Type: reference
    Path: MedicationAdministration.encounter
    
    See Also:
    
    Constant Field Values
  - ENCOUNTER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
```
    Fluent Client search parameter constant for encounter
    Description: Return administrations that share this encounter
    Type: reference
    Path: MedicationAdministration.encounter
  - INCLUDE_ENCOUNTER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:encounter".
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: Return administrations with this external identifier
    Type: token
    Path: MedicationAdministration.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: Return administrations with this external identifier
    Type: token
    Path: MedicationAdministration.identifier
  - SP_WASNOTGIVEN
```
public static final String SP_WASNOTGIVEN
```
    Search parameter: wasnotgiven
    Description: Administrations that were not made
    Type: token
    Path: MedicationAdministration.wasNotGiven
    
    See Also:
    
    Constant Field Values
  - WASNOTGIVEN
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam WASNOTGIVEN
```
    Fluent Client search parameter constant for wasnotgiven
    Description: Administrations that were not made
    Type: token
    Path: MedicationAdministration.wasNotGiven
- Constructor Detail
  - MedicationAdministration
```
public MedicationAdministration()
```
    Constructor
  - MedicationAdministration
```
public MedicationAdministration(Enumeration<MedicationAdministration.MedicationAdministrationStatus> status,
                                Type medication,
                                Reference patient,
                                Type effectiveTime)
```
    Constructor
- 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.
  - 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.)
  - 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.)
  - 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.)
  - 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.)
  - 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.)
  - 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)
```
  - 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.)
  - getNote
```
public List<Annotation> getNote()
```
    Returns:
    
    note (Extra information about the medication administration that is not conveyed by the other attributes.)
  - hasNote
```
public boolean hasNote()
```
  - addNote
```
public Annotation addNote()
```
    Returns:
    
    note (Extra information about the medication administration that is not conveyed by the other attributes.)
  - addNote
```
public MedicationAdministration addNote(Annotation t)
```
  - 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
  - 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
  - setProperty
```
public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - 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
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty 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.dstu2016may.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu2016may.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.dstu2016may.model.DomainResource

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

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

Methods inherited from class org.hl7.fhir.dstu2016may.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

medication

patient

patientTarget

encounter

encounterTarget

effectiveTime

practitioner

practitionerTarget

prescription

prescriptionTarget

wasNotGiven

reasonNotGiven

reasonGiven

device

deviceTarget

note

dosage

SP_MEDICATION

MEDICATION

INCLUDE_MEDICATION

SP_EFFECTIVETIME

EFFECTIVETIME

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_PRACTITIONER

PRACTITIONER

INCLUDE_PRACTITIONER

SP_STATUS

STATUS

SP_PRESCRIPTION

PRESCRIPTION

INCLUDE_PRESCRIPTION

SP_DEVICE

DEVICE

INCLUDE_DEVICE

SP_CODE

CODE

SP_ENCOUNTER

ENCOUNTER

INCLUDE_ENCOUNTER

SP_IDENTIFIER

IDENTIFIER

SP_WASNOTGIVEN

WASNOTGIVEN

Constructor Detail

MedicationAdministration

MedicationAdministration

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getMedication