Data Model Libraries
    Preparing search index...

    Class TerminologyCapabilitiesExpansionComponent

    TerminologyCapabilitiesExpansionComponent Class

    FHIR Specification

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    hierarchical?: BooleanType

    TerminologyCapabilities.expansion.hierarchical Element

    FHIR Specification

    • Short: Whether the server can return nested value sets
    • Definition: Whether the server can return nested value sets.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    paging?: BooleanType

    TerminologyCapabilities.expansion.paging Element

    FHIR Specification

    • Short: Whether the server supports paging on expansion
    • Definition: Whether the server supports paging on expansion.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    incomplete?: BooleanType

    TerminologyCapabilities.expansion.incomplete Element

    FHIR Specification

    • Short: Allow request for incomplete expansions?
    • Definition: Allow request for incomplete expansions?
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    TerminologyCapabilities.expansion.parameter Element

    FHIR Specification

    • Short: Supported expansion parameter
    • Definition: Supported expansion parameter.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    textFilter?: MarkdownType

    TerminologyCapabilities.expansion.textFilter Element

    FHIR Specification

    • Short: Documentation about text searching works
    • Definition: Documentation about text searching works.
    • Comment: This documentation should cover things like case sensitivity, use of punctuation if not ignored, what wild cards are supported (if any), whether text is starts with or contains, and whether word order matters.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR TerminologyCapabilitiesExpansionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | TerminologyCapabilitiesExpansionComponent

      TerminologyCapabilitiesExpansionComponent data model or undefined for TerminologyCapabilitiesExpansionComponent

      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