Data Model Libraries
    Preparing search index...

    ClaimResponseErrorComponent Class

    FHIR Specification

    • Short: Processing errors
    • Definition: Errors encountered during the processing of the adjudication.
    • Comment: If the request contains errors then an error element should be provided and no adjudication related sections (item, addItem, or payment) should be present.
    • Requirements: Need to communicate processing issues to the requestor.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    itemSequence?: PositiveIntType

    ClaimResponse.error.itemSequence Element

    FHIR Specification

    • Short: Item sequence number
    • Definition: The sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.
    • Requirements: Provides references to the claim items.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    detailSequence?: PositiveIntType

    ClaimResponse.error.detailSequence Element

    FHIR Specification

    • Short: Detail sequence number
    • Definition: The sequence number of the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.
    • Requirements: Provides references to the claim details within the claim item.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    subDetailSequence?: PositiveIntType

    ClaimResponse.error.subDetailSequence Element

    FHIR Specification

    • Short: Subdetail sequence number
    • Definition: The sequence number of the sub-detail within the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.
    • Requirements: Provides references to the claim sub-details within the claim detail.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    code: null | CodeableConcept

    ClaimResponse.error.code Element

    FHIR Specification

    • Short: Error code detailing processing issues
    • Definition: An error code, from a specified code system, which details why the claim could not be adjudicated.
    • Requirements: Required to convey processing errors.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    expression?: StringType[]

    ClaimResponse.error.expression Element

    FHIR Specification

    • Short: FHIRPath of element(s) related to issue
    • Definition: A simple subset of FHIRPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.
    • Comment: The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.
    • Requirements: Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ClaimResponseErrorComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ClaimResponseErrorComponent

      ClaimResponseErrorComponent data model or undefined for ClaimResponseErrorComponent

      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