Data Model Libraries
    Preparing search index...

    Class MedicationKnowledgeRegulatoryComponent

    MedicationKnowledgeRegulatoryComponent Class

    FHIR Specification

    • Short: Regulatory information about a medication
    • Definition: Regulatory information about a medication.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    regulatoryAuthority: null | Reference

    MedicationKnowledge.regulatory.regulatoryAuthority Element

    FHIR Specification

    • Short: Specifies the authority of the regulation
    • Definition: The authority that is specifying the regulations.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    MedicationKnowledge.regulatory.substitution Element

    FHIR Specification

    • Short: Specifies if changes are allowed when dispensing a medication from a regulatory perspective
    • Definition: Specifies if changes are allowed when dispensing a medication from a regulatory perspective.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    MedicationKnowledge.regulatory.schedule Element

    FHIR Specification

    • Short: Specifies the schedule of a medication in jurisdiction
    • Definition: Specifies the schedule of a medication in jurisdiction.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    MedicationKnowledge.regulatory.maxDispense Element

    FHIR Specification

    • Short: The maximum number of units of the medication that can be dispensed in a period
    • Definition: The maximum number of units of the medication that can be dispensed in a period.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicationKnowledgeRegulatoryComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MedicationKnowledgeRegulatoryComponent

      MedicationKnowledgeRegulatoryComponent data model or undefined for MedicationKnowledgeRegulatoryComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided RegulatoryAuthority object value to the regulatoryAuthority property.

      Parameters

      • value: undefined | null | Reference

        the regulatoryAuthority object value

      Returns this

      this

      @ReferenceTargets('MedicationKnowledge.regulatory.regulatoryAuthority', ['Organization',])

      InvalidTypeError for invalid data type or reference value

    • 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