Data Model Libraries
    Preparing search index...

    Expression Class

    Expression Type: A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.

    FHIR Specification

    • Short: An expression that can be used to generate a value
    • Definition: A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.
    • FHIR Version: 5.0.0

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    description?: StringType

    Expression.description Element

    FHIR Specification

    • Short: Natural language description of the condition
    • Definition: A brief, natural language description of the condition that effectively communicates the intended semantics.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: CodeType

    FHIR Specification

    • Short: Short name assigned to expression for reuse
    • Definition: A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    language?: CodeType

    Expression.language Element

    FHIR Specification

    • Short: text/cql | text/fhirpath | application/x-fhir-query | etc.
    • Definition: The media type of the language for the expression.
    • Requirements: The cardinality of this element is optional to allow text only as part of the authoring process. However, in order to be executable, the expression element must be specified.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    expression?: StringType

    Expression.expression Element

    FHIR Specification

    • Short: Expression in specified language
    • Definition: An expression in the specified language that returns a value.
    • Comment: If Expression.expression and Expression.reference are both present, the Expression.expression might just be a name pointing something within the referenced content.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    reference?: UriType

    Expression.reference Element

    FHIR Specification

    • Short: Where the expression is found
    • Definition: A URI that defines where the expression is found.
    • Comment: If both a reference and an expression is found, the reference SHALL point to the same expression.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Expression

      • OptionaloptSourceField: string

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

      Returns undefined | Expression

      Expression data model or undefined for Expression

      JsonError if the provided JSON is not a valid JSON object

    • Returns boolean

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

    • 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

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR resource; false otherwise

    • Returns boolean

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

    • Returns boolean

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

    • Returns boolean

      true if the instance is a FHIR primitive string-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive number-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive bigint-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datetime-based datatype; false otherwise