![](/hapi-fhir/images/logos/raccoon-forwards.png)
Class 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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
static enum
static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected CodeableConcept
Indicates where the medication is expected to be consumed or administered.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for codeprotected Reference
The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for contextprotected Resource
The actual object that is the target of the reference (The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.)The device used in administering the medication to the patient.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for deviceThe actual objects that are the target of the reference (The device used in administering the medication to the patient.Describes the medication dosage information details e.g.protected Type
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 final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for effective-timeA summary of the events of interest that have occurred, such as when the administration was verified.protected List
<Provenance> The actual objects that are the target of the reference (A summary of the events of interest that have occurred, such as when the administration was verified.)protected List
<Identifier> Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.protected Type
Identifies the medication that was administered.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for medicationprotected List
<Annotation> Extra information about the medication administration that is not conveyed by the other attributes.A larger event of which this particular event is a component or step.The actual objects that are the target of the reference (A larger event of which this particular event is a component or step.)static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientIndicates who or what performed the medication administration and how they were involved.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for performerstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for reason-givenstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for reason-not-givenprotected List
<CodeableConcept> A code indicating why the medication was given.Condition or observation that supports why the medication was administered.The actual objects that are the target of the reference (Condition or observation that supports why the medication was administered.)protected Reference
The original request, instruction or authority to perform the administration.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for requestprotected MedicationRequest
The actual object that is the target of the reference (The original request, instruction or authority to perform the administration.)static final String
Search parameter: codestatic final String
Search parameter: contextstatic final String
Search parameter: devicestatic final String
Search parameter: effective-timestatic final String
Search parameter: identifierstatic final String
Search parameter: medicationstatic final String
Search parameter: patientstatic final String
Search parameter: performerstatic final String
Search parameter: reason-givenstatic final String
Search parameter: reason-not-givenstatic final String
Search parameter: requeststatic final String
Search parameter: statusstatic final String
Search parameter: subjectWill generally be set to show that the administration has been completed.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected List
<CodeableConcept> A code indicating why the administration was not performed.protected Reference
The person or animal or group receiving the medication.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectprotected Resource
The actual object that is the target of the reference (The person or animal or group receiving the medication.)Additional information (for example, patient height and weight) that supports the administration of the medication.The actual objects that are the target of the reference (Additional information (for example, patient height and weight) that supports the administration of the medication.)Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorsConstructorDescriptionConstructorMedicationAdministration
(Enumeration<MedicationAdministration.MedicationAdministrationStatus> status, Type medication, Reference subject, Type effective) Constructor -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadaddInstantiates
(String value) addNote()
copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadgetNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
Deprecated.Use Reference#setResource(IBaseResource) insteadBase[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadString[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasInstantiates
(String value) boolean
boolean
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setCategory
(CodeableConcept value) setContext
(Reference value) setContextTarget
(Resource value) setEffective
(Type value) setEventHistory
(List<Reference> theEventHistory) setIdentifier
(List<Identifier> theIdentifier) setInstantiates
(List<UriType> theInstantiates) setMedication
(Type value) setNote
(List<Annotation> theNote) setPerformer
(List<MedicationAdministration.MedicationAdministrationPerformerComponent> thePerformer) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setReasonCode
(List<CodeableConcept> theReasonCode) setReasonReference
(List<Reference> theReasonReference) setRequest
(Reference value) setStatusReason
(List<CodeableConcept> theStatusReason) setSubject
(Reference value) setSubjectTarget
(Resource value) setSupportingInformation
(List<Reference> theSupportingInformation) protected MedicationAdministration
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. -
instantiates
A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event. -
partOf
A larger event of which this particular event is a component or step. -
partOfTarget
The actual objects that are the target of the reference (A larger event of which this particular event is a component or step.) -
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. -
statusReason
A code indicating why the administration was not performed. -
category
Indicates where the medication is expected to be consumed or administered. -
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. -
subject
The person or animal or group receiving the medication. -
subjectTarget
The actual object that is the target of the reference (The person or animal or group receiving the medication.) -
context
The visit, admission, or other contact between patient and health care provider during which the medication administration was performed. -
contextTarget
The actual object that is the target of the reference (The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.) -
supportingInformation
Additional information (for example, patient height and weight) that supports the administration of the medication. -
supportingInformationTarget
The actual objects that are the target of the reference (Additional information (for example, patient height and weight) that supports the administration of the medication.) -
effective
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. -
performer
Indicates who or what performed the medication administration and how they were involved. -
reasonCode
A code indicating why the medication was given. -
reasonReference
Condition or observation that supports why the medication was administered. -
reasonReferenceTarget
The actual objects that are the target of the reference (Condition or observation that supports why the medication was administered.) -
request
The original request, instruction or authority to perform the administration. -
requestTarget
The actual object that is the target of the reference (The original request, instruction or authority to perform the administration.) -
device
The device used in administering the medication to the patient. For example, a particular infusion pump. -
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
Extra information about the medication administration that is not conveyed by the other attributes. -
dosage
Describes the medication dosage information details e.g. dose, rate, site, route, etc. -
eventHistory
A summary of the events of interest that have occurred, such as when the administration was verified. -
eventHistoryTarget
The actual objects that are the target of the reference (A summary of the events of interest that have occurred, such as when the administration was verified.) -
SP_IDENTIFIER
Search parameter: identifierDescription: Return administrations with this external identifier
Type: token
Path: MedicationAdministration.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Return administrations with this external identifier
Type: token
Path: MedicationAdministration.identifier
-
SP_REQUEST
Search parameter: requestDescription: The identity of a request to list administrations from
Type: reference
Path: MedicationAdministration.request
- See Also:
-
REQUEST
Fluent Client search parameter constant for requestDescription: The identity of a request to list administrations from
Type: reference
Path: MedicationAdministration.request
-
INCLUDE_REQUEST
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:request". -
SP_CODE
Search parameter: codeDescription: Return administrations of this medication code
Type: token
Path: MedicationAdministration.medicationCodeableConcept
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: Return administrations of this medication code
Type: token
Path: MedicationAdministration.medicationCodeableConcept
-
SP_PERFORMER
Search parameter: performerDescription: The identity of the individual who administered the medication
Type: reference
Path: MedicationAdministration.performer.actor
- See Also:
-
PERFORMER
Fluent Client search parameter constant for performerDescription: The identity of the individual who administered the medication
Type: reference
Path: MedicationAdministration.performer.actor
-
INCLUDE_PERFORMER
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:performer". -
SP_SUBJECT
Search parameter: subjectDescription: The identity of the individual or group to list administrations for
Type: reference
Path: MedicationAdministration.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: The identity of the individual or group to list administrations for
Type: reference
Path: MedicationAdministration.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:subject". -
SP_MEDICATION
Search parameter: medicationDescription: Return administrations of this medication resource
Type: reference
Path: MedicationAdministration.medicationReference
- See Also:
-
MEDICATION
Fluent Client search parameter constant for medicationDescription: Return administrations of this medication resource
Type: reference
Path: MedicationAdministration.medicationReference
-
INCLUDE_MEDICATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:medication". -
SP_REASON_GIVEN
Search parameter: reason-givenDescription: Reasons for administering the medication
Type: token
Path: MedicationAdministration.reasonCode
- See Also:
-
REASON_GIVEN
Fluent Client search parameter constant for reason-givenDescription: Reasons for administering the medication
Type: token
Path: MedicationAdministration.reasonCode
-
SP_PATIENT
Search parameter: patientDescription: The identity of a patient to list administrations for
Type: reference
Path: MedicationAdministration.subject
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: The identity of a patient to list administrations for
Type: reference
Path: MedicationAdministration.subject
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:patient". -
SP_EFFECTIVE_TIME
Search parameter: effective-timeDescription: Date administration happened (or did not happen)
Type: date
Path: MedicationAdministration.effective[x]
- See Also:
-
EFFECTIVE_TIME
Fluent Client search parameter constant for effective-timeDescription: Date administration happened (or did not happen)
Type: date
Path: MedicationAdministration.effective[x]
-
SP_CONTEXT
Search parameter: contextDescription: Return administrations that share this encounter or episode of care
Type: reference
Path: MedicationAdministration.context
- See Also:
-
CONTEXT
Fluent Client search parameter constant for contextDescription: Return administrations that share this encounter or episode of care
Type: reference
Path: MedicationAdministration.context
-
INCLUDE_CONTEXT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:context". -
SP_REASON_NOT_GIVEN
Search parameter: reason-not-givenDescription: Reasons for not administering the medication
Type: token
Path: MedicationAdministration.statusReason
- See Also:
-
REASON_NOT_GIVEN
Fluent Client search parameter constant for reason-not-givenDescription: Reasons for not administering the medication
Type: token
Path: MedicationAdministration.statusReason
-
SP_DEVICE
Search parameter: deviceDescription: Return administrations with this administration device identity
Type: reference
Path: MedicationAdministration.device
- See Also:
-
DEVICE
Fluent Client search parameter constant for deviceDescription: Return administrations with this administration device identity
Type: reference
Path: MedicationAdministration.device
-
INCLUDE_DEVICE
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:device". -
SP_STATUS
Search parameter: statusDescription: MedicationAdministration event status (for example one of active/paused/completed/nullified)
Type: token
Path: MedicationAdministration.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: MedicationAdministration event status (for example one of active/paused/completed/nullified)
Type: token
Path: MedicationAdministration.status
-
-
Constructor Details
-
MedicationAdministration
public MedicationAdministration()Constructor -
MedicationAdministration
public MedicationAdministration(Enumeration<MedicationAdministration.MedicationAdministrationStatus> status, Type medication, Reference subject, Type effective) Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getInstantiates
- Returns:
instantiates
(A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.)
-
setInstantiates
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInstantiates
-
addInstantiatesElement
- Returns:
instantiates
(A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.)
-
addInstantiates
- Parameters:
value
-instantiates
(A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.)
-
hasInstantiates
- Parameters:
value
-instantiates
(A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.)
-
getPartOf
- Returns:
partOf
(A larger event of which this particular event is a component or step.)
-
setPartOf
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPartOf
-
addPartOf
-
addPartOf
-
getPartOfFirstRep
- Returns:
- The first repetition of repeating field
partOf
, creating it if it does not already exist
-
getPartOfTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
-
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
- 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.
-
getStatusReason
- Returns:
statusReason
(A code indicating why the administration was not performed.)
-
setStatusReason
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasStatusReason
-
addStatusReason
-
addStatusReason
-
getStatusReasonFirstRep
- Returns:
- The first repetition of repeating field
statusReason
, creating it if it does not already exist
-
getCategory
- Returns:
category
(Indicates where the medication is expected to be consumed or administered.)
-
hasCategory
-
setCategory
- Parameters:
value
-category
(Indicates where the medication is expected to be consumed or administered.)
-
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
- 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
-
getMedicationReference
- 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
-
hasMedication
-
setMedication
- 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.)
-
getSubject
- Returns:
subject
(The person or animal or group receiving the medication.)
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(The person or animal or group receiving the medication.)
-
getSubjectTarget
- Returns:
subject
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 or group receiving the medication.)
-
setSubjectTarget
- Parameters:
value
-subject
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 or group receiving the medication.)
-
getContext
- Returns:
context
(The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.)
-
hasContext
-
setContext
- Parameters:
value
-context
(The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.)
-
getContextTarget
- Returns:
context
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 during which the medication administration was performed.)
-
setContextTarget
- Parameters:
value
-context
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 during which the medication administration was performed.)
-
getSupportingInformation
- Returns:
supportingInformation
(Additional information (for example, patient height and weight) that supports the administration of the medication.)
-
setSupportingInformation
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSupportingInformation
-
addSupportingInformation
-
addSupportingInformation
-
getSupportingInformationFirstRep
- Returns:
- The first repetition of repeating field
supportingInformation
, creating it if it does not already exist
-
getSupportingInformationTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getEffective
- Returns:
effective
(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.)
-
getEffectiveDateTimeType
- Returns:
effective
(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
-
hasEffectiveDateTimeType
-
getEffectivePeriod
- Returns:
effective
(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
-
hasEffectivePeriod
-
hasEffective
-
setEffective
- Parameters:
value
-effective
(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.)
-
getPerformer
- Returns:
performer
(Indicates who or what performed the medication administration and how they were involved.)
-
setPerformer
public MedicationAdministration setPerformer(List<MedicationAdministration.MedicationAdministrationPerformerComponent> thePerformer) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasPerformer
-
addPerformer
-
addPerformer
-
getPerformerFirstRep
- Returns:
- The first repetition of repeating field
performer
, creating it if it does not already exist
-
getReasonCode
- Returns:
reasonCode
(A code indicating why the medication was given.)
-
setReasonCode
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReasonCode
-
addReasonCode
-
addReasonCode
-
getReasonCodeFirstRep
- Returns:
- The first repetition of repeating field
reasonCode
, creating it if it does not already exist
-
getReasonReference
- Returns:
reasonReference
(Condition or observation that supports why the medication was administered.)
-
setReasonReference
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReasonReference
-
addReasonReference
-
addReasonReference
-
getReasonReferenceFirstRep
- Returns:
- The first repetition of repeating field
reasonReference
, creating it if it does not already exist
-
getReasonReferenceTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getRequest
- Returns:
request
(The original request, instruction or authority to perform the administration.)
-
hasRequest
-
setRequest
- Parameters:
value
-request
(The original request, instruction or authority to perform the administration.)
-
getRequestTarget
- Returns:
request
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.)
-
setRequestTarget
- Parameters:
value
-request
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.)
-
getDevice
- Returns:
device
(The device used in administering the medication to the patient. For example, a particular infusion pump.)
-
setDevice
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDevice
-
addDevice
-
addDevice
-
getDeviceFirstRep
- Returns:
- The first repetition of repeating field
device
, creating it if it does not already exist
-
getDeviceTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addDeviceTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getNote
- Returns:
note
(Extra information about the medication administration that is not conveyed by the other attributes.)
-
setNote
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
-
addNote
-
addNote
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist
-
getDosage
- Returns:
dosage
(Describes the medication dosage information details e.g. dose, rate, site, route, etc.)
-
hasDosage
-
setDosage
public MedicationAdministration setDosage(MedicationAdministration.MedicationAdministrationDosageComponent value) - Parameters:
value
-dosage
(Describes the medication dosage information details e.g. dose, rate, site, route, etc.)
-
getEventHistory
- Returns:
eventHistory
(A summary of the events of interest that have occurred, such as when the administration was verified.)
-
setEventHistory
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEventHistory
-
addEventHistory
-
addEventHistory
-
getEventHistoryFirstRep
- Returns:
- The first repetition of repeating field
eventHistory
, creating it if it does not already exist
-
getEventHistoryTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addEventHistoryTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-