Data Model Libraries
    Preparing search index...

    SearchParameterComponentComponent Class

    FHIR Specification

    • Short: For Composite resources to define the parts
    • Definition: Used to define the parts of a composite search parameter.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    definition: null | CanonicalType

    SearchParameter.component.definition Element

    FHIR Specification

    expression: null | StringType

    SearchParameter.component.expression Element

    FHIR Specification

    • Short: Subexpression relative to main expression
    • Definition: A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression.
    • Comment: This expression overrides the expression in the definition and extracts the index values from the outcome of the composite expression.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SearchParameterComponentComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SearchParameterComponentComponent

      SearchParameterComponentComponent data model or undefined for SearchParameterComponentComponent

      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