Class PaymentNotice

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class PaymentNotice extends DomainResource
This resource provides the status of the payment for goods and services rendered, and the request and response resource references.
See Also:
  • Field Details

    • identifier

      A unique identifier assigned to this payment notice.
    • status

      The status of the resource instance.
    • request

      protected Reference request
      Reference of resource for which payment is being made.
    • requestTarget

      The actual object that is the target of the reference (Reference of resource for which payment is being made.)
    • response

      protected Reference response
      Reference of response to resource for which payment is being made.
    • responseTarget

      The actual object that is the target of the reference (Reference of response to resource for which payment is being made.)
    • created

      protected DateTimeType created
      The date when this resource was created.
    • provider

      protected Reference provider
      The practitioner who is responsible for the services rendered to the patient.
    • providerTarget

      The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)
    • payment

      protected Reference payment
      A reference to the payment which is the subject of this notice.
    • paymentTarget

      The actual object that is the target of the reference (A reference to the payment which is the subject of this notice.)
    • paymentDate

      protected DateType paymentDate
      The date when the above payment action occurred.
    • payee

      protected Reference payee
      The party who will receive or has received payment that is the subject of this notification.
    • payeeTarget

      protected Resource payeeTarget
      The actual object that is the target of the reference (The party who will receive or has received payment that is the subject of this notification.)
    • recipient

      protected Reference recipient
      The party who is notified of the payment status.
    • recipientTarget

      The actual object that is the target of the reference (The party who is notified of the payment status.)
    • amount

      protected Money amount
      The amount sent to the payee.
    • paymentStatus

      A code indicating whether payment has been sent or cleared.
    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: The business identifier of the notice
      Type: token
      Path: PaymentNotice.identifier

      See Also:
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: The business identifier of the notice
      Type: token
      Path: PaymentNotice.identifier

    • SP_REQUEST

      public static final String SP_REQUEST
      Search parameter: request

      Description: The Claim
      Type: reference
      Path: PaymentNotice.request

      See Also:
    • REQUEST

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REQUEST
      Fluent Client search parameter constant for request

      Description: The Claim
      Type: reference
      Path: PaymentNotice.request

    • INCLUDE_REQUEST

      public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUEST
      Constant for fluent queries to be used to add include statements. Specifies the path value of "PaymentNotice:request".
    • SP_PROVIDER

      public static final String SP_PROVIDER
      Search parameter: provider

      Description: The reference to the provider
      Type: reference
      Path: PaymentNotice.provider

      See Also:
    • PROVIDER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PROVIDER
      Fluent Client search parameter constant for provider

      Description: The reference to the provider
      Type: reference
      Path: PaymentNotice.provider

    • INCLUDE_PROVIDER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PROVIDER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "PaymentNotice:provider".
    • SP_CREATED

      public static final String SP_CREATED
      Search parameter: created

      Description: Creation date fro the notice
      Type: date
      Path: PaymentNotice.created

      See Also:
    • CREATED

      public static final ca.uhn.fhir.rest.gclient.DateClientParam CREATED
      Fluent Client search parameter constant for created

      Description: Creation date fro the notice
      Type: date
      Path: PaymentNotice.created

    • SP_RESPONSE

      public static final String SP_RESPONSE
      Search parameter: response

      Description: The ClaimResponse
      Type: reference
      Path: PaymentNotice.response

      See Also:
    • RESPONSE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RESPONSE
      Fluent Client search parameter constant for response

      Description: The ClaimResponse
      Type: reference
      Path: PaymentNotice.response

    • INCLUDE_RESPONSE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_RESPONSE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "PaymentNotice:response".
    • SP_PAYMENT_STATUS

      public static final String SP_PAYMENT_STATUS
      Search parameter: payment-status

      Description: The type of payment notice
      Type: token
      Path: PaymentNotice.paymentStatus

      See Also:
    • PAYMENT_STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam PAYMENT_STATUS
      Fluent Client search parameter constant for payment-status

      Description: The type of payment notice
      Type: token
      Path: PaymentNotice.paymentStatus

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The status of the payment notice
      Type: token
      Path: PaymentNotice.status

      See Also:
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: The status of the payment notice
      Type: token
      Path: PaymentNotice.status

  • Constructor Details

  • Method Details