US Core Implementation Guide
7.0.0-ballot - Ballot United States of America flag

This page is part of the US Core (v7.0.0-ballot: STU7 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 6.1.0. For a full list of available versions, see the Directory of published versions

Extension: US Core Medication Adherence Extension

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication-adherence Version: 7.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: USCoreMedicationAdherenceExtension

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

The Medication Adherence Extension is used to report whether a medication has been consumed according to instructions

Context of Use

This extension may be used on the following element(s):

  • Element ID MedicationRequest

This page is new content for US Core Version 7.0.0

Profile Specific Implementation Guidance:

  • The informationSource subextension lists several profile references. Although none of the informationSource references are flagged as Must Support, the server SHALL support at least one of them.

Usage info

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Complex Extension: The Medication Adherence Extension is used to report whether a medication has been consumed according to instructions

  • medicationAdherence: CodeableConcept: Code stating whether the patient is consuming or being administered the medication has according to instructions. For example, the patient in not taking the medication as prescribed, or the patient is taking the medication as prescribed.
  • dateAsserted: dateTime: When the medication adherence was asserted by the information source
  • informationSource: Reference: The person or organization that provided the information about the medication adherence

Maturity: 3

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:medicationAdherence S1..1ExtensionMedication adherence code
.... url 1..1uri"medicationAdherence"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Medication Adherence (extensible): This set of values contains terms representing whether a medication has been consumed according to instructions.

... extension:dateAsserted S1..1ExtensionWhen the medication adherence was asserted
.... url 1..1uri"dateAsserted"
.... value[x] 1..1dateTimeValue of extension
... extension:informationSource S0..*ExtensionWho provided the information about the medication adherence
.... url 1..1uri"informationSource"
.... value[x] 1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | US Core RelatedPerson Profile)Value of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication-adherence"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:medicationAdherence S1..1ExtensionMedication adherence code
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"medicationAdherence"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Medication Adherence (extensible): This set of values contains terms representing whether a medication has been consumed according to instructions.

... extension:dateAsserted S1..1ExtensionWhen the medication adherence was asserted
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"dateAsserted"
.... value[x] 1..1dateTimeValue of extension
... extension:informationSource S0..*ExtensionWho provided the information about the medication adherence
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"informationSource"
.... value[x] 1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | US Core RelatedPerson Profile)Value of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication-adherence"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: The Medication Adherence Extension is used to report whether a medication has been consumed according to instructions

  • medicationAdherence: CodeableConcept: Code stating whether the patient is consuming or being administered the medication has according to instructions. For example, the patient in not taking the medication as prescribed, or the patient is taking the medication as prescribed.
  • dateAsserted: dateTime: When the medication adherence was asserted by the information source
  • informationSource: Reference: The person or organization that provided the information about the medication adherence

Maturity: 3

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:medicationAdherence S1..1ExtensionMedication adherence code
.... url 1..1uri"medicationAdherence"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Medication Adherence (extensible): This set of values contains terms representing whether a medication has been consumed according to instructions.

... extension:dateAsserted S1..1ExtensionWhen the medication adherence was asserted
.... url 1..1uri"dateAsserted"
.... value[x] 1..1dateTimeValue of extension
... extension:informationSource S0..*ExtensionWho provided the information about the medication adherence
.... url 1..1uri"informationSource"
.... value[x] 1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | US Core RelatedPerson Profile)Value of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication-adherence"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:medicationAdherence S1..1ExtensionMedication adherence code
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"medicationAdherence"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Medication Adherence (extensible): This set of values contains terms representing whether a medication has been consumed according to instructions.

... extension:dateAsserted S1..1ExtensionWhen the medication adherence was asserted
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"dateAsserted"
.... value[x] 1..1dateTimeValue of extension
... extension:informationSource S0..*ExtensionWho provided the information about the medication adherence
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"informationSource"
.... value[x] 1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | US Core RelatedPerson Profile)Value of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication-adherence"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:medicationAdherence.value[x]extensibleMedicationAdherence

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()