public class MedicationAdministration extends BaseResource implements IResource
Definition: Describes the event of a patient being given a dose of 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 (Medicine administration instructions to the patient/carer)
|
| Modifier and Type | Field and Description |
|---|---|
static ReferenceClientParam |
DEVICE
Fluent Client search parameter constant for device
|
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_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 |
PRESCRIPTION
Fluent Client search parameter constant for prescription
|
static String |
SP_DEVICE
Search parameter constant for device
|
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_PRESCRIPTION
Search parameter constant for prescription
|
static String |
SP_STATUS
Search parameter constant for status
|
static String |
SP_WHENGIVEN
Search parameter constant for whengiven
|
static TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
static DateClientParam |
WHENGIVEN
Fluent Client search parameter constant for whengiven
|
SP_RES_ID, SP_RES_LANGUAGE| Constructor and Description |
|---|
MedicationAdministration() |
| Modifier and Type | Method and Description |
|---|---|
ResourceReferenceDt |
addDevice()
Adds and returns a new value for device (Device used to administer)
|
MedicationAdministration.Dosage |
addDosage()
Adds and returns a new value for dosage (Medicine administration instructions to the patient/carer)
|
IdentifierDt |
addIdentifier()
Adds and returns a new value for identifier (External identifier)
|
MedicationAdministration |
addIdentifier(IdentifierUseEnum theUse,
String theSystem,
String theValue,
String theLabel)
Adds a new value for identifier (External identifier)
|
MedicationAdministration |
addIdentifier(String theSystem,
String theValue)
Adds a new value for identifier (External identifier)
|
CodeableConceptDt |
addReasonNotGiven()
Adds and returns a new value for reasonNotGiven (Reason administration not performed)
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType)
Returns a list containing all child elements matching a given type
|
List<ResourceReferenceDt> |
getDevice()
Gets the value(s) for device (Device used to administer).
|
List<MedicationAdministration.Dosage> |
getDosage()
Gets the value(s) for dosage (Medicine administration instructions to the patient/carer).
|
MedicationAdministration.Dosage |
getDosageFirstRep()
Gets the first repetition for dosage (Medicine administration instructions to the patient/carer),
creating it if it does not already exist.
|
ResourceReferenceDt |
getEncounter()
Gets the value(s) for encounter (Encounter administered as part of).
|
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 was administered?).
|
ResourceReferenceDt |
getPatient()
Gets the value(s) for patient (Who received medication?).
|
ResourceReferenceDt |
getPractitioner()
Gets the value(s) for practitioner (Who administered substance?).
|
ResourceReferenceDt |
getPrescription()
Gets the value(s) for prescription (Order administration performed against).
|
List<CodeableConceptDt> |
getReasonNotGiven()
Gets the value(s) for reasonNotGiven (Reason administration not performed).
|
CodeableConceptDt |
getReasonNotGivenFirstRep()
Gets the first repetition for reasonNotGiven (Reason administration not performed),
creating it if it does not already exist.
|
BoundCodeDt<MedicationAdministrationStatusEnum> |
getStatus()
Gets the value(s) for status (in progress | on hold | completed | entered in error | stopped).
|
BooleanDt |
getWasNotGiven()
Gets the value(s) for wasNotGiven (True if medication not administered).
|
PeriodDt |
getWhenGiven()
Gets the value(s) for whenGiven (Start and end time of administration).
|
boolean |
isEmpty() |
MedicationAdministration |
setDevice(List<ResourceReferenceDt> theValue)
Sets the value(s) for device (Device used to administer)
|
MedicationAdministration |
setDosage(List<MedicationAdministration.Dosage> theValue)
Sets the value(s) for dosage (Medicine administration instructions to the patient/carer)
|
MedicationAdministration |
setEncounter(ResourceReferenceDt theValue)
Sets the value(s) for encounter (Encounter administered as part of)
|
MedicationAdministration |
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier (External identifier)
|
MedicationAdministration |
setMedication(ResourceReferenceDt theValue)
Sets the value(s) for medication (What was administered?)
|
MedicationAdministration |
setPatient(ResourceReferenceDt theValue)
Sets the value(s) for patient (Who received medication?)
|
MedicationAdministration |
setPractitioner(ResourceReferenceDt theValue)
Sets the value(s) for practitioner (Who administered substance?)
|
MedicationAdministration |
setPrescription(ResourceReferenceDt theValue)
Sets the value(s) for prescription (Order administration performed against)
|
MedicationAdministration |
setReasonNotGiven(List<CodeableConceptDt> theValue)
Sets the value(s) for reasonNotGiven (Reason administration not performed)
|
MedicationAdministration |
setStatus(BoundCodeDt<MedicationAdministrationStatusEnum> theValue)
Sets the value(s) for status (in progress | on hold | completed | entered in error | stopped)
|
MedicationAdministration |
setStatus(MedicationAdministrationStatusEnum theValue)
Sets the value(s) for status (in progress | on hold | completed | entered in error | stopped)
|
MedicationAdministration |
setWasNotGiven(boolean theBoolean)
Sets the value for wasNotGiven (True if medication not administered)
|
MedicationAdministration |
setWasNotGiven(BooleanDt theValue)
Sets the value(s) for wasNotGiven (True if medication not administered)
|
MedicationAdministration |
setWhenGiven(PeriodDt theValue)
Sets the value(s) for whenGiven (Start and end time of administration)
|
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, 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, setResourceMetadatapublic 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 Include INCLUDE_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 Include INCLUDE_ENCOUNTER
public static final String SP_IDENTIFIER
Description: Return administrations with this external identity
Type: token
Path: MedicationAdministration.identifier
public static final TokenClientParam IDENTIFIER
Description: Return administrations with this external identity
Type: token
Path: MedicationAdministration.identifier
public static final String SP_MEDICATION
Description: Return administrations of this medication
Type: reference
Path: MedicationAdministration.medication
public static final ReferenceClientParam MEDICATION
Description: Return administrations of this medication
Type: reference
Path: MedicationAdministration.medication
public static final Include INCLUDE_MEDICATION
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 Include INCLUDE_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 Include INCLUDE_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_WHENGIVEN
Description: Date of administration
Type: date
Path: MedicationAdministration.whenGiven
public static final DateClientParam WHENGIVEN
Description: Date of administration
Type: date
Path: MedicationAdministration.whenGiven
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
ICompositeElementgetAllPopulatedChildElementsOfType in interface ICompositeElementtheType - The type to match. If set to null, all child elements will be returnedpublic List<IdentifierDt> getIdentifier()
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.
public MedicationAdministration setIdentifier(List<IdentifierDt> theValue)
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.
public IdentifierDt addIdentifier()
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.
public IdentifierDt getIdentifierFirstRep()
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.
public MedicationAdministration addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)
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.
public MedicationAdministration addIdentifier(String theSystem, String theValue)
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.
public BoundCodeDt<MedicationAdministrationStatusEnum> 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 to whom the medication was given.
public MedicationAdministration setPatient(ResourceReferenceDt theValue)
Definition: The person or animal to whom the medication was given.
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 or admission the 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 or admission the 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 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 CodeableConceptDt getReasonNotGivenFirstRep()
Definition: A code indicating why the administration was not performed.
public PeriodDt getWhenGiven()
null.
Definition: An interval of time during which the administration took place. For many administrations, such as swallowing a tablet the lower and upper values of the interval will be the same.
public MedicationAdministration setWhenGiven(PeriodDt theValue)
Definition: An interval of time during which the administration took place. For many administrations, such as swallowing a tablet the lower and upper values of the interval will be the same.
public ResourceReferenceDt 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(ResourceReferenceDt 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. E.g. a particular infusion pump
public MedicationAdministration setDevice(List<ResourceReferenceDt> theValue)
Definition: The device used in administering the medication to the patient. E.g. a particular infusion pump
public ResourceReferenceDt addDevice()
Definition: The device used in administering the medication to the patient. E.g. a particular infusion pump
public List<MedicationAdministration.Dosage> getDosage()
null.
Definition: Provides details of how much of the medication was administered
public MedicationAdministration setDosage(List<MedicationAdministration.Dosage> theValue)
Definition: Provides details of how much of the medication was administered
public MedicationAdministration.Dosage addDosage()
Definition: Provides details of how much of the medication was administered
public MedicationAdministration.Dosage getDosageFirstRep()
Definition: Provides details of how much of the medication was administered
Copyright © 2014 University Health Network. All rights reserved.