Data Model Libraries
    Preparing search index...

    Class MedicationStatementAdherenceComponent

    MedicationStatementAdherenceComponent Class

    FHIR Specification

    • Short: Indicates whether the medication is or is not being consumed or administered
    • Definition: Indicates whether the medication is or is not being consumed or administered.
    • Comment: 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.

    FHIR MedicationStatement

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    code reason?

    Methods

    parse getCode setCode hasCode getReason setReason hasReason fhirType isEmpty isRequiredFieldsEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues

    Constructors

    Properties

    code: null | CodeableConcept

    MedicationStatement.adherence.code Element

    FHIR Specification

    • Short: Type of adherence
    • Definition: Type of the adherence for the medication.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    reason?: CodeableConcept

    MedicationStatement.adherence.reason Element

    FHIR Specification

    • Short: Details of the reason for the current use of the medication
    • Definition: Captures the reason for the current use or adherence of a medication.
    • Comment: This is generally only used for "exception" statuses such as "entered-in-error". The reason for performing the event at all is captured in reasonCode, not here.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided MedicationStatementAdherenceComponent JSON to instantiate the MedicationStatementAdherenceComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicationStatementAdherenceComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to MedicationStatementAdherenceComponent

      Returns undefined | MedicationStatementAdherenceComponent

      MedicationStatementAdherenceComponent data model or undefined for MedicationStatementAdherenceComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods