Class MedicationStatement

  • 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 MedicationStatement
    extends DomainResource
    A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now, or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.
    See Also:
    Serialized Form
    • 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.
      • basedOn

        protected List<Reference> basedOn
        A plan, proposal or order that is fulfilled in whole or in part by this event.
      • basedOnTarget

        protected List<Resource> basedOnTarget
        The actual objects that are the target of the reference (A plan, proposal or order that is fulfilled 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.)
      • context

        protected Reference context
        The encounter or episode of care that establishes the context for this MedicationStatement.
      • contextTarget

        protected Resource contextTarget
        The actual object that is the target of the reference (The encounter or episode of care that establishes the context for this MedicationStatement.)
      • category

        protected CodeableConcept category
        Indicates where type of medication statement and where the medication is expected to be consumed or administered.
      • medication

        protected Type medication
        Identifies the medication being 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.
      • effective

        protected Type effective
        The interval of time during which it is being asserted that the patient was taking the medication (or was not taking, when the wasNotGiven element is true).
      • dateAsserted

        protected DateTimeType dateAsserted
        The date when the medication statement was asserted by the information source.
      • informationSource

        protected Reference informationSource
        The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g Claim or MedicationRequest.
      • informationSourceTarget

        protected Resource informationSourceTarget
        The actual object that is the target of the reference (The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g Claim or MedicationRequest.)
      • subject

        protected Reference subject
        The person, animal or group who is/was taking the medication.
      • subjectTarget

        protected Resource subjectTarget
        The actual object that is the target of the reference (The person, animal or group who is/was taking the medication.)
      • derivedFrom

        protected List<Reference> derivedFrom
        Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.
      • derivedFromTarget

        protected List<Resource> derivedFromTarget
        The actual objects that are the target of the reference (Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.)
      • reasonReferenceTarget

        protected List<Resource> reasonReferenceTarget
        The actual objects that are the target of the reference (Condition or observation that supports why the medication is being/was taken.)
      • note

        protected List<Annotation> note
        Provides extra information about the medication statement that is not conveyed by the other attributes.
      • dosage

        protected List<Dosage> dosage
        Indicates how the medication is/was or should be taken by the patient.
      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: Return statements with this external identifier
        Type: token
        Path: MedicationStatement.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 statements with this external identifier
        Type: token
        Path: MedicationStatement.identifier

      • SP_EFFECTIVE

        public static final String SP_EFFECTIVE
        Search parameter: effective

        Description: Date when patient was taking (or not taking) the medication
        Type: date
        Path: MedicationStatement.effective[x]

        See Also:
        Constant Field Values
      • EFFECTIVE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam EFFECTIVE
        Fluent Client search parameter constant for effective

        Description: Date when patient was taking (or not taking) the medication
        Type: date
        Path: MedicationStatement.effective[x]

      • SP_CODE

        public static final String SP_CODE
        Search parameter: code

        Description: Return statements of this medication code
        Type: token
        Path: MedicationStatement.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 statements of this medication code
        Type: token
        Path: MedicationStatement.medicationCodeableConcept

      • SP_SUBJECT

        public static final String SP_SUBJECT
        Search parameter: subject

        Description: The identity of a patient, animal or group to list statements for
        Type: reference
        Path: MedicationStatement.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 identity of a patient, animal or group to list statements for
        Type: reference
        Path: MedicationStatement.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 "MedicationStatement:subject".
      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: Returns statements for a specific patient.
        Type: reference
        Path: MedicationStatement.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: Returns statements for a specific patient.
        Type: reference
        Path: MedicationStatement.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 "MedicationStatement:patient".
      • SP_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: context

        Description: Returns statements for a specific context (episode or episode of Care).
        Type: reference
        Path: MedicationStatement.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: Returns statements for a specific context (episode or episode of Care).
        Type: reference
        Path: MedicationStatement.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 "MedicationStatement:context".
      • SP_MEDICATION

        public static final String SP_MEDICATION
        Search parameter: medication

        Description: Return statements of this medication reference
        Type: reference
        Path: MedicationStatement.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 statements of this medication reference
        Type: reference
        Path: MedicationStatement.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 "MedicationStatement:medication".
      • SP_PART_OF

        public static final String SP_PART_OF
        Search parameter: part-of

        Description: Returns statements that are part of another event.
        Type: reference
        Path: MedicationStatement.partOf

        See Also:
        Constant Field Values
      • PART_OF

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PART_OF
        Fluent Client search parameter constant for part-of

        Description: Returns statements that are part of another event.
        Type: reference
        Path: MedicationStatement.partOf

      • INCLUDE_PART_OF

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PART_OF
        Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationStatement:part-of".
      • SP_SOURCE

        public static final String SP_SOURCE
        Search parameter: source

        Description: Who or where the information in the statement came from
        Type: reference
        Path: MedicationStatement.informationSource

        See Also:
        Constant Field Values
      • SOURCE

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SOURCE
        Fluent Client search parameter constant for source

        Description: Who or where the information in the statement came from
        Type: reference
        Path: MedicationStatement.informationSource

      • INCLUDE_SOURCE

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SOURCE
        Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationStatement:source".
      • SP_CATEGORY

        public static final String SP_CATEGORY
        Search parameter: category

        Description: Returns statements of this category of medicationstatement
        Type: token
        Path: MedicationStatement.category

        See Also:
        Constant Field Values
      • CATEGORY

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
        Fluent Client search parameter constant for category

        Description: Returns statements of this category of medicationstatement
        Type: token
        Path: MedicationStatement.category

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: Return statements that match the given status
        Type: token
        Path: MedicationStatement.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: Return statements that match the given status
        Type: token
        Path: MedicationStatement.status