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

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
  • Field Details

    • 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

      A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this event.
    • 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

      The actual objects that are the target of the reference (A larger event of which this particular event is a component or step.)
    • status

      Will generally be set to show that the administration has been completed. For some long running administrations such as infusions it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
    • 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.
    • subject

      protected Reference subject
      The person or animal or group receiving the medication.
    • subjectTarget

      The actual object that is the target of the reference (The person or animal or group receiving the medication.)
    • context

      protected Reference context
      The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.
    • 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

      Additional information (for example, patient height and weight) that supports the administration of the medication.
    • supportingInformationTarget

      The actual objects that are the target of the reference (Additional information (for example, patient height and weight) that supports the administration of the medication.)
    • effective

      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

      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

      A code indicating why the administration was not performed.
    • reasonCode

      A code indicating why the medication was given.
    • reasonReference

      Condition or observation that supports why the medication was administered.
    • reasonReferenceTarget

      The actual objects that are the target of the reference (Condition or observation that supports why the medication was administered.)
    • prescription

      The original request, instruction or authority to perform the administration.
    • 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

      Describes the medication dosage information details e.g. dose, rate, site, route, etc.
    • eventHistory

      A summary of the events of interest that have occurred, such as when the administration was verified.
    • eventHistoryTarget

      The actual objects that are the target of the reference (A summary of the events of interest that have occurred, such as when the administration was verified.)
    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: 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 identifier

      Description: Return administrations with this external identifier
      Type: token
      Path: MedicationAdministration.identifier

    • SP_CODE

      public static final String SP_CODE
      Search parameter: code

      Description: 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 code

      Description: Return administrations of this medication code
      Type: token
      Path: MedicationAdministration.medicationCodeableConcept

    • SP_PERFORMER

      public static final String SP_PERFORMER
      Search parameter: performer

      Description: 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 performer

      Description: 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: subject

      Description: 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 subject

      Description: 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-given

      Description: 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-given

      Description: Administrations that were not made
      Type: token
      Path: MedicationAdministration.notGiven

    • SP_MEDICATION

      public static final String SP_MEDICATION
      Search parameter: medication

      Description: 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 medication

      Description: 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-given

      Description: 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-given

      Description: Reasons for administering the medication
      Type: token
      Path: MedicationAdministration.reasonCode

    • SP_PRESCRIPTION

      public static final String SP_PRESCRIPTION
      Search parameter: prescription

      Description: 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 prescription

      Description: 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: patient

      Description: 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 patient

      Description: 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-time

      Description: 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-time

      Description: Date administration happened (or did not happen)
      Type: date
      Path: MedicationAdministration.effective[x]

    • SP_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: 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 context

      Description: 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-given

      Description: 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-given

      Description: Reasons for not administering the medication
      Type: token
      Path: MedicationAdministration.reasonNotGiven

    • SP_DEVICE

      public static final String SP_DEVICE
      Search parameter: device

      Description: 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 device

      Description: 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: status

      Description: 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 status

      Description: MedicationAdministration event status (for example one of active/paused/completed/nullified)
      Type: token
      Path: MedicationAdministration.status

  • Constructor Details

  • Method Details