Class MedicationAdministration
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.model.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
public class MedicationAdministration extends DomainResource
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.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMedicationAdministration.MedicationAdministrationDosageComponentstatic classMedicationAdministration.MedicationAdministrationPerformerComponentstatic classMedicationAdministration.MedicationAdministrationStatusstatic classMedicationAdministration.MedicationAdministrationStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected CodeableConceptcategoryIndicates where the medication is expected to be consumed or administered.static ca.uhn.fhir.rest.gclient.TokenClientParamCODEFluent Client search parameter constant for codeprotected ReferencecontextThe visit, admission, or other contact between patient and health care provider during which the medication administration was performed.static ca.uhn.fhir.rest.gclient.ReferenceClientParamCONTEXTFluent Client search parameter constant for contextprotected ResourcecontextTargetThe 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.)protected List<Reference>deviceThe device used in administering the medication to the patient.static ca.uhn.fhir.rest.gclient.ReferenceClientParamDEVICEFluent Client search parameter constant for deviceprotected List<Device>deviceTargetThe actual objects that are the target of the reference (The device used in administering the medication to the patient.protected MedicationAdministration.MedicationAdministrationDosageComponentdosageDescribes the medication dosage information details e.g.protected TypeeffectiveA 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 ca.uhn.fhir.rest.gclient.DateClientParamEFFECTIVE_TIMEFluent Client search parameter constant for effective-timeprotected List<Reference>eventHistoryA summary of the events of interest that have occurred, such as when the administration was verified.protected List<Provenance>eventHistoryTargetThe 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>identifierIdentifiers 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 ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_CONTEXTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_DEVICEConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_MEDICATIONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PERFORMERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_REQUESTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.protected List<UriType>instantiatesA protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.protected TypemedicationIdentifies the medication that was administered.static ca.uhn.fhir.rest.gclient.ReferenceClientParamMEDICATIONFluent Client search parameter constant for medicationprotected List<Annotation>noteExtra information about the medication administration that is not conveyed by the other attributes.protected List<Reference>partOfA larger event of which this particular event is a component or step.protected List<Resource>partOfTargetThe actual objects that are the target of the reference (A larger event of which this particular event is a component or step.)static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected List<MedicationAdministration.MedicationAdministrationPerformerComponent>performerIndicates who or what performed the medication administration and how they were involved.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPERFORMERFluent Client search parameter constant for performerstatic ca.uhn.fhir.rest.gclient.TokenClientParamREASON_GIVENFluent Client search parameter constant for reason-givenstatic ca.uhn.fhir.rest.gclient.TokenClientParamREASON_NOT_GIVENFluent Client search parameter constant for reason-not-givenprotected List<CodeableConcept>reasonCodeA code indicating why the medication was given.protected List<Reference>reasonReferenceCondition or observation that supports why the medication was administered.protected List<Resource>reasonReferenceTargetThe actual objects that are the target of the reference (Condition or observation that supports why the medication was administered.)protected ReferencerequestThe original request, instruction or authority to perform the administration.static ca.uhn.fhir.rest.gclient.ReferenceClientParamREQUESTFluent Client search parameter constant for requestprotected MedicationRequestrequestTargetThe actual object that is the target of the reference (The original request, instruction or authority to perform the administration.)static StringSP_CODESearch parameter: codestatic StringSP_CONTEXTSearch parameter: contextstatic StringSP_DEVICESearch parameter: devicestatic StringSP_EFFECTIVE_TIMESearch parameter: effective-timestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_MEDICATIONSearch parameter: medicationstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_PERFORMERSearch parameter: performerstatic StringSP_REASON_GIVENSearch parameter: reason-givenstatic StringSP_REASON_NOT_GIVENSearch parameter: reason-not-givenstatic StringSP_REQUESTSearch parameter: requeststatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUBJECTSearch parameter: subjectprotected Enumeration<MedicationAdministration.MedicationAdministrationStatus>statusWill generally be set to show that the administration has been completed.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected List<CodeableConcept>statusReasonA code indicating why the administration was not performed.protected ReferencesubjectThe person or animal or group receiving the medication.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectprotected ResourcesubjectTargetThe actual object that is the target of the reference (The person or animal or group receiving the medication.)protected List<Reference>supportingInformationAdditional information (for example, patient height and weight) that supports the administration of the medication.protected List<Resource>supportingInformationTargetThe 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
-
-
Constructor Summary
Constructors Constructor Description MedicationAdministration()ConstructorMedicationAdministration(Enumeration<MedicationAdministration.MedicationAdministrationStatus> status, Type medication, Reference subject, Type effective)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, 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, 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, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, 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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> 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
protected List<UriType> instantiates
A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.
-
partOf
protected List<Reference> partOf
A larger event of which this particular event is a component or step.
-
partOfTarget
protected List<Resource> 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
protected Enumeration<MedicationAdministration.MedicationAdministrationStatus> 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
protected List<CodeableConcept> statusReason
A code indicating why the administration was not performed.
-
category
protected CodeableConcept category
Indicates where the medication is expected to be consumed or administered.
-
medication
protected Type 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.
-
subjectTarget
protected Resource subjectTarget
The actual object that is the target of the reference (The person or animal or group receiving the medication.)
-
context
protected Reference context
The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.
-
contextTarget
protected Resource 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
protected List<Reference> supportingInformation
Additional information (for example, patient height and weight) that supports the administration of the medication.
-
supportingInformationTarget
protected List<Resource> 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
protected Type 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
protected List<MedicationAdministration.MedicationAdministrationPerformerComponent> performer
Indicates who or what performed the medication administration and how they were involved.
-
reasonCode
protected List<CodeableConcept> reasonCode
A code indicating why the medication was given.
-
reasonReference
protected List<Reference> reasonReference
Condition or observation that supports why the medication was administered.
-
reasonReferenceTarget
protected List<Resource> reasonReferenceTarget
The actual objects that are the target of the reference (Condition or observation that supports why the medication was administered.)
-
request
protected Reference request
The original request, instruction or authority to perform the administration.
-
requestTarget
protected MedicationRequest requestTarget
The actual object that is the target of the reference (The original request, instruction or authority to perform the administration.)
-
device
protected List<Reference> device
The device used in administering the medication to the patient. For example, a particular infusion pump.
-
deviceTarget
protected List<Device> 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
protected List<Annotation> note
Extra information about the medication administration that is not conveyed by the other attributes.
-
dosage
protected MedicationAdministration.MedicationAdministrationDosageComponent dosage
Describes the medication dosage information details e.g. dose, rate, site, route, etc.
-
eventHistory
protected List<Reference> eventHistory
A summary of the events of interest that have occurred, such as when the administration was verified.
-
eventHistoryTarget
protected List<Provenance> 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
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Return administrations with this external identifier
Type: token
Path: MedicationAdministration.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Return administrations with this external identifier
Type: token
Path: MedicationAdministration.identifier
-
SP_REQUEST
public static final String SP_REQUEST
Search parameter: requestDescription: The identity of a request to list administrations from
Type: reference
Path: MedicationAdministration.request
- See Also:
- Constant Field Values
-
REQUEST
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REQUEST
Fluent Client search parameter constant for requestDescription: The identity of a request to list administrations from
Type: reference
Path: MedicationAdministration.request
-
INCLUDE_REQUEST
public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUEST
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:request".
-
SP_CODE
public static final String SP_CODE
Search parameter: codeDescription: Return administrations of this medication code
Type: token
Path: MedicationAdministration.medicationCodeableConcept
- See Also:
- Constant Field Values
-
CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
Fluent Client search parameter constant for codeDescription: Return administrations of this medication code
Type: token
Path: MedicationAdministration.medicationCodeableConcept
-
SP_PERFORMER
public static final String SP_PERFORMER
Search parameter: performerDescription: The identity of the individual who administered the medication
Type: reference
Path: MedicationAdministration.performer.actor
- See Also:
- Constant Field Values
-
PERFORMER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam 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
public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMER
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:performer".
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: The identity of the individual or group to list administrations for
Type: reference
Path: MedicationAdministration.subject
- See Also:
- Constant Field Values
-
SUBJECT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam 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
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:subject".
-
SP_MEDICATION
public static final String SP_MEDICATION
Search parameter: medicationDescription: Return administrations of this medication resource
Type: reference
Path: MedicationAdministration.medicationReference
- See Also:
- Constant Field Values
-
MEDICATION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MEDICATION
Fluent Client search parameter constant for medicationDescription: Return administrations of this medication resource
Type: reference
Path: MedicationAdministration.medicationReference
-
INCLUDE_MEDICATION
public static final ca.uhn.fhir.model.api.Include INCLUDE_MEDICATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:medication".
-
SP_REASON_GIVEN
public static final String SP_REASON_GIVEN
Search parameter: reason-givenDescription: Reasons for administering the medication
Type: token
Path: MedicationAdministration.reasonCode
- See Also:
- Constant Field Values
-
REASON_GIVEN
public static final ca.uhn.fhir.rest.gclient.TokenClientParam REASON_GIVEN
Fluent Client search parameter constant for reason-givenDescription: Reasons for administering the medication
Type: token
Path: MedicationAdministration.reasonCode
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: The identity of a patient to list administrations for
Type: reference
Path: MedicationAdministration.subject
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: The identity of a patient to list administrations for
Type: reference
Path: MedicationAdministration.subject
-
INCLUDE_PATIENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:patient".
-
SP_EFFECTIVE_TIME
public static final String SP_EFFECTIVE_TIME
Search parameter: effective-timeDescription: Date administration happened (or did not happen)
Type: date
Path: MedicationAdministration.effective[x]
- See Also:
- Constant Field Values
-
EFFECTIVE_TIME
public static final ca.uhn.fhir.rest.gclient.DateClientParam 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
public static final String SP_CONTEXT
Search parameter: contextDescription: Return administrations that share this encounter or episode of care
Type: reference
Path: MedicationAdministration.context
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam 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
public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTEXT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:context".
-
SP_REASON_NOT_GIVEN
public static final String SP_REASON_NOT_GIVEN
Search parameter: reason-not-givenDescription: Reasons for not administering the medication
Type: token
Path: MedicationAdministration.statusReason
- See Also:
- Constant Field Values
-
REASON_NOT_GIVEN
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
public static final String SP_DEVICE
Search parameter: deviceDescription: Return administrations with this administration device identity
Type: reference
Path: MedicationAdministration.device
- See Also:
- Constant Field Values
-
DEVICE
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEVICE
Fluent Client search parameter constant for deviceDescription: Return administrations with this administration device identity
Type: reference
Path: MedicationAdministration.device
-
INCLUDE_DEVICE
public static final ca.uhn.fhir.model.api.Include INCLUDE_DEVICE
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:device".
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: MedicationAdministration event status (for example one of active/paused/completed/nullified)
Type: token
Path: MedicationAdministration.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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 Detail
-
MedicationAdministration
public MedicationAdministration()
Constructor
-
MedicationAdministration
public MedicationAdministration(Enumeration<MedicationAdministration.MedicationAdministrationStatus> status, Type medication, Reference subject, Type effective)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> 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
public MedicationAdministration setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public MedicationAdministration addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
getInstantiates
public List<UriType> getInstantiates()
- Returns:
instantiates(A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.)
-
setInstantiates
public MedicationAdministration setInstantiates(List<UriType> theInstantiates)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasInstantiates
public boolean hasInstantiates()
-
addInstantiatesElement
public UriType addInstantiatesElement()
- Returns:
instantiates(A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.)
-
addInstantiates
public MedicationAdministration addInstantiates(String value)
- Parameters:
value-instantiates(A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.)
-
hasInstantiates
public boolean hasInstantiates(String value)
- Parameters:
value-instantiates(A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.)
-
getPartOf
public List<Reference> getPartOf()
- Returns:
partOf(A larger event of which this particular event is a component or step.)
-
setPartOf
public MedicationAdministration setPartOf(List<Reference> thePartOf)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPartOf
public boolean hasPartOf()
-
addPartOf
public MedicationAdministration addPartOf(Reference t)
-
getPartOfFirstRep
public Reference getPartOfFirstRep()
- Returns:
- The first repetition of repeating field
partOf, creating it if it does not already exist
-
getPartOfTarget
@Deprecated public List<Resource> getPartOfTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getStatusElement
public Enumeration<MedicationAdministration.MedicationAdministrationStatus> 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
public boolean hasStatusElement()
-
hasStatus
public boolean 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
public MedicationAdministration.MedicationAdministrationStatus 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
public List<CodeableConcept> getStatusReason()
- Returns:
statusReason(A code indicating why the administration was not performed.)
-
setStatusReason
public MedicationAdministration setStatusReason(List<CodeableConcept> theStatusReason)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasStatusReason
public boolean hasStatusReason()
-
addStatusReason
public CodeableConcept addStatusReason()
-
addStatusReason
public MedicationAdministration addStatusReason(CodeableConcept t)
-
getStatusReasonFirstRep
public CodeableConcept getStatusReasonFirstRep()
- Returns:
- The first repetition of repeating field
statusReason, creating it if it does not already exist
-
getCategory
public CodeableConcept getCategory()
- Returns:
category(Indicates where the medication is expected to be consumed or administered.)
-
hasCategory
public boolean hasCategory()
-
setCategory
public MedicationAdministration setCategory(CodeableConcept value)
- Parameters:
value-category(Indicates where the medication is expected to be consumed or administered.)
-
getMedication
public Type 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
public CodeableConcept getMedicationCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasMedicationCodeableConcept()
-
getMedicationReference
public Reference getMedicationReference() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasMedicationReference()
-
hasMedication
public boolean hasMedication()
-
setMedication
public MedicationAdministration setMedication(Type value)
- 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
public Reference getSubject()
- Returns:
subject(The person or animal or group receiving the medication.)
-
hasSubject
public boolean hasSubject()
-
setSubject
public MedicationAdministration setSubject(Reference value)
- Parameters:
value-subject(The person or animal or group receiving the medication.)
-
getSubjectTarget
public Resource getSubjectTarget()
- Returns:
subjectThe 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
public MedicationAdministration setSubjectTarget(Resource value)
- Parameters:
value-subjectThe 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
public Reference getContext()
- Returns:
context(The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.)
-
hasContext
public boolean hasContext()
-
setContext
public MedicationAdministration setContext(Reference value)
- Parameters:
value-context(The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.)
-
getContextTarget
public Resource getContextTarget()
- Returns:
contextThe 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
public MedicationAdministration setContextTarget(Resource value)
- Parameters:
value-contextThe 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
public List<Reference> getSupportingInformation()
- Returns:
supportingInformation(Additional information (for example, patient height and weight) that supports the administration of the medication.)
-
setSupportingInformation
public MedicationAdministration setSupportingInformation(List<Reference> theSupportingInformation)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSupportingInformation
public boolean hasSupportingInformation()
-
addSupportingInformation
public Reference addSupportingInformation()
-
addSupportingInformation
public MedicationAdministration addSupportingInformation(Reference t)
-
getSupportingInformationFirstRep
public Reference getSupportingInformationFirstRep()
- Returns:
- The first repetition of repeating field
supportingInformation, creating it if it does not already exist
-
getSupportingInformationTarget
@Deprecated public List<Resource> getSupportingInformationTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getEffective
public Type 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
public DateTimeType getEffectiveDateTimeType() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasEffectiveDateTimeType()
-
getEffectivePeriod
public Period getEffectivePeriod() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasEffectivePeriod()
-
hasEffective
public boolean hasEffective()
-
setEffective
public MedicationAdministration setEffective(Type value)
- 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
public List<MedicationAdministration.MedicationAdministrationPerformerComponent> 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
thisfor easy method chaining
-
hasPerformer
public boolean hasPerformer()
-
addPerformer
public MedicationAdministration.MedicationAdministrationPerformerComponent addPerformer()
-
addPerformer
public MedicationAdministration addPerformer(MedicationAdministration.MedicationAdministrationPerformerComponent t)
-
getPerformerFirstRep
public MedicationAdministration.MedicationAdministrationPerformerComponent getPerformerFirstRep()
- Returns:
- The first repetition of repeating field
performer, creating it if it does not already exist
-
getReasonCode
public List<CodeableConcept> getReasonCode()
- Returns:
reasonCode(A code indicating why the medication was given.)
-
setReasonCode
public MedicationAdministration setReasonCode(List<CodeableConcept> theReasonCode)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReasonCode
public boolean hasReasonCode()
-
addReasonCode
public CodeableConcept addReasonCode()
-
addReasonCode
public MedicationAdministration addReasonCode(CodeableConcept t)
-
getReasonCodeFirstRep
public CodeableConcept getReasonCodeFirstRep()
- Returns:
- The first repetition of repeating field
reasonCode, creating it if it does not already exist
-
getReasonReference
public List<Reference> getReasonReference()
- Returns:
reasonReference(Condition or observation that supports why the medication was administered.)
-
setReasonReference
public MedicationAdministration setReasonReference(List<Reference> theReasonReference)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReasonReference
public boolean hasReasonReference()
-
addReasonReference
public Reference addReasonReference()
-
addReasonReference
public MedicationAdministration addReasonReference(Reference t)
-
getReasonReferenceFirstRep
public Reference getReasonReferenceFirstRep()
- Returns:
- The first repetition of repeating field
reasonReference, creating it if it does not already exist
-
getReasonReferenceTarget
@Deprecated public List<Resource> getReasonReferenceTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getRequest
public Reference getRequest()
- Returns:
request(The original request, instruction or authority to perform the administration.)
-
hasRequest
public boolean hasRequest()
-
setRequest
public MedicationAdministration setRequest(Reference value)
- Parameters:
value-request(The original request, instruction or authority to perform the administration.)
-
getRequestTarget
public MedicationRequest getRequestTarget()
- Returns:
requestThe 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
public MedicationAdministration setRequestTarget(MedicationRequest value)
- Parameters:
value-requestThe 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
public List<Reference> getDevice()
- Returns:
device(The device used in administering the medication to the patient. For example, a particular infusion pump.)
-
setDevice
public MedicationAdministration setDevice(List<Reference> theDevice)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDevice
public boolean hasDevice()
-
addDevice
public MedicationAdministration addDevice(Reference t)
-
getDeviceFirstRep
public Reference getDeviceFirstRep()
- Returns:
- The first repetition of repeating field
device, creating it if it does not already exist
-
getDeviceTarget
@Deprecated public List<Device> getDeviceTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addDeviceTarget
@Deprecated public Device addDeviceTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getNote
public List<Annotation> getNote()
- Returns:
note(Extra information about the medication administration that is not conveyed by the other attributes.)
-
setNote
public MedicationAdministration setNote(List<Annotation> theNote)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasNote
public boolean hasNote()
-
addNote
public Annotation addNote()
-
addNote
public MedicationAdministration addNote(Annotation t)
-
getNoteFirstRep
public Annotation getNoteFirstRep()
- Returns:
- The first repetition of repeating field
note, creating it if it does not already exist
-
getDosage
public MedicationAdministration.MedicationAdministrationDosageComponent getDosage()
- Returns:
dosage(Describes the medication dosage information details e.g. dose, rate, site, route, etc.)
-
hasDosage
public boolean 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
public List<Reference> getEventHistory()
- Returns:
eventHistory(A summary of the events of interest that have occurred, such as when the administration was verified.)
-
setEventHistory
public MedicationAdministration setEventHistory(List<Reference> theEventHistory)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEventHistory
public boolean hasEventHistory()
-
addEventHistory
public Reference addEventHistory()
-
addEventHistory
public MedicationAdministration addEventHistory(Reference t)
-
getEventHistoryFirstRep
public Reference getEventHistoryFirstRep()
- Returns:
- The first repetition of repeating field
eventHistory, creating it if it does not already exist
-
getEventHistoryTarget
@Deprecated public List<Provenance> getEventHistoryTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addEventHistoryTarget
@Deprecated public Provenance addEventHistoryTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public MedicationAdministration copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(MedicationAdministration dst)
-
typedCopy
protected MedicationAdministration typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-