Data Model Libraries
    Preparing search index...

    PaymentNotice Class

    This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

    FHIR Specification

    • Short: PaymentNotice request
    • Definition: This resource provides the status of the payment for goods and services rendered, and the request and response resource references.
    • FHIR Version: 4.0.1

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getRequest setRequest hasRequest getResponse setResponse hasResponse getCreatedElement setCreatedElement hasCreatedElement getCreated setCreated hasCreated getProvider setProvider hasProvider getPayment setPayment hasPayment getPaymentDateElement setPaymentDateElement hasPaymentDateElement getPaymentDate setPaymentDate hasPaymentDate getPayee setPayee hasPayee getRecipient setRecipient hasRecipient getAmount setAmount hasAmount getPaymentStatus setPaymentStatus hasPaymentStatus fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier

    Constructors

    Properties

    identifier?: Identifier[]

    PaymentNotice.identifier Element

    FHIR Specification

    • Short: Business Identifier for the payment noctice
    • Definition: A unique identifier assigned to this payment notice.
    • Requirements: Allows payment notices to be distinguished and referenced.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    fmStatusEnum: FmStatusEnum

    FHIR CodeSystem: FmStatus

    status: null | EnumCodeType

    PaymentNotice.status Element

    FHIR Specification

    • Short: active | cancelled | draft | entered-in-error
    • Definition: The status of the resource instance.
    • Comment: This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
    • Requirements: Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: FmStatusEnum

    request?: Reference

    PaymentNotice.request Element

    FHIR Specification

    response?: Reference

    PaymentNotice.response Element

    FHIR Specification

    • Short: Response reference
    • Definition: Reference of response to resource for which payment is being made.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    created: null | DateTimeType

    PaymentNotice.created Element

    FHIR Specification

    • Short: Creation date
    • Definition: The date when this resource was created.
    • Requirements: Need to record a timestamp for use by both the recipient and the issuer.
    • FHIR Type: dateTime
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    provider?: Reference

    PaymentNotice.provider Element

    FHIR Specification

    payment: null | Reference

    PaymentNotice.payment Element

    FHIR Specification

    • Short: Payment reference
    • Definition: A reference to the payment which is the subject of this notice.
    • Requirements: Need to identify the actual payment.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    paymentDate?: DateType

    PaymentNotice.paymentDate Element

    FHIR Specification

    • Short: Payment or clearing date
    • Definition: The date when the above payment action occurred.
    • Requirements: Need to convey the date when the action being notified occurred.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    payee?: Reference

    PaymentNotice.payee Element

    FHIR Specification

    recipient: null | Reference

    PaymentNotice.recipient Element

    FHIR Specification

    • Short: Party being notified
    • Definition: The party who is notified of the payment status.
    • Requirements: Need to identified the recipient of the notification.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    amount: null | Money

    PaymentNotice.amount Element

    FHIR Specification

    • Short: Monetary amount of the payment
    • Definition: The amount sent to the payee.
    • Requirements: Provided for validation purposes.
    • FHIR Type: Money
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    paymentStatus?: CodeableConcept

    PaymentNotice.paymentStatus Element

    FHIR Specification

    • Short: Issued or cleared Status of the payment
    • Definition: A code indicating whether payment has been sent or cleared.
    • Comment: Typically paid: payment sent, cleared: payment received.
    • Requirements: The purpose of the notification.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR PaymentNotice

      • OptionaloptSourceField: string

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

      Returns undefined | PaymentNotice

      PaymentNotice data model or undefined for PaymentNotice

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise