Data Model Libraries
    Preparing search index...

    ClaimRelatedComponent Class

    FHIR Specification

    • Short: Prior or corollary claims
    • Definition: Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.
    • Comment: For example, for the original treatment and follow-up exams.
    • Requirements: For workplace or other accidents it is common to relate separate claims arising from the same event.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    claim?: Reference

    Claim.related.claim Element

    FHIR Specification

    • Short: Reference to the related claim
    • Definition: Reference to a related claim.
    • Requirements: For workplace or other accidents it is common to relate separate claims arising from the same event.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    relationship?: CodeableConcept

    Claim.related.relationship Element

    FHIR Specification

    • Short: How the reference claim is related
    • Definition: A code to convey how the claims are related.
    • Comment: For example, prior claim or umbrella.
    • Requirements: Some insurers need a declaration of the type of relationship.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    reference?: Identifier

    Claim.related.reference Element

    FHIR Specification

    • Short: File or case reference
    • Definition: An alternate organizational reference to the case or file to which this particular claim pertains.
    • Comment: For example, Property/Casualty insurer claim # or Workers Compensation case # .
    • Requirements: In cases where an event-triggered claim is being submitted to an insurer which requires a reference number to be specified on all exchanges.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ClaimRelatedComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ClaimRelatedComponent

      ClaimRelatedComponent data model or undefined for ClaimRelatedComponent

      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