
Class MedicationAdministration
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.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 class
MedicationAdministration.MedicationAdministrationDosageComponent
static class
MedicationAdministration.MedicationAdministrationPerformerComponent
static class
MedicationAdministration.MedicationAdministrationStatus
static class
MedicationAdministration.MedicationAdministrationStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected CodeableConcept
category
Indicates the type of medication administration and where the medication is expected to be consumed or administered.static ca.uhn.fhir.rest.gclient.TokenClientParam
CODE
Fluent Client search parameter constant for codeprotected Reference
context
The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
CONTEXT
Fluent Client search parameter constant for contextprotected Resource
contextTarget
The actual object that is the target of the reference (The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.)protected List<Reference>
definition
A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this event.protected List<Resource>
definitionTarget
The actual objects that are the target of the reference (A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this event.)protected List<Reference>
device
The device used in administering the medication to the patient.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
DEVICE
Fluent Client search parameter constant for deviceprotected List<Device>
deviceTarget
The actual objects that are the target of the reference (The device used in administering the medication to the patient.protected MedicationAdministration.MedicationAdministrationDosageComponent
dosage
Describes the medication dosage information details e.g.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).static ca.uhn.fhir.rest.gclient.DateClientParam
EFFECTIVE_TIME
Fluent Client search parameter constant for effective-timeprotected List<Reference>
eventHistory
A summary of the events of interest that have occurred, such as when the administration was verified.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.)protected List<Identifier>
identifier
External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource.static ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.Include
INCLUDE_CONTEXT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_DEVICE
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_MEDICATION
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PERFORMER
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PRESCRIPTION
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.protected Type
medication
Identifies the medication that was administered.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
MEDICATION
Fluent Client search parameter constant for medicationstatic ca.uhn.fhir.rest.gclient.TokenClientParam
NOT_GIVEN
Fluent Client search parameter constant for not-givenprotected List<Annotation>
note
Extra information about the medication administration that is not conveyed by the other attributes.protected BooleanType
notGiven
Set this to true if the record is saying that the medication was NOT administered.protected List<Reference>
partOf
A larger event of which this particular event is a component or step.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.)static ca.uhn.fhir.rest.gclient.ReferenceClientParam
PATIENT
Fluent Client search parameter constant for patientprotected List<MedicationAdministration.MedicationAdministrationPerformerComponent>
performer
The individual who was responsible for giving the medication to the patient.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
PERFORMER
Fluent Client search parameter constant for performerprotected Reference
prescription
The original request, instruction or authority to perform the administration.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
PRESCRIPTION
Fluent Client search parameter constant for prescriptionprotected MedicationRequest
prescriptionTarget
The actual object that is the target of the reference (The original request, instruction or authority to perform the administration.)static ca.uhn.fhir.rest.gclient.TokenClientParam
REASON_GIVEN
Fluent Client search parameter constant for reason-givenstatic ca.uhn.fhir.rest.gclient.TokenClientParam
REASON_NOT_GIVEN
Fluent Client search parameter constant for reason-not-givenprotected List<CodeableConcept>
reasonCode
A code indicating why the medication was given.protected List<CodeableConcept>
reasonNotGiven
A code indicating why the administration was not performed.protected List<Reference>
reasonReference
Condition or observation that supports why the medication was administered.protected List<Resource>
reasonReferenceTarget
The actual objects that are the target of the reference (Condition or observation that supports why the medication was administered.)static String
SP_CODE
Search parameter: codestatic String
SP_CONTEXT
Search parameter: contextstatic String
SP_DEVICE
Search parameter: devicestatic String
SP_EFFECTIVE_TIME
Search parameter: effective-timestatic String
SP_IDENTIFIER
Search parameter: identifierstatic String
SP_MEDICATION
Search parameter: medicationstatic String
SP_NOT_GIVEN
Search parameter: not-givenstatic String
SP_PATIENT
Search parameter: patientstatic String
SP_PERFORMER
Search parameter: performerstatic String
SP_PRESCRIPTION
Search parameter: prescriptionstatic String
SP_REASON_GIVEN
Search parameter: reason-givenstatic String
SP_REASON_NOT_GIVEN
Search parameter: reason-not-givenstatic String
SP_STATUS
Search parameter: statusstatic String
SP_SUBJECT
Search parameter: subjectprotected Enumeration<MedicationAdministration.MedicationAdministrationStatus>
status
Will generally be set to show that the administration has been completed.static ca.uhn.fhir.rest.gclient.TokenClientParam
STATUS
Fluent Client search parameter constant for statusprotected Reference
subject
The person or animal or group receiving the medication.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
SUBJECT
Fluent Client search parameter constant for subjectprotected Resource
subjectTarget
The actual object that is the target of the reference (The person or animal or group receiving the medication.)protected List<Reference>
supportingInformation
Additional information (for example, patient height and weight) that supports the administration of the medication.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.)-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.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.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, 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.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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
External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.
-
definition
protected List<Reference> definition
A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this event.
-
definitionTarget
protected List<Resource> definitionTarget
The actual objects that are the target of the reference (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.
-
category
protected CodeableConcept category
Indicates the type of medication administration and 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 the medication administration was performed as part of.
-
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 the medication administration was performed as part of.)
-
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
The individual who was responsible for giving the medication to the patient.
-
notGiven
protected BooleanType notGiven
Set this to true if the record is saying that the medication was NOT administered.
-
reasonNotGiven
protected List<CodeableConcept> reasonNotGiven
A code indicating why the administration was not performed.
-
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.)
-
prescription
protected Reference prescription
The original request, instruction or authority to perform the administration.
-
prescriptionTarget
protected MedicationRequest prescriptionTarget
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_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 identify 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 identify 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 identify 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 identify 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_NOT_GIVEN
public static final String SP_NOT_GIVEN
Search parameter: not-givenDescription: Administrations that were not made
Type: token
Path: MedicationAdministration.notGiven
- See Also:
- Constant Field Values
-
NOT_GIVEN
public static final ca.uhn.fhir.rest.gclient.TokenClientParam NOT_GIVEN
Fluent Client search parameter constant for not-givenDescription: Administrations that were not made
Type: token
Path: MedicationAdministration.notGiven
-
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_PRESCRIPTION
public static final String SP_PRESCRIPTION
Search parameter: prescriptionDescription: The identity of a prescription to list administrations from
Type: reference
Path: MedicationAdministration.prescription
- See Also:
- Constant Field Values
-
PRESCRIPTION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRESCRIPTION
Fluent Client search parameter constant for prescriptionDescription: The identity of a prescription to list administrations from
Type: reference
Path: MedicationAdministration.prescription
-
INCLUDE_PRESCRIPTION
public static final ca.uhn.fhir.model.api.Include INCLUDE_PRESCRIPTION
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:prescription".
-
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.reasonNotGiven
- 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.reasonNotGiven
-
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
(External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.)
-
setIdentifier
public MedicationAdministration setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
this
for 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
-
getDefinition
public List<Reference> getDefinition()
- Returns:
definition
(A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this event.)
-
setDefinition
public MedicationAdministration setDefinition(List<Reference> theDefinition)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDefinition
public boolean hasDefinition()
-
addDefinition
public Reference addDefinition()
-
addDefinition
public MedicationAdministration addDefinition(Reference t)
-
getDefinitionFirstRep
public Reference getDefinitionFirstRep()
- Returns:
- The first repetition of repeating field
definition
, creating it if it does not already exist
-
getDefinitionTarget
@Deprecated public List<Resource> getDefinitionTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
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
this
for 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.
-
getCategory
public CodeableConcept getCategory()
- Returns:
category
(Indicates the type of medication administration and where the medication is expected to be consumed or administered.)
-
hasCategory
public boolean hasCategory()
-
setCategory
public MedicationAdministration setCategory(CodeableConcept value)
- Parameters:
value
-category
(Indicates the type of medication administration and 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) throws org.hl7.fhir.exceptions.FHIRFormatError
- 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.)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
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:
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
public MedicationAdministration setSubjectTarget(Resource value)
- 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
public Reference getContext()
- Returns:
context
(The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.)
-
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 the medication administration was performed as part of.)
-
getContextTarget
public Resource 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 the medication administration was performed as part of.)
-
setContextTarget
public MedicationAdministration setContextTarget(Resource value)
- 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 the medication administration was performed as part of.)
-
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
this
for 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) throws org.hl7.fhir.exceptions.FHIRFormatError
- 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.)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
getPerformer
public List<MedicationAdministration.MedicationAdministrationPerformerComponent> getPerformer()
- Returns:
performer
(The individual who was responsible for giving the medication to the patient.)
-
setPerformer
public MedicationAdministration setPerformer(List<MedicationAdministration.MedicationAdministrationPerformerComponent> thePerformer)
- Returns:
- Returns a reference to
this
for 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
-
getNotGivenElement
public BooleanType getNotGivenElement()
- Returns:
notGiven
(Set this to true if the record is saying that the medication was NOT administered.). This is the underlying object with id, value and extensions. The accessor "getNotGiven" gives direct access to the value
-
hasNotGivenElement
public boolean hasNotGivenElement()
-
hasNotGiven
public boolean hasNotGiven()
-
setNotGivenElement
public MedicationAdministration setNotGivenElement(BooleanType value)
- Parameters:
value
-notGiven
(Set this to true if the record is saying that the medication was NOT administered.). This is the underlying object with id, value and extensions. The accessor "getNotGiven" gives direct access to the value
-
getNotGiven
public boolean getNotGiven()
- Returns:
- Set this to true if the record is saying that the medication was NOT administered.
-
setNotGiven
public MedicationAdministration setNotGiven(boolean value)
- Parameters:
value
- Set this to true if the record is saying that the medication was NOT administered.
-
getReasonNotGiven
public List<CodeableConcept> getReasonNotGiven()
- Returns:
reasonNotGiven
(A code indicating why the administration was not performed.)
-
setReasonNotGiven
public MedicationAdministration setReasonNotGiven(List<CodeableConcept> theReasonNotGiven)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReasonNotGiven
public boolean hasReasonNotGiven()
-
addReasonNotGiven
public CodeableConcept addReasonNotGiven()
-
addReasonNotGiven
public MedicationAdministration addReasonNotGiven(CodeableConcept t)
-
getReasonNotGivenFirstRep
public CodeableConcept getReasonNotGivenFirstRep()
- Returns:
- The first repetition of repeating field
reasonNotGiven
, 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
this
for 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
this
for 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
-
getPrescription
public Reference getPrescription()
- Returns:
prescription
(The original request, instruction or authority to perform the administration.)
-
hasPrescription
public boolean hasPrescription()
-
setPrescription
public MedicationAdministration setPrescription(Reference value)
- Parameters:
value
-prescription
(The original request, instruction or authority to perform the administration.)
-
getPrescriptionTarget
public MedicationRequest getPrescriptionTarget()
- Returns:
prescription
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.)
-
setPrescriptionTarget
public MedicationAdministration setPrescriptionTarget(MedicationRequest value)
- Parameters:
value
-prescription
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
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
this
for 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
this
for 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
this
for 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:
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
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- 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
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
public MedicationAdministration copy()
- Specified by:
copy
in classDomainResource
-
typedCopy
protected MedicationAdministration typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceType
in classResource
-
-