Data Model Libraries
    Preparing search index...

    Class ActivityDefinitionDynamicValueComponent

    ActivityDefinitionDynamicValueComponent Class

    FHIR Specification

    • Short: Dynamic aspects of the definition
    • Definition: Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.
    • Comment: Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.

    FHIR ActivityDefinition

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    path expression

    Methods

    parse getPathElement setPathElement hasPathElement getPath setPath hasPath getExpression setExpression hasExpression 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

    path: null | StringType

    ActivityDefinition.dynamicValue.path Element

    FHIR Specification

    • Short: The path to the element to be set dynamically
    • Definition: The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).
    • Comment: The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    expression: null | Expression

    ActivityDefinition.dynamicValue.expression Element

    FHIR Specification

    • Short: An expression that provides the dynamic value for the customization
    • Definition: An expression specifying the value of the customized element.
    • Comment: The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.
    • FHIR Type: Expression
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ActivityDefinitionDynamicValueComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ActivityDefinitionDynamicValueComponent

      ActivityDefinitionDynamicValueComponent data model or undefined for ActivityDefinitionDynamicValueComponent

      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