Data Model Libraries
    Preparing search index...

    Class ExplanationOfBenefitSupportingInfoComponent

    ExplanationOfBenefitSupportingInfoComponent Class

    FHIR Specification

    • Short: Supporting information
    • Definition: Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
    • Comment: Often there are multiple jurisdiction specific valuesets which are required.
    • Requirements: Typically these information codes are required to support the services rendered or the adjudication of the services rendered.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    sequence: null | PositiveIntType

    ExplanationOfBenefit.supportingInfo.sequence Element

    FHIR Specification

    • Short: Information instance identifier
    • Definition: A number to uniquely identify supporting information entries.
    • Requirements: Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details.
    • FHIR Type: positiveInt
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    category: null | CodeableConcept

    ExplanationOfBenefit.supportingInfo.category Element

    FHIR Specification

    • Short: Classification of the supplied information
    • Definition: The general class of the information supplied: information; exception; accident, employment; onset, etc.
    • Comment: This may contain a category for the local bill type codes.
    • Requirements: Required to group or associate information items with common characteristics. For example: admission information or prior treatments.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    ExplanationOfBenefit.supportingInfo.code Element

    FHIR Specification

    • Short: Type of information
    • Definition: System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.
    • Comment: This may contain the local bill type codes such as the US UB-04 bill type code.
    • Requirements: Required to identify the kind of additional information.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    timing?: IDataType

    ExplanationOfBenefit.supportingInfo.timing[x] Element

    @ChoiceDataTypesMeta('ExplanationOfBenefit.supportingInfo.timing[x]', ['date','Period',]

    FHIR Specification

    • Short: When it occurred
    • Definition: The date when or period to which this information refers.
    • FHIR Types: 'date', 'Period',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    value?: IDataType

    ExplanationOfBenefit.supportingInfo.value[x] Element

    @ChoiceDataTypesMeta('ExplanationOfBenefit.supportingInfo.value[x]', ['boolean','string','Quantity','Attachment','Reference','Identifier',]

    FHIR Specification

    • Short: Data to be provided
    • Definition: Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
    • Comment: Could be used to provide references to other resources, document. For example, could contain a PDF in an Attachment of the Police Report for an Accident.
    • Requirements: To convey the data content to be provided when the information is more than a simple code or period.
    • FHIR Types: 'boolean', 'string', 'Quantity', 'Attachment', 'Reference', 'Identifier',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    reason?: Coding

    ExplanationOfBenefit.supportingInfo.reason Element

    FHIR Specification

    • Short: Explanation for the information
    • Definition: Provides the reason in the situation where a reason code is required in addition to the content.
    • Comment: For example: the reason for the additional stay, or why a tooth is missing.
    • Requirements: Needed when the supporting information has both a date and amount/value and requires explanation.
    • FHIR Type: Coding
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ExplanationOfBenefitSupportingInfoComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ExplanationOfBenefitSupportingInfoComponent

      ExplanationOfBenefitSupportingInfoComponent data model or undefined for ExplanationOfBenefitSupportingInfoComponent

      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