Medication (PhenoTips - Extra fields for patient data - Medication

java.lang.Object
- org.phenotips.data.Medication

```
@Unstable
public final class Medication
extends Object
```
Information about the medication taken by a patient.

Since:

1.2M5

Version:

$Id: 65b2b8e451ae03b50d440f17b9eb5d716457699c $

Field Summary

Fields
Modifier and Type	Field and Description
`static org.xwiki.model.reference.EntityReference`	`CLASS_REFERENCE` The XClass used for storing medication data.
`static String`	`DOSE`
`static String`	`DURATION`
`static String`	`EFFECT`
`static String`	`FREQUENCY`
`static String`	`GENERIC_NAME`
`static String`	`NAME`
`static String`	`NOTES`

Constructor Summary

Constructors
Constructor and Description
`Medication(net.sf.json.JSONObject json)` Constructor parsing back a JSON, in the same format as `toJSON()` produces.
`Medication(String name, String genericName, String dose, String frequency, org.joda.time.Period duration, String effect, String notes)` Basic constructor receiving all the required information.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getDose()` The dose administered.
`org.joda.time.Period`	`getDuration()` The amount of time that this medicine has been given.
`MedicationEffect`	`getEffect()` The effect observed for this medicine.
`String`	`getFrequency()` The frequency of the doses.
`String`	`getGenericName()` The generic name of the main ingredient.
`String`	`getName()` The brand name of the medicine.
`String`	`getNotes()` Custom notes about the medication.
`net.sf.json.JSONObject`	`toJSON()` Serialize as JSON, in the following format.

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

- Field Detail
  - CLASS_REFERENCE
```
public static final org.xwiki.model.reference.EntityReference CLASS_REFERENCE
```
    The XClass used for storing medication data.
  - NAME
```
public static final String NAME
```
    See Also:
    getName(), Constant Field Values
  - GENERIC_NAME
```
public static final String GENERIC_NAME
```
    See Also:
    getGenericName(), Constant Field Values
  - DOSE
```
public static final String DOSE
```
    See Also:
    getDose(), Constant Field Values
  - FREQUENCY
```
public static final String FREQUENCY
```
    See Also:
    getFrequency(), Constant Field Values
  - DURATION
```
public static final String DURATION
```
    See Also:
    getDuration(), Constant Field Values
  - EFFECT
```
public static final String EFFECT
```
    See Also:
    getEffect(), Constant Field Values
  - NOTES
```
public static final String NOTES
```
    See Also:
    getNotes(), Constant Field Values
- Constructor Detail
  - Medication
```
public Medication(String name,
          String genericName,
          String dose,
          String frequency,
          org.joda.time.Period duration,
          String effect,
          String notes)
```
    Basic constructor receiving all the required information.
    
    Parameters:
    name - see getName(), may be null
    genericName - see getGenericName(), may be null
    dose - see getDose(), may be null
    frequency - see getFrequency(), may be null
    duration - see getDuration(), may be null
    effect - see getEffect(), may be null
    notes - see getNotes(), may be null
  - Medication
```
public Medication(net.sf.json.JSONObject json)
```
    Constructor parsing back a JSON, in the same format as toJSON() produces.
    
    Parameters:
    json - a JSON object in the format produced by toJSON(); must not be null
    
    Throws:
    
    IllegalArgumentException - if json is null
- Method Detail
  - toJSON
```
public net.sf.json.JSONObject toJSON()
```
    Serialize as JSON, in the following format.
```
 {
   "name": "Nurofen",
   "genericName: "ibuprofen",
   "dose": "200mg",
   "frequency": "8h",
   "duration": "2Y6M",
   "effect": "slightImprovement",
   "notes": "Makes the patient's headaches a lot more bearable"
 }
 
```
    Returns:
    a JSON object with all the specified fields; any missing/empty field is not set at all in the output
  - getName
```
public String getName()
```
    The brand name of the medicine.
    
    Returns:
    a string, may be null or empty
  - getGenericName
```
public String getGenericName()
```
    The generic name of the main ingredient.
    
    Returns:
    a string, may be null or empty
  - getDose
```
public String getDose()
```
    The dose administered.
    
    Returns:
    a string, may be null or empty
  - getFrequency
```
public String getFrequency()
```
    The frequency of the doses.
    
    Returns:
    a string, may be null or empty
  - getDuration
```
public org.joda.time.Period getDuration()
```
    The amount of time that this medicine has been given.
    
    Returns:
    a period, may be null
  - getEffect
```
public MedicationEffect getEffect()
```
    The effect observed for this medicine.
    
    Returns:
    an enum instance, may be null
  - getNotes
```
public String getNotes()
```
    Custom notes about the medication.
    
    Returns:
    a string, may be null or empty

Class Medication

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_REFERENCE

NAME

GENERIC_NAME

DOSE

FREQUENCY

DURATION

EFFECT

NOTES

Constructor Detail

Medication

Medication

Method Detail

toJSON

getName

getGenericName

getDose

getFrequency

getDuration

getEffect

getNotes