public class MedicationAdministration extends BaseResource implements IResource
Definition: 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
Requirements:
Profile Definition: http://hl7.org/fhir/profiles/MedicationAdministration
| Modifier and Type | Class and Description |
|---|---|
static class |
MedicationAdministration.Dosage
Block class for child element: MedicationAdministration.dosage ()
|
| Modifier and Type | Field and Description |
|---|---|
static TokenClientParam |
CODE
Fluent Client search parameter constant for code
|
static ReferenceClientParam |
DEVICE
Fluent Client search parameter constant for device
|
static DateClientParam |
EFFECTIVETIME
Fluent Client search parameter constant for effectivetime
|
static ReferenceClientParam |
ENCOUNTER
Fluent Client search parameter constant for encounter
|
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_ENCOUNTER
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 Include |
INCLUDE_PRACTITIONER
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_PRESCRIPTION
Constant for fluent queries to be used to add include statements.
|
static ReferenceClientParam |
MEDICATION
Fluent Client search parameter constant for medication
|
static TokenClientParam |
NOTGIVEN
Fluent Client search parameter constant for notgiven
|
static ReferenceClientParam |
PATIENT
Fluent Client search parameter constant for patient
|
static ReferenceClientParam |
PRACTITIONER
Fluent Client search parameter constant for practitioner
|
static ReferenceClientParam |
PRESCRIPTION
Fluent Client search parameter constant for prescription
|
static String |
SP_CODE
Search parameter constant for code
|
static String |
SP_DEVICE
Search parameter constant for device
|
static String |
SP_EFFECTIVETIME
Search parameter constant for effectivetime
|
static String |
SP_ENCOUNTER
Search parameter constant for encounter
|
static String |
SP_IDENTIFIER
Search parameter constant for identifier
|
static String |
SP_MEDICATION
Search parameter constant for medication
|
static String |
SP_NOTGIVEN
Search parameter constant for notgiven
|
static String |
SP_PATIENT
Search parameter constant for patient
|
static String |
SP_PRACTITIONER
Search parameter constant for practitioner
|
static String |
SP_PRESCRIPTION
Search parameter constant for prescription
|
static String |
SP_STATUS
Search parameter constant for status
|
static TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
MedicationAdministration() |
| Modifier and Type | Method and Description |
|---|---|
ResourceReferenceDt |
addDevice()
Adds and returns a new value for device ()
|
IdentifierDt |
addIdentifier()
Adds and returns a new value for identifier (id)
|
MedicationAdministration |
addIdentifier(IdentifierDt theValue)
Adds a given new value for identifier (id)
|
CodeableConceptDt |
addReasonGiven()
Adds and returns a new value for reasonGiven ()
|
MedicationAdministration |
addReasonGiven(CodeableConceptDt theValue)
Adds a given new value for reasonGiven ()
|
CodeableConceptDt |
addReasonNotGiven()
Adds and returns a new value for reasonNotGiven ()
|
MedicationAdministration |
addReasonNotGiven(CodeableConceptDt theValue)
Adds a given new value for reasonNotGiven ()
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
List<ResourceReferenceDt> |
getDevice()
Gets the value(s) for device ().
|
MedicationAdministration.Dosage |
getDosage()
Gets the value(s) for dosage ().
|
IDatatype |
getEffectiveTime()
Gets the value(s) for effectiveTime[x] (when.done).
|
ResourceReferenceDt |
getEncounter()
Gets the value(s) for encounter (context).
|
List<IdentifierDt> |
getIdentifier()
Gets the value(s) for identifier (id).
|
IdentifierDt |
getIdentifierFirstRep()
Gets the first repetition for identifier (id),
creating it if it does not already exist.
|
IDatatype |
getMedication()
Gets the value(s) for medication[x] ().
|
String |
getNote()
Gets the value(s) for note ().
|
StringDt |
getNoteElement()
Gets the value(s) for note ().
|
ResourceReferenceDt |
getPatient()
Gets the value(s) for patient (who.focus).
|
ResourceReferenceDt |
getPractitioner()
Gets the value(s) for practitioner (who.actor).
|
ResourceReferenceDt |
getPrescription()
Gets the value(s) for prescription ().
|
List<CodeableConceptDt> |
getReasonGiven()
Gets the value(s) for reasonGiven ().
|
CodeableConceptDt |
getReasonGivenFirstRep()
Gets the first repetition for reasonGiven (),
creating it if it does not already exist.
|
List<CodeableConceptDt> |
getReasonNotGiven()
Gets the value(s) for reasonNotGiven ().
|
CodeableConceptDt |
getReasonNotGivenFirstRep()
Gets the first repetition for reasonNotGiven (),
creating it if it does not already exist.
|
String |
getResourceName() |
String |
getStatus()
Gets the value(s) for status (status).
|
BoundCodeDt<MedicationAdministrationStatusEnum> |
getStatusElement()
Gets the value(s) for status (status).
|
FhirVersionEnum |
getStructureFhirVersionEnum() |
Boolean |
getWasNotGiven()
Gets the value(s) for wasNotGiven ().
|
BooleanDt |
getWasNotGivenElement()
Gets the value(s) for wasNotGiven ().
|
boolean |
isEmpty() |
MedicationAdministration |
setDevice(List<ResourceReferenceDt> theValue)
Sets the value(s) for device ()
|
MedicationAdministration |
setDosage(MedicationAdministration.Dosage theValue)
Sets the value(s) for dosage ()
|
MedicationAdministration |
setEffectiveTime(IDatatype theValue)
Sets the value(s) for effectiveTime[x] (when.done)
|
MedicationAdministration |
setEncounter(ResourceReferenceDt theValue)
Sets the value(s) for encounter (context)
|
MedicationAdministration |
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier (id)
|
MedicationAdministration |
setMedication(IDatatype theValue)
Sets the value(s) for medication[x] ()
|
MedicationAdministration |
setNote(String theString)
Sets the value for note ()
|
MedicationAdministration |
setNote(StringDt theValue)
Sets the value(s) for note ()
|
MedicationAdministration |
setPatient(ResourceReferenceDt theValue)
Sets the value(s) for patient (who.focus)
|
MedicationAdministration |
setPractitioner(ResourceReferenceDt theValue)
Sets the value(s) for practitioner (who.actor)
|
MedicationAdministration |
setPrescription(ResourceReferenceDt theValue)
Sets the value(s) for prescription ()
|
MedicationAdministration |
setReasonGiven(List<CodeableConceptDt> theValue)
Sets the value(s) for reasonGiven ()
|
MedicationAdministration |
setReasonNotGiven(List<CodeableConceptDt> theValue)
Sets the value(s) for reasonNotGiven ()
|
MedicationAdministration |
setStatus(BoundCodeDt<MedicationAdministrationStatusEnum> theValue)
Sets the value(s) for status (status)
|
MedicationAdministration |
setStatus(MedicationAdministrationStatusEnum theValue)
Sets the value(s) for status (status)
|
MedicationAdministration |
setWasNotGiven(boolean theBoolean)
Sets the value for wasNotGiven ()
|
MedicationAdministration |
setWasNotGiven(BooleanDt theValue)
Sets the value(s) for wasNotGiven ()
|
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatagetIdElement, setId, setIdpublic static final String SP_DEVICE
Description: Return administrations with this administration device identity
Type: reference
Path: MedicationAdministration.device
public static final ReferenceClientParam DEVICE
Description: Return administrations with this administration device identity
Type: reference
Path: MedicationAdministration.device
public static final String SP_ENCOUNTER
Description: Return administrations that share this encounter
Type: reference
Path: MedicationAdministration.encounter
public static final ReferenceClientParam ENCOUNTER
Description: Return administrations that share this encounter
Type: reference
Path: MedicationAdministration.encounter
public static final String SP_IDENTIFIER
Description: Return administrations with this external identifier
Type: token
Path: MedicationAdministration.identifier
public static final TokenClientParam IDENTIFIER
Description: Return administrations with this external identifier
Type: token
Path: MedicationAdministration.identifier
public static final String SP_MEDICATION
Description: Return administrations of this medication resource
Type: reference
Path: MedicationAdministration.medicationReference
public static final ReferenceClientParam MEDICATION
Description: Return administrations of this medication resource
Type: reference
Path: MedicationAdministration.medicationReference
public static final String SP_CODE
Description: Return administrations of this medication code
Type: token
Path: MedicationAdministration.medicationCodeableConcept
public static final TokenClientParam CODE
Description: Return administrations of this medication code
Type: token
Path: MedicationAdministration.medicationCodeableConcept
public static final String SP_NOTGIVEN
Description: Administrations that were not made
Type: token
Path: MedicationAdministration.wasNotGiven
public static final TokenClientParam NOTGIVEN
Description: Administrations that were not made
Type: token
Path: MedicationAdministration.wasNotGiven
public static final String SP_PATIENT
Description: The identity of a patient to list administrations for
Type: reference
Path: MedicationAdministration.patient
public static final ReferenceClientParam PATIENT
Description: The identity of a patient to list administrations for
Type: reference
Path: MedicationAdministration.patient
public static final String SP_PRESCRIPTION
Description: The identity of a prescription to list administrations from
Type: reference
Path: MedicationAdministration.prescription
public static final ReferenceClientParam PRESCRIPTION
Description: The identity of a prescription to list administrations from
Type: reference
Path: MedicationAdministration.prescription
public static final String SP_STATUS
Description: MedicationAdministration event status (for example one of active/paused/completed/nullified)
Type: token
Path: MedicationAdministration.status
public static final TokenClientParam STATUS
Description: MedicationAdministration event status (for example one of active/paused/completed/nullified)
Type: token
Path: MedicationAdministration.status
public static final String SP_EFFECTIVETIME
Description: Date administration happened (or did not happen)
Type: date
Path: MedicationAdministration.effectiveTime[x]
public static final DateClientParam EFFECTIVETIME
Description: Date administration happened (or did not happen)
Type: date
Path: MedicationAdministration.effectiveTime[x]
public static final String SP_PRACTITIONER
Description:
Type: reference
Path: MedicationAdministration.practitioner
public static final ReferenceClientParam PRACTITIONER
Description:
Type: reference
Path: MedicationAdministration.practitioner
public static final Include INCLUDE_DEVICE
public static final Include INCLUDE_ENCOUNTER
public static final Include INCLUDE_MEDICATION
public static final Include INCLUDE_PATIENT
public static final Include INCLUDE_PRACTITIONER
public static final Include INCLUDE_PRESCRIPTION
public MedicationAdministration()
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ICompositeElementpublic List<IdentifierDt> getIdentifier()
null.
Definition: 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.
public MedicationAdministration setIdentifier(List<IdentifierDt> theValue)
Definition: 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.
public IdentifierDt addIdentifier()
Definition: 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.
public MedicationAdministration addIdentifier(IdentifierDt theValue)
Definition: 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.
theValue - The identifier to add (must not be null)public IdentifierDt getIdentifierFirstRep()
Definition: 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.
public BoundCodeDt<MedicationAdministrationStatusEnum> getStatusElement()
null.
Definition: 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.
public String getStatus()
null.
Definition: 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.
public MedicationAdministration setStatus(BoundCodeDt<MedicationAdministrationStatusEnum> theValue)
Definition: 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.
public MedicationAdministration setStatus(MedicationAdministrationStatusEnum theValue)
Definition: 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.
public ResourceReferenceDt getPatient()
null.
Definition: The person or animal receiving the medication.
public MedicationAdministration setPatient(ResourceReferenceDt theValue)
Definition: The person or animal receiving the medication.
public ResourceReferenceDt getPractitioner()
null.
Definition: The individual who was responsible for giving the medication to the patient.
public MedicationAdministration setPractitioner(ResourceReferenceDt theValue)
Definition: The individual who was responsible for giving the medication to the patient.
public ResourceReferenceDt getEncounter()
null.
Definition: The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.
public MedicationAdministration setEncounter(ResourceReferenceDt theValue)
Definition: The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.
public ResourceReferenceDt getPrescription()
null.
Definition: The original request, instruction or authority to perform the administration.
public MedicationAdministration setPrescription(ResourceReferenceDt theValue)
Definition: The original request, instruction or authority to perform the administration.
public BooleanDt getWasNotGivenElement()
null.
Definition: Set this to true if the record is saying that the medication was NOT administered.
public Boolean getWasNotGiven()
null.
Definition: Set this to true if the record is saying that the medication was NOT administered.
public MedicationAdministration setWasNotGiven(BooleanDt theValue)
Definition: Set this to true if the record is saying that the medication was NOT administered.
public MedicationAdministration setWasNotGiven(boolean theBoolean)
Definition: Set this to true if the record is saying that the medication was NOT administered.
public List<CodeableConceptDt> getReasonNotGiven()
null.
Definition: A code indicating why the administration was not performed.
public MedicationAdministration setReasonNotGiven(List<CodeableConceptDt> theValue)
Definition: A code indicating why the administration was not performed.
public CodeableConceptDt addReasonNotGiven()
Definition: A code indicating why the administration was not performed.
public MedicationAdministration addReasonNotGiven(CodeableConceptDt theValue)
Definition: A code indicating why the administration was not performed.
theValue - The reasonNotGiven to add (must not be null)public CodeableConceptDt getReasonNotGivenFirstRep()
Definition: A code indicating why the administration was not performed.
public List<CodeableConceptDt> getReasonGiven()
null.
Definition: A code indicating why the medication was given.
public MedicationAdministration setReasonGiven(List<CodeableConceptDt> theValue)
Definition: A code indicating why the medication was given.
public CodeableConceptDt addReasonGiven()
Definition: A code indicating why the medication was given.
public MedicationAdministration addReasonGiven(CodeableConceptDt theValue)
Definition: A code indicating why the medication was given.
theValue - The reasonGiven to add (must not be null)public CodeableConceptDt getReasonGivenFirstRep()
Definition: A code indicating why the medication was given.
public IDatatype getEffectiveTime()
null.
Definition: 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.
public MedicationAdministration setEffectiveTime(IDatatype theValue)
Definition: 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.
public IDatatype getMedication()
null.
Definition: 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.
public MedicationAdministration setMedication(IDatatype theValue)
Definition: 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.
public List<ResourceReferenceDt> getDevice()
null.
Definition: The device used in administering the medication to the patient. For example, a particular infusion pump
public MedicationAdministration setDevice(List<ResourceReferenceDt> theValue)
Definition: The device used in administering the medication to the patient. For example, a particular infusion pump
public ResourceReferenceDt addDevice()
Definition: The device used in administering the medication to the patient. For example, a particular infusion pump
public StringDt getNoteElement()
null.
Definition: Extra information about the medication administration that is not conveyed by the other attributes.
public String getNote()
null.
Definition: Extra information about the medication administration that is not conveyed by the other attributes.
public MedicationAdministration setNote(StringDt theValue)
Definition: Extra information about the medication administration that is not conveyed by the other attributes.
public MedicationAdministration setNote(String theString)
Definition: Extra information about the medication administration that is not conveyed by the other attributes.
public MedicationAdministration.Dosage getDosage()
null.
Definition: Describes the medication dosage information details e.g. dose, rate, site, route, etc.
public MedicationAdministration setDosage(MedicationAdministration.Dosage theValue)
Definition: Describes the medication dosage information details e.g. dose, rate, site, route, etc.
public String getResourceName()
getResourceName in interface IResourcepublic FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum in interface IResourcegetStructureFhirVersionEnum in interface IBaseResourceCopyright © 2014–2016 University Health Network. All rights reserved.