
Class MedicationAdministration
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IAnyResource
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
,org.hl7.fhir.instance.model.api.IBaseResource
,org.hl7.fhir.instance.model.api.IDomainResource
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
static enum
static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionA plan that is fulfilled in whole or in part by this MedicationAdministration.protected List<CodeableConcept>
The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication).static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for codestatic final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for dateThe device used in administering the medication to the patient.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for deviceDescribes the medication dosage information details e.g.protected Reference
The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for encounterA summary of the events of interest that have occurred, such as when the administration was verified.protected List<Identifier>
Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected List<CanonicalType>
A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationAdministration.protected CodeableReference
Identifies the medication that was administered.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for medicationprotected List<Annotation>
Extra information about the medication administration that is not conveyed by the other attributes.protected DataType
A specific date/time or interval of time during which the administration took place (or did not take place).A larger event of which this particular event is a component or step.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientIndicates who or what performed the medication administration and how they were involved.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for performerprotected List<CodeableReference>
A code, Condition or observation that supports why the medication was administered.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for reason-givenstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for reason-given-codestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for reason-not-givenprotected DateTimeType
The date the occurrence of the MedicationAdministration was first captured in the record - potentially significantly after the occurrence of the event.protected Reference
The original request, instruction or authority to perform the administration.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for requeststatic final String
Search parameter: codestatic final String
Search parameter: datestatic final String
Search parameter: devicestatic final String
Search parameter: encounterstatic final String
Search parameter: identifierstatic final String
Search parameter: medicationstatic final String
Search parameter: patientstatic final String
Search parameter: performerstatic final String
Search parameter: reason-givenstatic final String
Search parameter: reason-given-codestatic final String
Search parameter: reason-not-givenstatic final String
Search parameter: requeststatic final String
Search parameter: statusstatic final String
Search parameter: subjectWill generally be set to show that the administration has been completed.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected List<CodeableConcept>
A code indicating why the administration was not performed.protected Reference
The person or animal or group receiving the medication.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectAdditional information (for example, patient height and weight) that supports the administration of the medication.Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorsConstructorDescriptionConstructorMedicationAdministration
(MedicationAdministration.MedicationAdministrationStatusCodes status, CodeableReference medication, Reference subject, DataType occurence) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddInstantiatesCanonical
(String value) addInstantiatesUri
(String value) addNote()
copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasInstantiatesCanonical
(String value) boolean
boolean
hasInstantiatesUri
(String value) boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setBasedOn
(List<Reference> theBasedOn) setCategory
(List<CodeableConcept> theCategory) setEncounter
(Reference value) setEventHistory
(List<Reference> theEventHistory) setIdentifier
(List<Identifier> theIdentifier) setInstantiatesCanonical
(List<CanonicalType> theInstantiatesCanonical) setInstantiatesUri
(List<UriType> theInstantiatesUri) setMedication
(CodeableReference value) setNote
(List<Annotation> theNote) setOccurence
(DataType value) setPerformer
(List<MedicationAdministration.MedicationAdministrationPerformerComponent> thePerformer) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setReason
(List<CodeableReference> theReason) setRecorded
(Date value) setRecordedElement
(DateTimeType value) setRequest
(Reference value) setStatusReason
(List<CodeableConcept> theStatusReason) setSubject
(Reference value) setSupportingInformation
(List<Reference> theSupportingInformation) protected MedicationAdministration
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r5.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.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId
-
Field Details
-
identifier
Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. -
instantiatesCanonical
A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event. -
instantiatesUri
The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationAdministration. -
basedOn
A plan that is fulfilled in whole or in part by this MedicationAdministration. -
partOf
A larger event of which this particular event is a component or step. -
status
Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way. -
statusReason
A code indicating why the administration was not performed. -
category
The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication). -
medication
Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. -
subject
The person or animal or group receiving the medication. -
encounter
The visit, admission, or other contact between patient and health care provider during which the medication administration was performed. -
supportingInformation
Additional information (for example, patient height and weight) that supports the administration of the medication. This attribute can be used to provide documentation of specific characteristics of the patient present at the time of administration. For example, if the dose says "give "x" if the heartrate exceeds "y"", then the heart rate can be included using this attribute. -
occurence
A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate. -
recorded
The date the occurrence of the MedicationAdministration was first captured in the record - potentially significantly after the occurrence of the event. -
performer
Indicates who or what performed the medication administration and how they were involved. -
reason
A code, Condition or observation that supports why the medication was administered. -
request
The original request, instruction or authority to perform the administration. -
device
The device used in administering the medication to the patient. For example, a particular infusion pump. -
note
Extra information about the medication administration that is not conveyed by the other attributes. -
dosage
Describes the medication dosage information details e.g. dose, rate, site, route, etc. -
eventHistory
A summary of the events of interest that have occurred, such as when the administration was verified. -
SP_DEVICE
Search parameter: deviceDescription: Return administrations with this administration device identity
Type: reference
Path: MedicationAdministration.device
- See Also:
-
DEVICE
Fluent Client search parameter constant for deviceDescription: Return administrations with this administration device identity
Type: reference
Path: MedicationAdministration.device
-
INCLUDE_DEVICE
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:device". -
SP_PERFORMER
Search parameter: performerDescription: The identity of the individual who administered the medication
Type: reference
Path: MedicationAdministration.performer.actor
- See Also:
-
PERFORMER
Fluent Client search parameter constant for performerDescription: The identity of the individual who administered the medication
Type: reference
Path: MedicationAdministration.performer.actor
-
INCLUDE_PERFORMER
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:performer". -
SP_REASON_GIVEN_CODE
Search parameter: reason-given-codeDescription: Reasons for administering the medication
Type: token
Path: MedicationAdministration.reason.concept
- See Also:
-
REASON_GIVEN_CODE
Fluent Client search parameter constant for reason-given-codeDescription: Reasons for administering the medication
Type: token
Path: MedicationAdministration.reason.concept
-
SP_REASON_GIVEN
Search parameter: reason-givenDescription: Reference to a resource (by instance)
Type: reference
Path: MedicationAdministration.reason.reference
- See Also:
-
REASON_GIVEN
Fluent Client search parameter constant for reason-givenDescription: Reference to a resource (by instance)
Type: reference
Path: MedicationAdministration.reason.reference
-
INCLUDE_REASON_GIVEN
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:reason-given". -
SP_REASON_NOT_GIVEN
Search parameter: reason-not-givenDescription: Reasons for not administering the medication
Type: token
Path: MedicationAdministration.statusReason
- See Also:
-
REASON_NOT_GIVEN
Fluent Client search parameter constant for reason-not-givenDescription: Reasons for not administering the medication
Type: token
Path: MedicationAdministration.statusReason
-
SP_REQUEST
Search parameter: requestDescription: The identity of a request to list administrations from
Type: reference
Path: MedicationAdministration.request
- See Also:
-
REQUEST
Fluent Client search parameter constant for requestDescription: The identity of a request to list administrations from
Type: reference
Path: MedicationAdministration.request
-
INCLUDE_REQUEST
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:request". -
SP_SUBJECT
Search parameter: subjectDescription: The identity of the individual or group to list administrations for
Type: reference
Path: MedicationAdministration.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: The identity of the individual or group to list administrations for
Type: reference
Path: MedicationAdministration.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:subject". -
SP_CODE
Search parameter: codeDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [Condition](condition.html): Code for the condition [DeviceRequest](devicerequest.html): Code for what is being requested/ordered [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result [FamilyMemberHistory](familymemberhistory.html): A search by a condition code [List](list.html): What the purpose of this list is [Medication](medication.html): Returns medications for a specific code [MedicationAdministration](medicationadministration.html): Return administrations of this medication code [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code [MedicationUsage](medicationusage.html): Return statements of this medication code [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure [ServiceRequest](servicerequest.html): What is being requested/ordered
Type: token
Path: AllergyIntolerance.code | AllergyIntolerance.reaction.substance | Condition.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationUsage.medication.concept | Observation.code | Procedure.code | ServiceRequest.code
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [Condition](condition.html): Code for the condition [DeviceRequest](devicerequest.html): Code for what is being requested/ordered [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result [FamilyMemberHistory](familymemberhistory.html): A search by a condition code [List](list.html): What the purpose of this list is [Medication](medication.html): Returns medications for a specific code [MedicationAdministration](medicationadministration.html): Return administrations of this medication code [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code [MedicationUsage](medicationusage.html): Return statements of this medication code [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure [ServiceRequest](servicerequest.html): What is being requested/ordered
Type: token
Path: AllergyIntolerance.code | AllergyIntolerance.reaction.substance | Condition.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationUsage.medication.concept | Observation.code | Procedure.code | ServiceRequest.code
-
SP_IDENTIFIER
Search parameter: identifierDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.content.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.content.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier
-
SP_PATIENT
Search parameter: patientDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.patient | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | VisionPrescription.patient
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.patient | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | VisionPrescription.patient
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:patient". -
SP_DATE
Search parameter: dateDescription: Multiple Resources: [MedicationAdministration](medicationadministration.html): Date administration happened (or did not happen)
Type: date
Path: MedicationAdministration.occurence
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: Multiple Resources: [MedicationAdministration](medicationadministration.html): Date administration happened (or did not happen)
Type: date
Path: MedicationAdministration.occurence
-
SP_ENCOUNTER
Search parameter: encounterDescription: Multiple Resources: [MedicationAdministration](medicationadministration.html): Return administrations that share this encounter [MedicationRequest](medicationrequest.html): Return prescriptions with this encounter identifier
Type: reference
Path: MedicationAdministration.encounter | MedicationRequest.encounter
- See Also:
-
ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Multiple Resources: [MedicationAdministration](medicationadministration.html): Return administrations that share this encounter [MedicationRequest](medicationrequest.html): Return prescriptions with this encounter identifier
Type: reference
Path: MedicationAdministration.encounter | MedicationRequest.encounter
-
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:encounter". -
SP_MEDICATION
Search parameter: medicationDescription: Multiple Resources: [MedicationAdministration](medicationadministration.html): Return administrations of this medication reference [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference [MedicationUsage](medicationusage.html): Return statements of this medication reference
Type: reference
Path: MedicationAdministration.medication.reference | MedicationDispense.medication.reference | MedicationRequest.medication.reference | MedicationUsage.medication.reference
- See Also:
-
MEDICATION
Fluent Client search parameter constant for medicationDescription: Multiple Resources: [MedicationAdministration](medicationadministration.html): Return administrations of this medication reference [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference [MedicationUsage](medicationusage.html): Return statements of this medication reference
Type: reference
Path: MedicationAdministration.medication.reference | MedicationDispense.medication.reference | MedicationRequest.medication.reference | MedicationUsage.medication.reference
-
INCLUDE_MEDICATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationAdministration:medication". -
SP_STATUS
Search parameter: statusDescription: Multiple Resources: [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified) [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status [MedicationRequest](medicationrequest.html): Status of the prescription [MedicationUsage](medicationusage.html): Return statements that match the given status
Type: token
Path: MedicationAdministration.status | MedicationDispense.status | MedicationRequest.status | MedicationUsage.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: Multiple Resources: [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified) [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status [MedicationRequest](medicationrequest.html): Status of the prescription [MedicationUsage](medicationusage.html): Return statements that match the given status
Type: token
Path: MedicationAdministration.status | MedicationDispense.status | MedicationRequest.status | MedicationUsage.status
-
-
Constructor Details
-
MedicationAdministration
public MedicationAdministration()Constructor -
MedicationAdministration
public MedicationAdministration(MedicationAdministration.MedicationAdministrationStatusCodes status, CodeableReference medication, Reference subject, DataType occurence) Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist {3}
-
getInstantiatesCanonical
- Returns:
instantiatesCanonical
(A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.)
-
setInstantiatesCanonical
public MedicationAdministration setInstantiatesCanonical(List<CanonicalType> theInstantiatesCanonical) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasInstantiatesCanonical
-
addInstantiatesCanonicalElement
- Returns:
instantiatesCanonical
(A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.)
-
addInstantiatesCanonical
- Parameters:
value
-instantiatesCanonical
(A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.)
-
hasInstantiatesCanonical
- Parameters:
value
-instantiatesCanonical
(A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.)
-
getInstantiatesUri
- Returns:
instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationAdministration.)
-
setInstantiatesUri
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInstantiatesUri
-
addInstantiatesUriElement
- Returns:
instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationAdministration.)
-
addInstantiatesUri
- Parameters:
value
-instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationAdministration.)
-
hasInstantiatesUri
- Parameters:
value
-instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationAdministration.)
-
getBasedOn
- Returns:
basedOn
(A plan that is fulfilled in whole or in part by this MedicationAdministration.)
-
setBasedOn
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasBasedOn
-
addBasedOn
-
addBasedOn
-
getBasedOnFirstRep
- Returns:
- The first repetition of repeating field
basedOn
, creating it if it does not already exist {3}
-
getPartOf
- Returns:
partOf
(A larger event of which this particular event is a component or step.)
-
setPartOf
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPartOf
-
addPartOf
-
addPartOf
-
getPartOfFirstRep
- Returns:
- The first repetition of repeating field
partOf
, creating it if it does not already exist {3}
-
getStatusElement
- Returns:
status
(Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
-
hasStatus
-
setStatusElement
public MedicationAdministration setStatusElement(Enumeration<MedicationAdministration.MedicationAdministrationStatusCodes> value) - Parameters:
value
-status
(Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
-
setStatus
public MedicationAdministration setStatus(MedicationAdministration.MedicationAdministrationStatusCodes value) - Parameters:
value
- Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
-
getStatusReason
- Returns:
statusReason
(A code indicating why the administration was not performed.)
-
setStatusReason
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasStatusReason
-
addStatusReason
-
addStatusReason
-
getStatusReasonFirstRep
- Returns:
- The first repetition of repeating field
statusReason
, creating it if it does not already exist {3}
-
getCategory
- Returns:
category
(The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication).)
-
setCategory
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCategory
-
addCategory
-
addCategory
-
getCategoryFirstRep
- Returns:
- The first repetition of repeating field
category
, creating it if it does not already exist {3}
-
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.)
-
hasMedication
-
setMedication
- Parameters:
value
-medication
(Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.)
-
getSubject
- Returns:
subject
(The person or animal or group receiving the medication.)
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(The person or animal or group receiving the medication.)
-
getEncounter
- Returns:
encounter
(The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.)
-
hasEncounter
-
setEncounter
- Parameters:
value
-encounter
(The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.)
-
getSupportingInformation
- Returns:
supportingInformation
(Additional information (for example, patient height and weight) that supports the administration of the medication. This attribute can be used to provide documentation of specific characteristics of the patient present at the time of administration. For example, if the dose says "give "x" if the heartrate exceeds "y"", then the heart rate can be included using this attribute.)
-
setSupportingInformation
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSupportingInformation
-
addSupportingInformation
-
addSupportingInformation
-
getSupportingInformationFirstRep
- Returns:
- The first repetition of repeating field
supportingInformation
, creating it if it does not already exist {3}
-
getOccurence
- Returns:
occurence
(A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.)
-
getOccurenceDateTimeType
- Returns:
occurence
(A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurenceDateTimeType
-
getOccurencePeriod
- Returns:
occurence
(A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurencePeriod
-
hasOccurence
-
setOccurence
- Parameters:
value
-occurence
(A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.)
-
getRecordedElement
- Returns:
recorded
(The date the occurrence of the MedicationAdministration was first captured in the record - potentially significantly after the occurrence of the event.). This is the underlying object with id, value and extensions. The accessor "getRecorded" gives direct access to the value
-
hasRecordedElement
-
hasRecorded
-
setRecordedElement
- Parameters:
value
-recorded
(The date the occurrence of the MedicationAdministration was first captured in the record - potentially significantly after the occurrence of the event.). This is the underlying object with id, value and extensions. The accessor "getRecorded" gives direct access to the value
-
getRecorded
- Returns:
- The date the occurrence of the MedicationAdministration was first captured in the record - potentially significantly after the occurrence of the event.
-
setRecorded
- Parameters:
value
- The date the occurrence of the MedicationAdministration was first captured in the record - potentially significantly after the occurrence of the event.
-
getPerformer
- Returns:
performer
(Indicates who or what performed the medication administration and how they were involved.)
-
setPerformer
public MedicationAdministration setPerformer(List<MedicationAdministration.MedicationAdministrationPerformerComponent> thePerformer) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasPerformer
-
addPerformer
-
addPerformer
-
getPerformerFirstRep
- Returns:
- The first repetition of repeating field
performer
, creating it if it does not already exist {3}
-
getReason
- Returns:
reason
(A code, Condition or observation that supports why the medication was administered.)
-
setReason
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReason
-
addReason
-
addReason
-
getReasonFirstRep
- Returns:
- The first repetition of repeating field
reason
, creating it if it does not already exist {3}
-
getRequest
- Returns:
request
(The original request, instruction or authority to perform the administration.)
-
hasRequest
-
setRequest
- Parameters:
value
-request
(The original request, instruction or authority to perform the administration.)
-
getDevice
- Returns:
device
(The device used in administering the medication to the patient. For example, a particular infusion pump.)
-
setDevice
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDevice
-
addDevice
-
addDevice
-
getDeviceFirstRep
- Returns:
- The first repetition of repeating field
device
, creating it if it does not already exist {3}
-
getNote
- Returns:
note
(Extra information about the medication administration that is not conveyed by the other attributes.)
-
setNote
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
-
addNote
-
addNote
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist {3}
-
getDosage
- Returns:
dosage
(Describes the medication dosage information details e.g. dose, rate, site, route, etc.)
-
hasDosage
-
setDosage
public MedicationAdministration setDosage(MedicationAdministration.MedicationAdministrationDosageComponent value) - Parameters:
value
-dosage
(Describes the medication dosage information details e.g. dose, rate, site, route, etc.)
-
getEventHistory
- Returns:
eventHistory
(A summary of the events of interest that have occurred, such as when the administration was verified.)
-
setEventHistory
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEventHistory
-
addEventHistory
-
addEventHistory
-
getEventHistoryFirstRep
- Returns:
- The first repetition of repeating field
eventHistory
, creating it if it does not already exist {3}
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-