Data Model Libraries
    Preparing search index...

    Class ChargeItemDefinitionApplicabilityComponent

    ChargeItemDefinitionApplicabilityComponent Class

    FHIR Specification

    • Short: Whether or not the billing code is applicable
    • Definition: Expressions that describe applicability criteria for the billing code.
    • Comment: The applicability conditions can be used to ascertain whether a billing item is allowed in a specific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    description?: StringType

    ChargeItemDefinition.applicability.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: false
    language?: StringType

    ChargeItemDefinition.applicability.language Element

    FHIR Specification

    • Short: Language of the expression
    • Definition: The media type of the language for the expression, e.g. "text/cql" for Clinical Query Language expressions or "text/fhirpath" for FHIRPath expressions.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    expression?: StringType

    ChargeItemDefinition.applicability.expression Element

    FHIR Specification

    • Short: Boolean-valued expression
    • Definition: An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied.
    • Comment: Please note that FHIRPath Expressions can only be evaluated in the scope of the current ChargeItem resource to which this definition is being applied. FHIRPath expressions can traverse into other resources linked from the ChargeItem resource, however, testing rules such as that a billing code may be billed only once per encounter need a wider scope. In such scenarios, CQL may be the appropriate choice.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ChargeItemDefinitionApplicabilityComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ChargeItemDefinitionApplicabilityComponent

      ChargeItemDefinitionApplicabilityComponent data model or undefined for ChargeItemDefinitionApplicabilityComponent

      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