Data Model Libraries
    Preparing search index...

    ClaimResponseItemDetailComponent Class

    FHIR Specification

    • Short: Adjudication for claim details
    • Definition: A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
    • Requirements: The adjudication for details provided on the claim.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    detailSequence: null | PositiveIntType

    ClaimResponse.item.detail.detailSequence Element

    FHIR Specification

    • Short: Claim detail instance identifier
    • Definition: A number to uniquely reference the claim detail entry.
    • Requirements: Necessary to provide a mechanism to link the adjudication result to the submitted claim detail.
    • FHIR Type: positiveInt
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    traceNumber?: Identifier[]

    ClaimResponse.item.detail.traceNumber Element

    FHIR Specification

    • Short: Number for tracking
    • Definition: Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
    • Requirements: Allows partners to uniquely identify components for tracking.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    noteNumber?: PositiveIntType[]

    ClaimResponse.item.detail.noteNumber Element

    FHIR Specification

    • Short: Applicable note numbers
    • Definition: The numbers associated with notes below which apply to the adjudication of this item.
    • Requirements: Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.
    • FHIR Type: positiveInt
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    ClaimResponse.item.detail.reviewOutcome Element

    FHIR Specification

    • Short: Detail level adjudication results
    • Definition: The high-level results of the adjudication if adjudication has been performed.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    ClaimResponse.item.detail.adjudication Element

    FHIR Specification

    • Short: Detail level adjudication details
    • Definition: The adjudication results.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    ClaimResponse.item.detail.subDetail Element

    FHIR Specification

    • Short: Adjudication for claim sub-details
    • Definition: A sub-detail adjudication of a simple product or service.
    • Requirements: The adjudication for sub-details provided on the claim.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ClaimResponseItemDetailComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ClaimResponseItemDetailComponent

      ClaimResponseItemDetailComponent data model or undefined for ClaimResponseItemDetailComponent

      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