1.0.0 - release

CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Payments

Introduction

The payments domain concerns payments that are made for a patient visit (encounter). The main use cases supported are to retrieve payment details and indicating that a successful payment has been performed.

To enable a more detailed structure of contact, unit and issuing organization of the invoice, the resources EncounterSelfService and OrganizationInvoice are supported as contained resources within an invoice.

Included Profiles

  • InvoiceSe - Profile for retrieving payment details for a selected encounter.
  • ​EncounterSelfService - Includes encounter id and additional details needed for arrival registration and making payment for the visit.
  • ​OrganizationInvoice - Contains details about the issuing organization of the invoice
  • ​ChargeitemSe - The purpose of this profile is to maintain the relationship between the invoice and the encounter resources.
  • TaskRegisterPayment - Profile for registering that an encounter has been successfully been paid for.

Use Cases

  • Get payment information for a patient visit.
  • Register that a successful payment for an encounter has been performed.

Demarcations

  • Invoice does not contain any information regarding the appointment.
  • The API will return an error if the encounter (contact in COSMIC) is in 'Registered' or 'Booked' status.