Data Model Libraries
    Preparing search index...

    Class ExplanationOfBenefitProcessNoteComponent

    ExplanationOfBenefitProcessNoteComponent Class

    FHIR Specification

    • Short: Note concerning adjudication
    • Definition: A note that describes or explains adjudication results in a human readable form.
    • Requirements: Provides the insurer specific textual explanations associated with the processing.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    ExplanationOfBenefit.processNote.number Element

    FHIR Specification

    • Short: Note instance identifier
    • Definition: A number to uniquely identify a note entry.
    • Requirements: Necessary to provide a mechanism to link from adjudications.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    noteTypeEnum: NoteTypeEnum

    FHIR CodeSystem: NoteType

    type_?: EnumCodeType

    ExplanationOfBenefit.processNote.type Element

    FHIR Specification

    • Short: display | print | printoper
    • Definition: The business purpose of the note text.
    • Requirements: To convey the expectation for when the text is used.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: NoteTypeEnum

    text?: StringType

    ExplanationOfBenefit.processNote.text Element

    FHIR Specification

    • Short: Note explanatory text
    • Definition: The explanation or description associated with the processing.
    • Requirements: Required to provide human readable explanation.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    language?: CodeableConcept

    ExplanationOfBenefit.processNote.language Element

    FHIR Specification

    • Short: Language of the text
    • Definition: A code to define the language used in the text of the note.
    • Comment: Only required if the language is different from the resource language.
    • Requirements: Note text may vary from the resource defined language.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ExplanationOfBenefitProcessNoteComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ExplanationOfBenefitProcessNoteComponent

      ExplanationOfBenefitProcessNoteComponent data model or undefined for ExplanationOfBenefitProcessNoteComponent

      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