Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_MedicationStatement_R3 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-MedicationStatement resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. MedicationStatement
Definition

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.

ShortRecord of medication being taken by a patient
Comments

When interpreting a medicationStatement, the value of the status and NotTaken needed to be considered: MedicationStatement.status + MedicationStatement.wasNotTaken Status=Active + NotTaken=T = Not currently taking Status=Completed + NotTaken=T = Not taken in the past Status=Intended + NotTaken=T = No intention of taking Status=Active + NotTaken=F = Taking, but not as prescribed Status=Active + NotTaken=F = Taking Status=Intended +NotTaken= F = Will be taking (not started) Status=Completed + NotTaken=F = Taken in past Status=In Error + NotTaken=N/A = In Error.

Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
mst-1: Reason not taken is only permitted if Taken is No (reasonNotTaken.exists().not() or (taken = 'n'))
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
mst-1: Reason not taken is only permitted if Taken is No (reasonNotTaken.exists().not() or (taken = 'n'))
2. MedicationStatement.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. MedicationStatement.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional Content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on MedicationStatement.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. MedicationStatement.extension:effective
    Slice Nameeffective
    Definition

    R5: MedicationStatement.effective[x] additional types (Timing)

    ShortR5: The date/time or interval when the medication is/was/will be taken additional types
    Comments

    Element MedicationStatement.effective[x] is mapped to FHIR STU3 element MedicationStatement.effective[x] as SourceIsBroaderThanTarget. The mappings for MedicationStatement.effective[x] do not cover the following types: Timing. The target context MedicationStatement.effective[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element MedicationStatement. This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken and is expected to continue indefinitely at the time the usage is recorded, the "end" date will be omitted. If the end date is known, then it is included as the "end date". The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: The date/time or interval when the medication is/was/will be taken additional types) (Extension Type: Timing)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. MedicationStatement.extension:reason
    Slice Namereason
    Definition

    R5: MedicationStatement.reason additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/Condition), CodeableReference(http://hl7.org/fhir/StructureDefinition/Observation), CodeableReference(http://hl7.org/fhir/StructureDefinition/DiagnosticReport))

    ShortR5: Reason for why the medication is being/was taken additional types
    Comments

    Element MedicationStatement.reason is mapped to FHIR STU3 element MedicationStatement.reasonNotTaken as SourceIsBroaderThanTarget. Element MedicationStatement.reason is mapped to FHIR STU3 element MedicationStatement.reasonCode as SourceIsBroaderThanTarget. Element MedicationStatement.reason is mapped to FHIR STU3 element MedicationStatement.reasonReference as SourceIsBroaderThanTarget. The mappings for MedicationStatement.reason do not cover the following types: CodeableReference. This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference.

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Reason for why the medication is being/was taken additional types) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. MedicationStatement.extension:relatedClinicalInformation
    Slice NamerelatedClinicalInformation
    Definition

    R5: MedicationStatement.relatedClinicalInformation (new:Reference(Observation,Condition))

    ShortR5: Link to information relevant to the usage of a medication (new)
    Comments

    Element MedicationStatement.relatedClinicalInformation has a context of MedicationStatement based on following the parent source element upwards and mapping to MedicationStatement. Element MedicationStatement.relatedClinicalInformation has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Link to information relevant to the usage of a medication (new)) (Extension Type: Reference(Cross-version Profile for R5.Observation for use in FHIR STU3, Observation, Cross-version Profile for R5.Condition for use in FHIR STU3, Condition))
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. MedicationStatement.extension:renderedDosageInstruction
    Slice NamerenderedDosageInstruction
    Definition

    R5: MedicationStatement.renderedDosageInstruction (new:markdown)

    ShortR5: Full representation of the dosage instructions (new)
    Comments

    Element MedicationStatement.renderedDosageInstruction has a context of MedicationStatement based on following the parent source element upwards and mapping to MedicationStatement. Element MedicationStatement.renderedDosageInstruction has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Full representation of the dosage instructions (new)) (Extension Type: markdown)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. MedicationStatement.extension:adherence
    Slice Nameadherence
    Definition

    R5: MedicationStatement.adherence (new:BackboneElement)

    ShortR5: Indicates whether the medication is or is not being consumed or administered (new)
    Comments

    Element MedicationStatement.adherence has a context of MedicationStatement based on following the parent source element upwards and mapping to MedicationStatement. Element MedicationStatement.adherence has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). This element can be used to indicate whether a patient is following a course of treatment as instructed/prescribed or whether they are taking medications of their own volition. It can also be used to indicate that a patient is not taking a medication, either because they were told not to or because they decided on their own.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Indicates whether the medication is or is not being consumed or administered (new)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    16. MedicationStatement.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Alternate Namesextensions, user content
    18. MedicationStatement.status
    Definition

    A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally this will be active or completed.

    Shortactive | completed | entered-in-error | intended | stopped | on-hold
    Comments

    MedicationStatement is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for MedicationStatement.status contains codes that assert the status of the use of the medication by the patient (for example, stopped or on hold) as well as codes that assert the status of the medication statement itself (for example, entered in error).

    This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

    Control1..1
    BindingThe codes SHALL be taken from MedicationStatementStatushttp://hl7.org/fhir/ValueSet/medication-statement-status|3.0.2
    (required to http://hl7.org/fhir/ValueSet/medication-statement-status|3.0.2)

    A coded concept indicating the current status of a MedicationStatement.

    Typecode
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    20. MedicationStatement.status.extension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortExtensionAdditional Content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Alternate Namesextensions, user content
    SlicingThis element introduces a set of slices on MedicationStatement.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 22. MedicationStatement.status.extension:status
      Slice Namestatus
      Definition

      R5: MedicationStatement.status additional codes

      ShortR5: recorded | entered-in-error | draft additional codes
      Comments

      Element MedicationStatement.status is mapped to FHIR STU3 element MedicationStatement.status as RelatedTo. The mappings for MedicationStatement.status do not allow expression of the necessary codes, per the bindings on the source and target. The target context MedicationStatement.status is a modifier element, so this extension does not need to be defined as a modifier. This status concerns just the recording of the medication statement. MedicationStatement.adherence should be used for indicating a patient's adherence to the information in this resource. Note, the statuses are different than in previous releases for MedicationStatement or MedicationStatement.

      This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(R5: recorded | entered-in-error | draft additional codes) (Extension Type: code)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      24. MedicationStatement.medication[x]
      Definition

      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.

      ShortWhat medication was taken
      Comments

      If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended.  For example if you require form or lot number, then you must reference the Medication resource. .

      Control1..1
      BindingFor example codes, see SNOMED CT Medication Codeshttp://hl7.org/fhir/ValueSet/medication-codes|3.0.2
      (example to http://hl7.org/fhir/ValueSet/medication-codes|3.0.2)

      A coded concept identifying the substance or product being taken.

      TypeChoice of: CodeableConcept, Reference(Medication)
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Summarytrue
      26. MedicationStatement.subject
      Definition

      The person, animal or group who is/was taking the medication.

      ShortWho is/was taking the medication
      Control1..1
      TypeReference(Patient, Group)
      Summarytrue
      28. MedicationStatement.subject.extension
      Definition

      An Extension


      May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortExtensionAdditional Content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Alternate Namesextensions, user content
      SlicingThis element introduces a set of slices on MedicationStatement.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 30. MedicationStatement.subject.extension:subject
        Slice Namesubject
        Definition

        R5: MedicationStatement.subject additional types from child elements (display, identifier, reference, type)

        ShortR5: subject additional types
        Comments

        Element MedicationStatement.subject is mapped to FHIR STU3 element MedicationStatement.subject as SourceIsBroaderThanTarget. The mappings for MedicationStatement.subject do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element MedicationStatement.subject with unmapped reference targets: Group, Patient.

        Control0..1
        TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
        32. MedicationStatement.taken
        Definition

        Indicator of the certainty of whether the medication was taken by the patient.

        Shorty | n | unk | na
        Comments

        This element is labeled as a modifier because it indicates that the medication was not taken.

        Control1..1
        BindingThe codes SHALL be taken from MedicationStatementTakenhttp://hl7.org/fhir/ValueSet/medication-statement-taken|3.0.2
        (required to http://hl7.org/fhir/ValueSet/medication-statement-taken|3.0.2)

        A coded concept identifying level of certainty if patient has taken or has not taken the medication

        Typecode
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue

        Guidance on how to interpret the contents of this table can be foundhere

        0. MedicationStatement
        2. MedicationStatement.extension
        Control0..*
        SlicingThis element introduces a set of slices on MedicationStatement.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 4. MedicationStatement.extension:effective
          Slice Nameeffective
          Definition

          R5: MedicationStatement.effective[x] additional types (Timing)

          ShortR5: The date/time or interval when the medication is/was/will be taken additional types
          Comments

          Element MedicationStatement.effective[x] is mapped to FHIR STU3 element MedicationStatement.effective[x] as SourceIsBroaderThanTarget. The mappings for MedicationStatement.effective[x] do not cover the following types: Timing. The target context MedicationStatement.effective[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element MedicationStatement. This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken and is expected to continue indefinitely at the time the usage is recorded, the "end" date will be omitted. If the end date is known, then it is included as the "end date". The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text.

          Control0..1
          TypeExtension(R5: The date/time or interval when the medication is/was/will be taken additional types) (Extension Type: Timing)
          6. MedicationStatement.extension:reason
          Slice Namereason
          Definition

          R5: MedicationStatement.reason additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/Condition), CodeableReference(http://hl7.org/fhir/StructureDefinition/Observation), CodeableReference(http://hl7.org/fhir/StructureDefinition/DiagnosticReport))

          ShortR5: Reason for why the medication is being/was taken additional types
          Comments

          Element MedicationStatement.reason is mapped to FHIR STU3 element MedicationStatement.reasonNotTaken as SourceIsBroaderThanTarget. Element MedicationStatement.reason is mapped to FHIR STU3 element MedicationStatement.reasonCode as SourceIsBroaderThanTarget. Element MedicationStatement.reason is mapped to FHIR STU3 element MedicationStatement.reasonReference as SourceIsBroaderThanTarget. The mappings for MedicationStatement.reason do not cover the following types: CodeableReference. This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference.

          Control0..*
          TypeExtension(R5: Reason for why the medication is being/was taken additional types) (Complex Extension)
          8. MedicationStatement.extension:relatedClinicalInformation
          Slice NamerelatedClinicalInformation
          Definition

          R5: MedicationStatement.relatedClinicalInformation (new:Reference(Observation,Condition))

          ShortR5: Link to information relevant to the usage of a medication (new)
          Comments

          Element MedicationStatement.relatedClinicalInformation has a context of MedicationStatement based on following the parent source element upwards and mapping to MedicationStatement. Element MedicationStatement.relatedClinicalInformation has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

          Control0..*
          TypeExtension(R5: Link to information relevant to the usage of a medication (new)) (Extension Type: Reference(Cross-version Profile for R5.Observation for use in FHIR STU3, Observation, Cross-version Profile for R5.Condition for use in FHIR STU3, Condition))
          10. MedicationStatement.extension:renderedDosageInstruction
          Slice NamerenderedDosageInstruction
          Definition

          R5: MedicationStatement.renderedDosageInstruction (new:markdown)

          ShortR5: Full representation of the dosage instructions (new)
          Comments

          Element MedicationStatement.renderedDosageInstruction has a context of MedicationStatement based on following the parent source element upwards and mapping to MedicationStatement. Element MedicationStatement.renderedDosageInstruction has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

          Control0..1
          TypeExtension(R5: Full representation of the dosage instructions (new)) (Extension Type: markdown)
          12. MedicationStatement.extension:adherence
          Slice Nameadherence
          Definition

          R5: MedicationStatement.adherence (new:BackboneElement)

          ShortR5: Indicates whether the medication is or is not being consumed or administered (new)
          Comments

          Element MedicationStatement.adherence has a context of MedicationStatement based on following the parent source element upwards and mapping to MedicationStatement. Element MedicationStatement.adherence has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). This element can be used to indicate whether a patient is following a course of treatment as instructed/prescribed or whether they are taking medications of their own volition. It can also be used to indicate that a patient is not taking a medication, either because they were told not to or because they decided on their own.

          Control0..1
          TypeExtension(R5: Indicates whether the medication is or is not being consumed or administered (new)) (Complex Extension)
          14. MedicationStatement.partOf
          16. MedicationStatement.partOf.extension
          Control0..*
          SlicingThis element introduces a set of slices on MedicationStatement.partOf.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 18. MedicationStatement.partOf.extension:partOf
            Slice NamepartOf
            Definition

            R5: MedicationStatement.partOf additional types from child elements (display, identifier, reference, type)

            ShortR5: partOf additional types
            Comments

            Element MedicationStatement.partOf is mapped to FHIR STU3 element MedicationStatement.partOf as SourceIsBroaderThanTarget. The mappings for MedicationStatement.partOf do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element MedicationStatement.partOf with unmapped reference targets: MedicationStatement, Procedure.

            Control0..*
            TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
            20. MedicationStatement.context
            22. MedicationStatement.context.extension
            Control0..*
            SlicingThis element introduces a set of slices on MedicationStatement.context.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 24. MedicationStatement.context.extension:encounter
              Slice Nameencounter
              Definition

              R5: MedicationStatement.encounter additional types from child elements (display, identifier, reference, type)

              ShortR5: Encounter associated with MedicationStatement additional types
              Comments

              Element MedicationStatement.encounter is mapped to FHIR STU3 element MedicationStatement.context as SourceIsBroaderThanTarget. The mappings for MedicationStatement.encounter do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element MedicationStatement.encounter with unmapped reference targets: Encounter.

              Control0..1
              TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
              26. MedicationStatement.status
              28. MedicationStatement.status.extension
              Control0..*
              SlicingThis element introduces a set of slices on MedicationStatement.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 30. MedicationStatement.status.extension:status
                Slice Namestatus
                Definition

                R5: MedicationStatement.status additional codes

                ShortR5: recorded | entered-in-error | draft additional codes
                Comments

                Element MedicationStatement.status is mapped to FHIR STU3 element MedicationStatement.status as RelatedTo. The mappings for MedicationStatement.status do not allow expression of the necessary codes, per the bindings on the source and target. The target context MedicationStatement.status is a modifier element, so this extension does not need to be defined as a modifier. This status concerns just the recording of the medication statement. MedicationStatement.adherence should be used for indicating a patient's adherence to the information in this resource. Note, the statuses are different than in previous releases for MedicationStatement or MedicationStatement.

                This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

                Control0..1
                TypeExtension(R5: recorded | entered-in-error | draft additional codes) (Extension Type: code)
                32. MedicationStatement.informationSource
                34. MedicationStatement.informationSource.extension
                Control0..*
                SlicingThis element introduces a set of slices on MedicationStatement.informationSource.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 36. MedicationStatement.informationSource.extension:informationSource
                  Slice NameinformationSource
                  Definition

                  R5: MedicationStatement.informationSource

                  ShortR5: informationSource
                  Comments

                  Element MedicationStatement.informationSource is mapped to FHIR STU3 element MedicationStatement.informationSource as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element MedicationStatement.informationSource with unmapped reference targets: Organization, Patient, Practitioner, PractitionerRole, RelatedPerson.

                  Control0..*
                  TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                  38. MedicationStatement.subject
                  40. MedicationStatement.subject.extension
                  Control0..*
                  SlicingThis element introduces a set of slices on MedicationStatement.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 42. MedicationStatement.subject.extension:subject
                    Slice Namesubject
                    Definition

                    R5: MedicationStatement.subject additional types from child elements (display, identifier, reference, type)

                    ShortR5: subject additional types
                    Comments

                    Element MedicationStatement.subject is mapped to FHIR STU3 element MedicationStatement.subject as SourceIsBroaderThanTarget. The mappings for MedicationStatement.subject do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element MedicationStatement.subject with unmapped reference targets: Group, Patient.

                    Control0..1
                    TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                    44. MedicationStatement.derivedFrom
                    46. MedicationStatement.derivedFrom.extension
                    Control0..*
                    SlicingThis element introduces a set of slices on MedicationStatement.derivedFrom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 48. MedicationStatement.derivedFrom.extension:derivedFrom
                      Slice NamederivedFrom
                      Definition

                      R5: MedicationStatement.derivedFrom additional types from child elements (display, identifier, reference, type)

                      ShortR5: Link to information used to derive the MedicationStatement additional types
                      Comments

                      Element MedicationStatement.derivedFrom is mapped to FHIR STU3 element MedicationStatement.derivedFrom as SourceIsBroaderThanTarget. The mappings for MedicationStatement.derivedFrom do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element MedicationStatement.derivedFrom with unmapped reference targets: Resource. Likely references would be to MedicationRequest, MedicationDispense, Claim, Observation or QuestionnaireAnswers. The most common use cases for deriving a MedicationStatement comes from creating a MedicationStatement from a MedicationRequest or from a lab observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the MedicationStatement from.

                      Control0..*
                      TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)

                      Guidance on how to interpret the contents of this table can be foundhere

                      0. MedicationStatement
                      Definition

                      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.

                      ShortRecord of medication being taken by a patient
                      Comments

                      When interpreting a medicationStatement, the value of the status and NotTaken needed to be considered: MedicationStatement.status + MedicationStatement.wasNotTaken Status=Active + NotTaken=T = Not currently taking Status=Completed + NotTaken=T = Not taken in the past Status=Intended + NotTaken=T = No intention of taking Status=Active + NotTaken=F = Taking, but not as prescribed Status=Active + NotTaken=F = Taking Status=Intended +NotTaken= F = Will be taking (not started) Status=Completed + NotTaken=F = Taken in past Status=In Error + NotTaken=N/A = In Error.

                      Control0..*
                      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                      dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
                      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
                      mst-1: Reason not taken is only permitted if Taken is No (reasonNotTaken.exists().not() or (taken = 'n'))
                      2. MedicationStatement.id
                      Definition

                      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                      ShortLogical id of this artifact
                      Comments

                      The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

                      Control0..1
                      Typeid
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      4. MedicationStatement.meta
                      Definition

                      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

                      ShortMetadata about the resource
                      Control0..1
                      TypeMeta
                      Summarytrue
                      6. MedicationStatement.implicitRules
                      Definition

                      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

                      ShortA set of rules under which this content was created
                      Comments

                      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

                      This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

                      Control0..1
                      Typeuri
                      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      8. MedicationStatement.language
                      Definition

                      The base language in which the resource is written.

                      ShortLanguage of the resource content
                      Comments

                      Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

                      Control0..1
                      BindingUnless not suitable, these codes SHALL be taken from Common Languages .
                      (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

                      A human language.

                      Additional BindingsPurpose
                      All LanguagesMax Binding
                      Typecode
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      10. MedicationStatement.text
                      Definition

                      A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                      ShortText summary of the resource, for human interpretation
                      Comments

                      Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

                      Control0..1
                      This element is affected by the following invariants: dom-1
                      TypeNarrative
                      Alternate Namesnarrative, html, xhtml, display
                      12. MedicationStatement.contained
                      Definition

                      These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                      ShortContained, inline Resources
                      Comments

                      This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

                      Control0..*
                      TypeResource
                      Alternate Namesinline resources, anonymous resources, contained resources
                      14. MedicationStatement.extension
                      Definition

                      An Extension

                      ShortExtension
                      Control0..*
                      TypeExtension
                      SlicingThis element introduces a set of slices on MedicationStatement.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 16. MedicationStatement.extension:effective
                        Slice Nameeffective
                        Definition

                        R5: MedicationStatement.effective[x] additional types (Timing)

                        ShortR5: The date/time or interval when the medication is/was/will be taken additional types
                        Comments

                        Element MedicationStatement.effective[x] is mapped to FHIR STU3 element MedicationStatement.effective[x] as SourceIsBroaderThanTarget. The mappings for MedicationStatement.effective[x] do not cover the following types: Timing. The target context MedicationStatement.effective[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element MedicationStatement. This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken and is expected to continue indefinitely at the time the usage is recorded, the "end" date will be omitted. If the end date is known, then it is included as the "end date". The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text.

                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(R5: The date/time or interval when the medication is/was/will be taken additional types) (Extension Type: Timing)
                        Is Modifierfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        18. MedicationStatement.extension:reason
                        Slice Namereason
                        Definition

                        R5: MedicationStatement.reason additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/Condition), CodeableReference(http://hl7.org/fhir/StructureDefinition/Observation), CodeableReference(http://hl7.org/fhir/StructureDefinition/DiagnosticReport))

                        ShortR5: Reason for why the medication is being/was taken additional types
                        Comments

                        Element MedicationStatement.reason is mapped to FHIR STU3 element MedicationStatement.reasonNotTaken as SourceIsBroaderThanTarget. Element MedicationStatement.reason is mapped to FHIR STU3 element MedicationStatement.reasonCode as SourceIsBroaderThanTarget. Element MedicationStatement.reason is mapped to FHIR STU3 element MedicationStatement.reasonReference as SourceIsBroaderThanTarget. The mappings for MedicationStatement.reason do not cover the following types: CodeableReference. This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference.

                        Control0..*
                        This element is affected by the following invariants: ele-1
                        TypeExtension(R5: Reason for why the medication is being/was taken additional types) (Complex Extension)
                        Is Modifierfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        20. MedicationStatement.extension:relatedClinicalInformation
                        Slice NamerelatedClinicalInformation
                        Definition

                        R5: MedicationStatement.relatedClinicalInformation (new:Reference(Observation,Condition))

                        ShortR5: Link to information relevant to the usage of a medication (new)
                        Comments

                        Element MedicationStatement.relatedClinicalInformation has a context of MedicationStatement based on following the parent source element upwards and mapping to MedicationStatement. Element MedicationStatement.relatedClinicalInformation has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                        Control0..*
                        This element is affected by the following invariants: ele-1
                        TypeExtension(R5: Link to information relevant to the usage of a medication (new)) (Extension Type: Reference(Cross-version Profile for R5.Observation for use in FHIR STU3, Observation, Cross-version Profile for R5.Condition for use in FHIR STU3, Condition))
                        Is Modifierfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        22. MedicationStatement.extension:renderedDosageInstruction
                        Slice NamerenderedDosageInstruction
                        Definition

                        R5: MedicationStatement.renderedDosageInstruction (new:markdown)

                        ShortR5: Full representation of the dosage instructions (new)
                        Comments

                        Element MedicationStatement.renderedDosageInstruction has a context of MedicationStatement based on following the parent source element upwards and mapping to MedicationStatement. Element MedicationStatement.renderedDosageInstruction has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(R5: Full representation of the dosage instructions (new)) (Extension Type: markdown)
                        Is Modifierfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        24. MedicationStatement.extension:adherence
                        Slice Nameadherence
                        Definition

                        R5: MedicationStatement.adherence (new:BackboneElement)

                        ShortR5: Indicates whether the medication is or is not being consumed or administered (new)
                        Comments

                        Element MedicationStatement.adherence has a context of MedicationStatement based on following the parent source element upwards and mapping to MedicationStatement. Element MedicationStatement.adherence has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). This element can be used to indicate whether a patient is following a course of treatment as instructed/prescribed or whether they are taking medications of their own volition. It can also be used to indicate that a patient is not taking a medication, either because they were told not to or because they decided on their own.

                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(R5: Indicates whether the medication is or is not being consumed or administered (new)) (Complex Extension)
                        Is Modifierfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        26. MedicationStatement.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        ShortExtensions that cannot be ignored
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                        Alternate Namesextensions, user content
                        28. MedicationStatement.identifier
                        Definition

                        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.

                        ShortExternal identifier
                        NoteThis is a business identifier, not a resource identifier (see discussion)
                        Control0..*
                        TypeIdentifier
                        Summarytrue
                        30. MedicationStatement.basedOn
                        Definition

                        A plan, proposal or order that is fulfilled in whole or in part by this event.

                        ShortFulfils plan, proposal or order
                        Control0..*
                        TypeReference(MedicationRequest, CarePlan, ProcedureRequest, ReferralRequest)
                        Summarytrue
                        Requirements

                        Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

                        32. MedicationStatement.partOf
                        Definition

                        A larger event of which this particular event is a component or step.

                        ShortPart of referenced event
                        Control0..*
                        TypeReference(MedicationAdministration, MedicationDispense, MedicationStatement, Procedure, Observation)
                        Summarytrue
                        Requirements

                        This should not be used when indicating which resource a MedicationStatement has been derived from. If that is the use case, then MedicationStatement.derivedFrom should be used.

                        34. MedicationStatement.partOf.id
                        Definition

                        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        Shortxml:id (or equivalent in JSON)
                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        XML FormatIn the XML format, this property is represented as an attribute.
                        36. MedicationStatement.partOf.extension
                        Definition

                        An Extension

                        ShortExtension
                        Control0..*
                        TypeExtension
                        SlicingThis element introduces a set of slices on MedicationStatement.partOf.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 38. MedicationStatement.partOf.extension:partOf
                          Slice NamepartOf
                          Definition

                          R5: MedicationStatement.partOf additional types from child elements (display, identifier, reference, type)

                          ShortR5: partOf additional types
                          Comments

                          Element MedicationStatement.partOf is mapped to FHIR STU3 element MedicationStatement.partOf as SourceIsBroaderThanTarget. The mappings for MedicationStatement.partOf do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element MedicationStatement.partOf with unmapped reference targets: MedicationStatement, Procedure.

                          Control0..*
                          TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                          40. MedicationStatement.partOf.reference
                          Definition

                          A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                          ShortLiteral reference, Relative, internal or absolute URL
                          Comments

                          Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                          Control0..1
                          This element is affected by the following invariants: ref-1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          42. MedicationStatement.partOf.identifier
                          Definition

                          An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                          ShortLogical reference, when literal reference is not known
                          Comments

                          When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                          When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                          Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                          NoteThis is a business identifier, not a resource identifier (see discussion)
                          Control0..1
                          TypeIdentifier
                          Summarytrue
                          44. MedicationStatement.partOf.display
                          Definition

                          Plain text narrative that identifies the resource in addition to the resource reference.

                          ShortText alternative for the resource
                          Comments

                          This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                          Control0..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          46. MedicationStatement.context
                          Definition

                          The encounter or episode of care that establishes the context for this MedicationStatement.

                          ShortEncounter / Episode associated with MedicationStatement
                          Control0..1
                          TypeReference(Encounter, EpisodeOfCare)
                          Summarytrue
                          48. MedicationStatement.context.id
                          Definition

                          unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          Shortxml:id (or equivalent in JSON)
                          Control0..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          XML FormatIn the XML format, this property is represented as an attribute.
                          50. MedicationStatement.context.extension
                          Definition

                          An Extension

                          ShortExtension
                          Control0..*
                          TypeExtension
                          SlicingThis element introduces a set of slices on MedicationStatement.context.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 52. MedicationStatement.context.extension:encounter
                            Slice Nameencounter
                            Definition

                            R5: MedicationStatement.encounter additional types from child elements (display, identifier, reference, type)

                            ShortR5: Encounter associated with MedicationStatement additional types
                            Comments

                            Element MedicationStatement.encounter is mapped to FHIR STU3 element MedicationStatement.context as SourceIsBroaderThanTarget. The mappings for MedicationStatement.encounter do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element MedicationStatement.encounter with unmapped reference targets: Encounter.

                            Control0..1
                            TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                            54. MedicationStatement.context.reference
                            Definition

                            A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                            ShortLiteral reference, Relative, internal or absolute URL
                            Comments

                            Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                            Control0..1
                            This element is affected by the following invariants: ref-1
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            56. MedicationStatement.context.identifier
                            Definition

                            An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                            ShortLogical reference, when literal reference is not known
                            Comments

                            When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                            When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                            Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                            NoteThis is a business identifier, not a resource identifier (see discussion)
                            Control0..1
                            TypeIdentifier
                            Summarytrue
                            58. MedicationStatement.context.display
                            Definition

                            Plain text narrative that identifies the resource in addition to the resource reference.

                            ShortText alternative for the resource
                            Comments

                            This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                            Control0..1
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            60. MedicationStatement.status
                            Definition

                            A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally this will be active or completed.

                            Shortactive | completed | entered-in-error | intended | stopped | on-hold
                            Comments

                            MedicationStatement is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for MedicationStatement.status contains codes that assert the status of the use of the medication by the patient (for example, stopped or on hold) as well as codes that assert the status of the medication statement itself (for example, entered in error).

                            This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

                            Control1..1
                            BindingThe codes SHALL be taken from MedicationStatementStatus
                            (required to http://hl7.org/fhir/ValueSet/medication-statement-status|3.0.2)

                            A coded concept indicating the current status of a MedicationStatement.

                            Typecode
                            Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            62. MedicationStatement.status.id
                            Definition

                            unique id for the element within a resource (for internal references)

                            Shortxml:id (or equivalent in JSON)
                            Control0..1
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            XML FormatIn the XML format, this property is represented as an attribute.
                            64. MedicationStatement.status.extension
                            Definition

                            An Extension

                            ShortExtension
                            Control0..*
                            TypeExtension
                            SlicingThis element introduces a set of slices on MedicationStatement.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 66. MedicationStatement.status.extension:status
                              Slice Namestatus
                              Definition

                              R5: MedicationStatement.status additional codes

                              ShortR5: recorded | entered-in-error | draft additional codes
                              Comments

                              Element MedicationStatement.status is mapped to FHIR STU3 element MedicationStatement.status as RelatedTo. The mappings for MedicationStatement.status do not allow expression of the necessary codes, per the bindings on the source and target. The target context MedicationStatement.status is a modifier element, so this extension does not need to be defined as a modifier. This status concerns just the recording of the medication statement. MedicationStatement.adherence should be used for indicating a patient's adherence to the information in this resource. Note, the statuses are different than in previous releases for MedicationStatement or MedicationStatement.

                              This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

                              Control0..1
                              This element is affected by the following invariants: ele-1
                              TypeExtension(R5: recorded | entered-in-error | draft additional codes) (Extension Type: code)
                              Is Modifierfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              68. MedicationStatement.status.value
                              Definition

                              Primitive value for code

                              ShortPrimitive value for code
                              Control0..1
                              Typecode
                              XML FormatIn the XML format, this property is represented as an attribute.
                              70. MedicationStatement.category
                              Definition

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

                              ShortType of medication usage
                              Control0..1
                              BindingThe codes SHOULD be taken from MedicationStatementCategory
                              (preferred to http://hl7.org/fhir/ValueSet/medication-statement-category|3.0.2)

                              A coded concept identifying where the medication included in the medicationstatement is expected to be consumed or administered

                              TypeCodeableConcept
                              Summarytrue
                              72. MedicationStatement.medication[x]
                              Definition

                              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.

                              ShortWhat medication was taken
                              Comments

                              If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended.  For example if you require form or lot number, then you must reference the Medication resource. .

                              Control1..1
                              BindingFor example codes, see SNOMED CT Medication Codes
                              (example to http://hl7.org/fhir/ValueSet/medication-codes|3.0.2)

                              A coded concept identifying the substance or product being taken.

                              TypeChoice of: CodeableConcept, Reference(Medication)
                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                              Summarytrue
                              74. MedicationStatement.effective[x]
                              Definition

                              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).

                              ShortThe date/time or interval when the medication was taken
                              Comments

                              This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken at the time the statement is recorded, the "end" date will be omitted.

                              Control0..1
                              TypeChoice of: dateTime, Period
                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              76. MedicationStatement.dateAsserted
                              Definition

                              The date when the medication statement was asserted by the information source.

                              ShortWhen the statement was asserted?
                              Control0..1
                              TypedateTime
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              78. MedicationStatement.informationSource
                              Definition

                              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.

                              ShortPerson or organization that provided the information about the taking of this medication
                              Control0..1
                              TypeReference(Patient, Practitioner, RelatedPerson, Organization)
                              80. MedicationStatement.informationSource.id
                              Definition

                              unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                              Shortxml:id (or equivalent in JSON)
                              Control0..1
                              Typestring
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              XML FormatIn the XML format, this property is represented as an attribute.
                              82. MedicationStatement.informationSource.extension
                              Definition

                              An Extension

                              ShortExtension
                              Control0..*
                              TypeExtension
                              SlicingThis element introduces a set of slices on MedicationStatement.informationSource.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 84. MedicationStatement.informationSource.extension:informationSource
                                Slice NameinformationSource
                                Definition

                                R5: MedicationStatement.informationSource

                                ShortR5: informationSource
                                Comments

                                Element MedicationStatement.informationSource is mapped to FHIR STU3 element MedicationStatement.informationSource as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element MedicationStatement.informationSource with unmapped reference targets: Organization, Patient, Practitioner, PractitionerRole, RelatedPerson.

                                Control0..*
                                TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                                86. MedicationStatement.informationSource.reference
                                Definition

                                A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                ShortLiteral reference, Relative, internal or absolute URL
                                Comments

                                Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                Control0..1
                                This element is affected by the following invariants: ref-1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                88. MedicationStatement.informationSource.identifier
                                Definition

                                An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                ShortLogical reference, when literal reference is not known
                                Comments

                                When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                Control0..1
                                TypeIdentifier
                                Summarytrue
                                90. MedicationStatement.informationSource.display
                                Definition

                                Plain text narrative that identifies the resource in addition to the resource reference.

                                ShortText alternative for the resource
                                Comments

                                This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                92. MedicationStatement.subject
                                Definition

                                The person, animal or group who is/was taking the medication.

                                ShortWho is/was taking the medication
                                Control1..1
                                TypeReference(Patient, Group)
                                Summarytrue
                                94. MedicationStatement.subject.id
                                Definition

                                unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                Shortxml:id (or equivalent in JSON)
                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                XML FormatIn the XML format, this property is represented as an attribute.
                                96. MedicationStatement.subject.extension
                                Definition

                                An Extension

                                ShortExtension
                                Control0..*
                                TypeExtension
                                SlicingThis element introduces a set of slices on MedicationStatement.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 98. MedicationStatement.subject.extension:subject
                                  Slice Namesubject
                                  Definition

                                  R5: MedicationStatement.subject additional types from child elements (display, identifier, reference, type)

                                  ShortR5: subject additional types
                                  Comments

                                  Element MedicationStatement.subject is mapped to FHIR STU3 element MedicationStatement.subject as SourceIsBroaderThanTarget. The mappings for MedicationStatement.subject do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element MedicationStatement.subject with unmapped reference targets: Group, Patient.

                                  Control0..1
                                  TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                                  100. MedicationStatement.subject.reference
                                  Definition

                                  A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                  ShortLiteral reference, Relative, internal or absolute URL
                                  Comments

                                  Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                  Control0..1
                                  This element is affected by the following invariants: ref-1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  102. MedicationStatement.subject.identifier
                                  Definition

                                  An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                  ShortLogical reference, when literal reference is not known
                                  Comments

                                  When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                  When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                  Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                  Control0..1
                                  TypeIdentifier
                                  Summarytrue
                                  104. MedicationStatement.subject.display
                                  Definition

                                  Plain text narrative that identifies the resource in addition to the resource reference.

                                  ShortText alternative for the resource
                                  Comments

                                  This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  106. MedicationStatement.derivedFrom
                                  Definition

                                  Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.

                                  ShortAdditional supporting information
                                  Comments

                                  Likely references would be to MedicationRequest, MedicationDispense, Claim, Observation or QuestionnaireAnswers. The most common use cases for deriving a MedicationStatement comes from creating a MedicationStatement from a MedicationRequest or from a lab observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the MedicationStatement from.

                                  Control0..*
                                  TypeReference(Resource)
                                  108. MedicationStatement.derivedFrom.id
                                  Definition

                                  unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                  Shortxml:id (or equivalent in JSON)
                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  110. MedicationStatement.derivedFrom.extension
                                  Definition

                                  An Extension

                                  ShortExtension
                                  Control0..*
                                  TypeExtension
                                  SlicingThis element introduces a set of slices on MedicationStatement.derivedFrom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 112. MedicationStatement.derivedFrom.extension:derivedFrom
                                    Slice NamederivedFrom
                                    Definition

                                    R5: MedicationStatement.derivedFrom additional types from child elements (display, identifier, reference, type)

                                    ShortR5: Link to information used to derive the MedicationStatement additional types
                                    Comments

                                    Element MedicationStatement.derivedFrom is mapped to FHIR STU3 element MedicationStatement.derivedFrom as SourceIsBroaderThanTarget. The mappings for MedicationStatement.derivedFrom do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element MedicationStatement.derivedFrom with unmapped reference targets: Resource. Likely references would be to MedicationRequest, MedicationDispense, Claim, Observation or QuestionnaireAnswers. The most common use cases for deriving a MedicationStatement comes from creating a MedicationStatement from a MedicationRequest or from a lab observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the MedicationStatement from.

                                    Control0..*
                                    TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                                    114. MedicationStatement.derivedFrom.reference
                                    Definition

                                    A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                    ShortLiteral reference, Relative, internal or absolute URL
                                    Comments

                                    Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                    Control0..1
                                    This element is affected by the following invariants: ref-1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    116. MedicationStatement.derivedFrom.identifier
                                    Definition

                                    An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                    ShortLogical reference, when literal reference is not known
                                    Comments

                                    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                    NoteThis is a business identifier, not a resource identifier (see discussion)
                                    Control0..1
                                    TypeIdentifier
                                    Summarytrue
                                    118. MedicationStatement.derivedFrom.display
                                    Definition

                                    Plain text narrative that identifies the resource in addition to the resource reference.

                                    ShortText alternative for the resource
                                    Comments

                                    This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                    Control0..1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    120. MedicationStatement.taken
                                    Definition

                                    Indicator of the certainty of whether the medication was taken by the patient.

                                    Shorty | n | unk | na
                                    Comments

                                    This element is labeled as a modifier because it indicates that the medication was not taken.

                                    Control1..1
                                    BindingThe codes SHALL be taken from MedicationStatementTaken
                                    (required to http://hl7.org/fhir/ValueSet/medication-statement-taken|3.0.2)

                                    A coded concept identifying level of certainty if patient has taken or has not taken the medication

                                    Typecode
                                    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    122. MedicationStatement.reasonNotTaken
                                    Definition

                                    A code indicating why the medication was not taken.

                                    ShortTrue if asserting medication was not given
                                    Control0..*
                                    This element is affected by the following invariants: mst-1
                                    BindingFor example codes, see SNOMED CT Drugs not taken/completed Codes
                                    (example to http://hl7.org/fhir/ValueSet/reason-medication-not-taken-codes|3.0.2)

                                    A coded concept indicating the reason why the medication was not taken

                                    TypeCodeableConcept
                                    124. MedicationStatement.reasonCode
                                    Definition

                                    A reason for why the medication is being/was taken.

                                    ShortReason for why the medication is being/was taken
                                    Comments

                                    This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference.

                                    Control0..*
                                    BindingFor example codes, see Condition/Problem/Diagnosis Codes
                                    (example to http://hl7.org/fhir/ValueSet/condition-code|3.0.2)

                                    A coded concept identifying why the medication is being taken.

                                    TypeCodeableConcept
                                    126. MedicationStatement.reasonReference
                                    Definition

                                    Condition or observation that supports why the medication is being/was taken.

                                    ShortCondition or observation that supports why the medication is being/was taken
                                    Comments

                                    This is a reference to a condition that is the reason why the medication is being/was taken. If only a code exists, use reasonForUseCode.

                                    Control0..*
                                    TypeReference(Condition, Observation)
                                    128. MedicationStatement.note
                                    Definition

                                    Provides extra information about the medication statement that is not conveyed by the other attributes.

                                    ShortFurther information about the statement
                                    Control0..*
                                    TypeAnnotation
                                    130. MedicationStatement.dosage
                                    Definition

                                    Indicates how the medication is/was or should be taken by the patient.

                                    ShortDetails of how medication is/was taken or should be taken
                                    Comments

                                    The dates included in the dosage on a Medication Statement reflect the dates for a given dose. For example, "from November 1, 2016 to November 3, 2016, take one tablet daily and from November 4, 2016 to November 7, 2016, take two tablets daily." It is expected that this specificity may only be populated where the patient brings in their labeled container or where the Medication Statement is derived from a MedicationRequest.

                                    Control0..*
                                    TypeDosage