Data Model Libraries
    Preparing search index...

    Class ExplanationOfBenefitDiagnosisComponent

    ExplanationOfBenefitDiagnosisComponent Class

    FHIR Specification

    • Short: Pertinent diagnosis information
    • Definition: Information about diagnoses relevant to the claim items.
    • Requirements: Required for the adjudication by provided context for the services and product listed.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    sequence: null | PositiveIntType

    ExplanationOfBenefit.diagnosis.sequence Element

    FHIR Specification

    • Short: Diagnosis instance identifier
    • Definition: A number to uniquely identify diagnosis entries.
    • Comment: Diagnosis are presented in list order to their expected importance: primary, secondary, etc.
    • Requirements: Necessary to maintain the order of the diagnosis items and provide a mechanism to link to claim details.
    • FHIR Type: positiveInt
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    diagnosis: null | IDataType

    ExplanationOfBenefit.diagnosis.diagnosis[x] Element

    @ChoiceDataTypesMeta('ExplanationOfBenefit.diagnosis.diagnosis[x]', ['CodeableConcept','Reference',]

    FHIR Specification

    • Short: Nature of illness or problem
    • Definition: The nature of illness or problem in a coded form or as a reference to an external defined Condition.
    • Requirements: Provides health context for the evaluation of the products and/or services.
    • FHIR Types: 'CodeableConcept', 'Reference',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    type_?: CodeableConcept[]

    ExplanationOfBenefit.diagnosis.type Element

    FHIR Specification

    • Short: Timing or nature of the diagnosis
    • Definition: When the condition was observed or the relative ranking.
    • Comment: For example: admitting, primary, secondary, discharge.
    • Requirements: Often required to capture a particular diagnosis, for example: primary or discharge.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    onAdmission?: CodeableConcept

    ExplanationOfBenefit.diagnosis.onAdmission Element

    FHIR Specification

    • Short: Present on admission
    • Definition: Indication of whether the diagnosis was present on admission to a facility.
    • Requirements: Many systems need to understand for adjudication if the diagnosis was present a time of admission.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ExplanationOfBenefitDiagnosisComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ExplanationOfBenefitDiagnosisComponent

      ExplanationOfBenefitDiagnosisComponent data model or undefined for ExplanationOfBenefitDiagnosisComponent

      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