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.

    FHIR ChargeItemDefinition

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    condition? effectivePeriod? relatedArtifact?

    Methods

    parse getCondition setCondition hasCondition getEffectivePeriod setEffectivePeriod hasEffectivePeriod getRelatedArtifact setRelatedArtifact hasRelatedArtifact fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues

    Constructors

    Properties

    condition?: Expression

    ChargeItemDefinition.applicability.condition 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: Expression
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    effectivePeriod?: Period

    ChargeItemDefinition.applicability.effectivePeriod Element

    FHIR Specification

    • Short: When the charge item definition is expected to be used
    • Definition: The period during which the charge item definition content was or is planned to be in active use.
    • Comment: The effective period for a charge item definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
    • Requirements: Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the charge item definition are or are expected to be used instead.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    relatedArtifact?: RelatedArtifact

    ChargeItemDefinition.applicability.relatedArtifact Element

    FHIR Specification

    • Short: Reference to / quotation of the external source of the group of properties
    • Definition: Reference to / quotation of the external source of the group of properties.
    • FHIR Type: RelatedArtifact
    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods