MedicationStatement (HAPI FHIR - Core Library 0.7 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseResource
  - - ca.uhn.fhir.model.dstu.resource.MedicationStatement

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class MedicationStatement
extends BaseResource
implements IResource
```
HAPI/FHIR MedicationStatement Resource (Administration of medication to a patient)
Definition: A record of medication being taken by a patient, or that the medication has been given to a patient where the record is the result of a report from the patient or another clinician

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/MedicationStatement

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MedicationStatement.Dosage` Block class for child element: MedicationStatement.dosage (Details of how medication was taken)

Field Summary

Fields
Modifier and Type	Field and Description
`static ReferenceClientParam`	`DEVICE` Fluent Client search parameter constant for device
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_DEVICE` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_MEDICATION` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`MEDICATION` Fluent Client search parameter constant for medication
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static String`	`SP_DEVICE` Search parameter constant for device
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_MEDICATION` Search parameter constant for medication
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_WHEN_GIVEN` Search parameter constant for when-given
`static DateClientParam`	`WHEN_GIVEN` Fluent Client search parameter constant for when-given

Fields inherited from class ca.uhn.fhir.model.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

MedicationStatement()

Constructors
Constructor and Description
`MedicationStatement()`

Method Summary

Methods
Modifier and Type	Method and Description
`ResourceReferenceDt`	`addDevice()` Adds and returns a new value for device (E.g.
`MedicationStatement.Dosage`	`addDosage()` Adds and returns a new value for dosage (Details of how medication was taken)
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (External Identifier)
`MedicationStatement`	`addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Adds a new value for identifier (External Identifier)
`MedicationStatement`	`addIdentifier(String theSystem, String theValue)` Adds a new value for identifier (External Identifier)
`CodeableConceptDt`	`addReasonNotGiven()` Adds and returns a new value for reasonNotGiven (True if asserting medication was not given)
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`List<ResourceReferenceDt>`	`getDevice()` Gets the value(s) for device (E.g.
`List<MedicationStatement.Dosage>`	`getDosage()` Gets the value(s) for dosage (Details of how medication was taken).
`MedicationStatement.Dosage`	`getDosageFirstRep()` Gets the first repetition for dosage (Details of how medication was taken), creating it if it does not already exist.
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (External Identifier).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (External Identifier), creating it if it does not already exist.
`ResourceReferenceDt`	`getMedication()` Gets the value(s) for medication (What medication was taken?).
`ResourceReferenceDt`	`getPatient()` Gets the value(s) for patient (Who was/is taking medication).
`List<CodeableConceptDt>`	`getReasonNotGiven()` Gets the value(s) for reasonNotGiven (True if asserting medication was not given).
`CodeableConceptDt`	`getReasonNotGivenFirstRep()` Gets the first repetition for reasonNotGiven (True if asserting medication was not given), creating it if it does not already exist.
`BooleanDt`	`getWasNotGiven()` Gets the value(s) for wasNotGiven (True if medication is/was not being taken).
`PeriodDt`	`getWhenGiven()` Gets the value(s) for whenGiven (Over what period was medication consumed?).
`boolean`	`isEmpty()`
`MedicationStatement`	`setDevice(List<ResourceReferenceDt> theValue)` Sets the value(s) for device (E.g.
`MedicationStatement`	`setDosage(List<MedicationStatement.Dosage> theValue)` Sets the value(s) for dosage (Details of how medication was taken)
`MedicationStatement`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (External Identifier)
`MedicationStatement`	`setMedication(ResourceReferenceDt theValue)` Sets the value(s) for medication (What medication was taken?)
`MedicationStatement`	`setPatient(ResourceReferenceDt theValue)` Sets the value(s) for patient (Who was/is taking medication)
`MedicationStatement`	`setReasonNotGiven(List<CodeableConceptDt> theValue)` Sets the value(s) for reasonNotGiven (True if asserting medication was not given)
`MedicationStatement`	`setWasNotGiven(boolean theBoolean)` Sets the value for wasNotGiven (True if medication is/was not being taken)
`MedicationStatement`	`setWasNotGiven(BooleanDt theValue)` Sets the value(s) for wasNotGiven (True if medication is/was not being taken)
`MedicationStatement`	`setWhenGiven(PeriodDt theValue)` Sets the value(s) for whenGiven (Over what period was medication consumed?)

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

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

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

- Field Detail
  - SP_DEVICE
```
public static final String SP_DEVICE
```
    Search parameter constant for device
    Description: Return administrations with this administration device identity
    Type: reference
    Path: MedicationStatement.device
    
    See Also:
    Constant Field Values
  - DEVICE
```
public static final ReferenceClientParam DEVICE
```
    Fluent Client search parameter constant for device
    Description: Return administrations with this administration device identity
    Type: reference
    Path: MedicationStatement.device
  - INCLUDE_DEVICE
```
public static final Include INCLUDE_DEVICE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationStatement.device".
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description: Return administrations with this external identity
    Type: token
    Path: MedicationStatement.identifier
    
    See Also:
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: Return administrations with this external identity
    Type: token
    Path: MedicationStatement.identifier
  - SP_MEDICATION
```
public static final String SP_MEDICATION
```
    Search parameter constant for medication
    Description: Code for medicine or text in medicine name
    Type: reference
    Path: MedicationStatement.medication
    
    See Also:
    Constant Field Values
  - MEDICATION
```
public static final ReferenceClientParam MEDICATION
```
    Fluent Client search parameter constant for medication
    Description: Code for medicine or text in medicine name
    Type: reference
    Path: MedicationStatement.medication
  - INCLUDE_MEDICATION
```
public static final Include INCLUDE_MEDICATION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationStatement.medication".
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description: The identity of a patient to list administrations for
    Type: reference
    Path: MedicationStatement.patient
    
    See Also:
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: The identity of a patient to list administrations for
    Type: reference
    Path: MedicationStatement.patient
  - INCLUDE_PATIENT
```
public static final Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationStatement.patient".
  - SP_WHEN_GIVEN
```
public static final String SP_WHEN_GIVEN
```
    Search parameter constant for when-given
    Description: Date of administration
    Type: date
    Path: MedicationStatement.whenGiven
    
    See Also:
    Constant Field Values
  - WHEN_GIVEN
```
public static final DateClientParam WHEN_GIVEN
```
    Fluent Client search parameter constant for when-given
    Description: Date of administration
    Type: date
    Path: MedicationStatement.whenGiven
- Constructor Detail
  - MedicationStatement
```
public MedicationStatement()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (External Identifier). creating it if it does not exist. Will not return null.
    Definition: External identifier - FHIR will generate its own internal IDs (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.
  - setIdentifier
```
public MedicationStatement setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (External Identifier)
    Definition: External identifier - FHIR will generate its own internal IDs (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 IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (External Identifier)
    Definition: External identifier - FHIR will generate its own internal IDs (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.
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (External Identifier), creating it if it does not already exist.
    Definition: External identifier - FHIR will generate its own internal IDs (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 MedicationStatement addIdentifier(IdentifierUseEnum theUse,
                                String theSystem,
                                String theValue,
                                String theLabel)
```
    Adds a new value for identifier (External Identifier)
    Definition: External identifier - FHIR will generate its own internal IDs (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.
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addIdentifier
```
public MedicationStatement addIdentifier(String theSystem,
                                String theValue)
```
    Adds a new value for identifier (External Identifier)
    Definition: External identifier - FHIR will generate its own internal IDs (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.
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getPatient
```
public ResourceReferenceDt getPatient()
```
    Gets the value(s) for patient (Who was/is taking medication). creating it if it does not exist. Will not return null.
    Definition: The person or animal who is /was taking the medication.
  - setPatient
```
public MedicationStatement setPatient(ResourceReferenceDt theValue)
```
    Sets the value(s) for patient (Who was/is taking medication)
    Definition: The person or animal who is /was taking the medication.
  - getWasNotGiven
```
public BooleanDt getWasNotGiven()
```
    Gets the value(s) for wasNotGiven (True if medication is/was not being taken). creating it if it does not exist. Will not return null.
    Definition: Set this to true if the record is saying that the medication was NOT taken.
  - setWasNotGiven
```
public MedicationStatement setWasNotGiven(BooleanDt theValue)
```
    Sets the value(s) for wasNotGiven (True if medication is/was not being taken)
    Definition: Set this to true if the record is saying that the medication was NOT taken.
  - setWasNotGiven
```
public MedicationStatement setWasNotGiven(boolean theBoolean)
```
    Sets the value for wasNotGiven (True if medication is/was not being taken)
    Definition: Set this to true if the record is saying that the medication was NOT taken.
  - getReasonNotGiven
```
public List<CodeableConceptDt> getReasonNotGiven()
```
    Gets the value(s) for reasonNotGiven (True if asserting medication was not given). creating it if it does not exist. Will not return null.
    Definition: A code indicating why the medication was not taken.
  - setReasonNotGiven
```
public MedicationStatement setReasonNotGiven(List<CodeableConceptDt> theValue)
```
    Sets the value(s) for reasonNotGiven (True if asserting medication was not given)
    Definition: A code indicating why the medication was not taken.
  - addReasonNotGiven
```
public CodeableConceptDt addReasonNotGiven()
```
    Adds and returns a new value for reasonNotGiven (True if asserting medication was not given)
    Definition: A code indicating why the medication was not taken.
  - getReasonNotGivenFirstRep
```
public CodeableConceptDt getReasonNotGivenFirstRep()
```
    Gets the first repetition for reasonNotGiven (True if asserting medication was not given), creating it if it does not already exist.
    Definition: A code indicating why the medication was not taken.
  - getWhenGiven
```
public PeriodDt getWhenGiven()
```
    Gets the value(s) for whenGiven (Over what period was medication consumed?). creating it if it does not exist. Will not return null.
    Definition: The interval of time during which it is being asserted that the patient was taking the medication.
  - setWhenGiven
```
public MedicationStatement setWhenGiven(PeriodDt theValue)
```
    Sets the value(s) for whenGiven (Over what period was medication consumed?)
    Definition: The interval of time during which it is being asserted that the patient was taking the medication.
  - getMedication
```
public ResourceReferenceDt getMedication()
```
    Gets the value(s) for medication (What medication was taken?). creating it if it does not exist. Will not return null.
    Definition: Identifies the medication being 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.
  - setMedication
```
public MedicationStatement setMedication(ResourceReferenceDt theValue)
```
    Sets the value(s) for medication (What medication was taken?)
    Definition: Identifies the medication being 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<ResourceReferenceDt> getDevice()
```
    Gets the value(s) for device (E.g. infusion pump). creating it if it does not exist. Will not return null.
    Definition: An identifier or a link to a resource that identifies a device used in administering the medication to the patient.
  - setDevice
```
public MedicationStatement setDevice(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for device (E.g. infusion pump)
    Definition: An identifier or a link to a resource that identifies a device used in administering the medication to the patient.
  - addDevice
```
public ResourceReferenceDt addDevice()
```
    Adds and returns a new value for device (E.g. infusion pump)
    Definition: An identifier or a link to a resource that identifies a device used in administering the medication to the patient.
  - getDosage
```
public List<MedicationStatement.Dosage> getDosage()
```
    Gets the value(s) for dosage (Details of how medication was taken). creating it if it does not exist. Will not return null.
    Definition: Indicates how the medication is/was used by the patient
  - setDosage
```
public MedicationStatement setDosage(List<MedicationStatement.Dosage> theValue)
```
    Sets the value(s) for dosage (Details of how medication was taken)
    Definition: Indicates how the medication is/was used by the patient
  - addDosage
```
public MedicationStatement.Dosage addDosage()
```
    Adds and returns a new value for dosage (Details of how medication was taken)
    Definition: Indicates how the medication is/was used by the patient
  - getDosageFirstRep
```
public MedicationStatement.Dosage getDosageFirstRep()
```
    Gets the first repetition for dosage (Details of how medication was taken), creating it if it does not already exist.
    Definition: Indicates how the medication is/was used by the patient

Class MedicationStatement

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Field Detail

SP_DEVICE

DEVICE

INCLUDE_DEVICE

SP_IDENTIFIER

IDENTIFIER

SP_MEDICATION

MEDICATION

INCLUDE_MEDICATION

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_WHEN_GIVEN

WHEN_GIVEN

Constructor Detail

MedicationStatement

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

getIdentifierFirstRep

addIdentifier

addIdentifier

getPatient

setPatient

getWasNotGiven

setWasNotGiven

setWasNotGiven

getReasonNotGiven

setReasonNotGiven

addReasonNotGiven

getReasonNotGivenFirstRep

getWhenGiven

setWhenGiven

getMedication

setMedication

getDevice

setDevice

addDevice

getDosage

setDosage

addDosage

getDosageFirstRep