Data Model Libraries
    Preparing search index...

    BundleEntrySearchComponent Class

    FHIR Specification

    • Short: Search related information
    • Definition: Information about the search process that lead to the creation of this entry.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    searchEntryModeEnum: SearchEntryModeEnum

    FHIR CodeSystem: SearchEntryMode

    Bundle.entry.search.mode Element

    FHIR Specification

    • Short: match | include | outcome - why this is in the result set
    • Definition: Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
    • Comment: There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: SearchEntryModeEnum

    score?: DecimalType

    Bundle.entry.search.score Element

    FHIR Specification

    • Short: Search ranking (between 0 and 1)
    • Definition: When searching, the server's search ranking score for the entry.
    • Comment: Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element.
    • FHIR Type: decimal
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR BundleEntrySearchComponent

      • OptionaloptSourceField: string

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

      Returns undefined | BundleEntrySearchComponent

      BundleEntrySearchComponent data model or undefined for BundleEntrySearchComponent

      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 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 complex or primitive datatype; false otherwise