InvoiceSe(version 2)

Introduction

The Invoice resource contains the payment details related to a single patient visit. The profile is based on the Invoice in FHIR STU4 edition.

Intended Use

The Invoice resource returns relevant cost for the patient visit. It contains three extensions to include additional details about the payments.

Specific Rules and Limitations

Type Description
Rule N/A

Profile Overview

InvoiceSe(Version 2)

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueCodeableConceptCodeableConcept
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueCodingCoding
paymentMethodOptionI0..*Extension(Complex)
modifierExtension?! I0..*Extension
identifierΣ0..0Identifier
statusΣ ?!1..1codeBinding
cancelledReason0..0string
typeΣ0..0CodeableConcept
subjectΣ I1..1Reference(Patient)
recipientΣ I0..0Reference(Organization)
dateΣ0..1dateTime
issuerI0..1Reference(OrganizationInvoiceSe)
accountI0..0Reference(https://fhir.cambio.se/StructureDefinition/AccountSe)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
sequence0..0positiveInt
chargeItemReferenceReference(ChargeItemSe(Version 2))
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
type1..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
factor0..1decimal
id0..1string
extensionI0..*Extension
valueΣ0..1decimal
currencyΣ0..1codeBindingFixed Value
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
type1..1codeBindingFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeBindingFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
factor0..1decimal
id0..1string
extensionI0..*Extension
valueΣ0..1decimal
currencyΣ0..1codeBindingFixed Value
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
type1..1codeBindingFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeBinding
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
factor0..1decimal
id0..1string
extensionI0..*Extension
valueΣ0..1decimal
currencyΣ0..1codeBindingFixed Value
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
type1..1codeBindingFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeBinding
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
factor0..1decimal
id0..1string
extensionI0..*Extension
valueΣ0..1decimal
currencyΣ0..1codeBindingFixed Value
totalPriceComponent0..0see (priceComponent)
id0..1string
extensionI0..*Extension
valueΣ0..1decimal
currencyΣ0..1codeBindingFixed Value
paymentTerms0..0markdown
note0..0Annotation

Versions

COS version Profile version Required COSMIC version Date Description
3.3.0 2.0.0 R8.3.04 Oct 2022 This version uses the latest version of the Payment options extension.

Extensions

Extension Data type ValueSet Description
Common-businessStatus Fixedvalues InvoiceBusinessStatus Optional extension element to indicate the status of the payment status of the contact.
Invoice-paymentMethodOption (V2) Complex PaymentMethodOptions Extension which keeps information about payment type and possibility of using it. When compared with the v1, the main difference is, the v2 is a complex extension and it has two sub extensions where one can keep the payment type and the other extension keeps a boolean value to show that payment type is possible or not
Invoice-registeredPaymentMethod Fixedvalues Registered_Payment_Method Extension to indicate the payment method used for making the payment for the visit.

Mapping for Payment Types

FHIR status Status in COSMIC
base patient
surcharge invoice
discount reduction
surcharge other(amount >0)
discount other(amount <0)

Supported Operations

HTTP Methods

Method Description
GET Search for invoice using patient id and encounter id.

Query Operations

Search Parameters

Parameter Format Comment
subject string The subject that the inovice is about (patient)
encounter string Contact id of the visit
profile string Profile to be used when returning data

Supported Queries

  1. GET [baseURL]/invoice_search?subject={}&encounter={}&_profile=https://fhir.cambio.se/StructureDefinition/InvoiceSe/v2 (search)

Supported SearchInclude Operations

N/A

Supported RevInclude Operations

N/A

Error Codes

Specific error messages for InvoiceSe are listed below.

Code Description Comment
400 Occurs due to invalid query parameters E.g. patientId and contactId are not related to the same patient, contact does not exist, contact is not in registered or in booked state, the profile canonical URL is unsupported