FinancialTransaction

• Overview
• Terminology Bindings
• Extensions
  • Custom Extensions
• Create
  • Authorization Types
  • Headers
  • Body Fields
  • Example - Cash Payment
  • Example - Card Payment
  • Example - Check Payment
  • Example - Adjustment
  • Errors

Overview

The FinancialTransaction resource provides the ability to record and exchange financial payment and adjustment information related to patient healthcare services. This is a custom resource implemented via extensions on the Basic resource.

Terminology Bindings

Basic.extension[x].valueCodeableConcept

Description The Category of Payment Type Codes. Whether this is a payment or adjustment. This binding is used in financial-transaction-type extensions. Details: Payment Type Codes System: http://terminology.hl7.org/CodeSystem/payment-type

Basic.extension[x].valueCodeableConcept

Description The payment method of the transaction. This binding is used in financial-transaction-method extensions. Details: v2 Payment Method Code System: http://terminology.hl7.org/CodeSystem/v2-0570

Basic.extension[x].valueMoney.currency

Description Currency codes from ISO 4217 (see https://www.iso.org/iso-4217-currency-codes.html). This binding is used for financial-transaction-tendered-amount extensions. Details: Currencies System: urn:iso:std:iso:4217

Basic.extension[x].valueMoney.currency

Description Currency codes from ISO 4217 (see https://www.iso.org/iso-4217-currency-codes.html). This binding is used for financial-transaction-amount extensions. Details: Currencies System: urn:iso:std:iso:4217

Basic.extension[x].extension[x].valueMoney.currency

Description Currency codes from ISO 4217 (see https://www.iso.org/iso-4217-currency-codes.html). This binding is used for amount extensions nested under financial-transaction-allocation extensions. Details: Currencies System: urn:iso:std:iso:4217

Extensions

• Apply First In First Out
• Financial Transaction Account Number
• Financial Transaction Alias
• Financial Transaction Allocation
• Financial Transaction Amount
• Financial Transaction Card Brand
• Financial Transaction Date
• Financial Transaction Location
• Financial Transaction Method
• Financial Transaction Tendered Amount
• Financial Transaction Type

Custom Extensions

All URLs for custom extensions are defined as https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}

ID	Value[x] Type	Description
apply-first-in-first-out	boolean	Whether to apply FIFO logic for recurring encounters or not.
financial-transaction-account-number	string	A value associated to the specific payment method usually represented as the last four digits of a credit card, the check number, the EFT number or Lockbox number.
financial-transaction-alias	string	Client defined value to represent the combination of the type, subtype, and reason describing the financial transaction.
financial-transaction-allocation	None (contains nested extensions)	Defines how the payment or adjustment is to be allocated across other resources.
financial-transaction-amount	Money	The total amount of the financial transaction.
financial-transaction-card-brand	string	Identifies the brand of credit card when credit card is used as a payment method.
financial-transaction-date	date	Represents the expiration date if method is card or check date if method is check.
financial-transaction-location	string	Client configured value representing the location or workflow that the payment was received in.
financial-transaction-method	string	Describes the method of payment for the financial transaction.
financial-transaction-tendered-amount	Money	The amount of cash originally tendered for payment. This value should be greater than or equal to the amount of the cash payment.
financial-transaction-type	CodeableConcept	The classification of the transaction.

Create

Create a FinancialTransaction.

POST /Basic    

Implementation Notes

• Only the body fields mentioned below are supported.
• When integrating your application with a client’s environment, the client will have to provide the appropriate financial-transaction-alias values to send with the financial transaction.
• Cerner’s Revenue Cycle Patient Accounting application must be in use at a client site in order to create meaningful FinancialTransactions.
• When creating FinancialTransactions, a Basic OAuth2 token scope is required in addition to a FinancialTransaction Oauth2 token scope.

Authorization Types

Headers

Authorization: <OAuth2 Bearer Token>
Content-Type: application/fhir+json

Body Fields

Name	Required	Type
resourceType	Yes	string
Description The type of the FHIR resource. Example { "resourceType": "Basic" } Notes resourceType must be Basic top of section
identifier	Yes	List of Identifier
Description Identifier assigned to the resource for business purposes. Example { "identifier": [ { "value": "33358000", "use": "usual" } ] } Notes At least one external transaction identifier must be provided. The identifier can contain alphanumeric value and no special characters. The length of the identifier can't exceed 250 character. top of section
code	Yes	CodeableConcept
Description Identifies the 'type' of resource - equivalent to the resource name for other resources. Example "code": { "coding": [ { "code": "FinancialTransaction" } ] } Notes This will always be FinancialTransaction top of section
FinancialTransaction Type Extension	Yes	CodeableConcept
Description Category of transaction, whether this is a payment or adjustment. Example { "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-type", "valueCodeableConcept": { "coding": [ { "code": "payment", "system": "http://terminology.hl7.org/CodeSystem/payment-type" } ] } } Notes Will only accept payment or adjustment. top of section
FinancialTransaction Alias Extension	Yes	string
Description The aliases used to create the FinancialTransaction resources. Example { "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-alias", "valueString": "0111" } Notes A value that correlates to a client defined name which represents the combination of the type, subtype, and reason describing the FinancialTransaction. The alias determines the credit or debit impact on the accounts receivable. A valid alias from the tenant is required to create a FinancialTransaction resource. top of section
FinancialTransaction Location Extension	No	string
Description The location where the payment was collected. Example { "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-location", "valueString": "98920358" } Notes These are client configured location values. top of section
FinancialTransaction Method Extension	Yes	CodeableConcept
Description The method of payment. Example { "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-method", "valueCodeableConcept": { "coding": [ { "code": "CHCK", "display": "Check", "system": "http://terminology.hl7.org/CodeSystem/v2-0570" } ], "text": "Check" } } Notes Required on payment transactions. Not required otherwise. Payment methods of Cash, Credit Card, Check, Cashier’s Check and Traveler’s Check will be supported for FinancialTransaction creates. top of section
FinancialTransaction Card Brand Extension	Yes	string
Description The brand of credit card used for the transaction. Example { "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-card-brand", "valueString": "VISA" } Notes Required on payment transactions when method is Credit Card. Not required otherwise. Acceptable values are "VISA", "MASTER", "AMEX", "DISCOVER". top of section
FinancialTransaction Account Number Extension	Yes	string
Description The last four digits of the credit card or the check number used for the transaction. Example { "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-account-number", "valueString": "1234" } Notes Required on payment transactions when method is Credit Card, Check, Cashier's Check, Traveler's Check and Money Order. Not required otherwise. Value must be numeric. top of section
FinancialTransaction Date Extension	Yes	date
Description Expiration date if method is credit card, check date if method is check. Example { "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-date", "valueDate": "2020-02-01" } Notes Required on payment transactions when method is Credit Card, Check, Cashier's Check and Traveler's Check. Not required otherwise. top of section
FinancialTransaction Tendered Amount Extension	Yes	Money
Description Tendered amount of the cash payment. Example { "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-tendered-amount", "valueMoney": { "value": 123.45, "currency": "USD" } } Notes Required on payment transactions when method is Cash. Not required otherwise. Must be greater than or equal to the value of the amount. top of section
FinancialTransaction Amount Extension	Yes	Money
Description The total amount of the payment/adjustment resource. Example { "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-amount", "valueMoney": { "value": 123.45, "currency": "USD" } } Notes Must equal the sum of all amounts in the financial-transaction-allocation extension. top of section
FinancialTransaction Allocation Extension	Yes	Extension
Description How the FinancialTransaction should be applied. This extension is a nested extension. Example { "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-allocation", "extension": [ { "url": "target", "valueReference": { "reference": "Encounter/97953536" } }, { "url": "amount", "valueMoney": { "value": 400.00, "currency": "USD" } } ] } Notes Only one allocation element will be used when creating the resource. top of section
FinancialTransaction Allocation Target Extension	Yes	Extension
Description The specific target that the payment or adjustment should be posted to. This extension is nested under a financial-transaction-allocation extension. Example { "url": "target", "valueReference": { "reference": "Encounter/97953536" } } Notes The valueReference.reference must be either an Encounter or Account reference. If the reference is of type Account, it must be a guarantor-balance account type. The URL for this extension is target. top of section
FinancialTransaction Allocation Amount Extension	Yes	Money
Description The total amount of the payment/adjustment resource. This extension is nested under a financial-transaction-allocation extension. Example { "url": "amount", "valueMoney": { "value": 123.45, "currency": "USD" } } Notes Must equal the sum of all amounts in the financial-transaction-allocation extension. top of section
Apply First In First Out Extension	No	Boolean
Description Whether to apply FIFO logic for recurring encounters or not. Example { "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/apply-first-in-first-out", "valueBoolean": true } Notes The default boolean value is 'true'. When the value is 'true' the system posts the payment across existing financial activity with any outstanding balances using FIFO logic. If there is no existing financial activity, the system creates a new financial activity for the current month and posts the payment to the new financial activity. If there is an existing financial activity with no outstanding balance, the system will post the payment to the latest month's financial activity. When the value is 'false' the system posts the payment to the current month's financial activity given it exists. If there is no existing financial activity, the system creates a new financial activity for the current month and posts the payment. Only supported for the Payment Transaction Type with target as Encounter Only supported for recurring encounters and not other types of encounters like inpatient, outpatient, etc. top of section

Example - Cash Payment

Request

POST /Basic

Body

{
  "resourceType": "Basic",
  "code": {
    "coding": [
      {
        "code": "FinancialTransaction"
      }
    ]
  },
  "identifier": [
    {
      "value": "14266754",
      "use": "usual"
    }
  ],
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-type",
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "payment",
            "system": "http://terminology.hl7.org/CodeSystem/payment-type"
          }
        ]
      }
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-method",
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "CASH",
            "display": "Cash",
            "system": "http://terminology.hl7.org/CodeSystem/v2-0570"
          }
        ],
        "text": "Cash"
      }
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-tendered-amount",
      "valueMoney": {
        "value": 12.0,
        "currency": "USD"
      }
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-allocation",
      "extension": [
        {
          "url": "target",
          "valueReference": {
            "reference": "Account/G63392574"
          }
        },
        {
          "url": "amount",
          "valueMoney": {
            "value": 12.0,
            "currency": "USD"
          }
        }
      ]
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-alias",
      "valueString": "0111"
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-location",
      "valueString": "98920358"
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-amount",
      "valueMoney": {
        "value": 12.0,
        "currency": "USD"
      }
    }
  ]
}

Response

Status: 201 Created

Cache-Control: no-cache
Content-Length: 0
Content-Type: application/fhir+json
Date: Mon, 04 Nov 2019 16:23:57 GMT
Etag: W/"0"
Last-Modified: Mon, 04 Nov 2019 16:23:57 GMT
Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Basic/FT-PL-14266754
Vary: Origin
X-Request-Id: 1638e30e497b93ff4383b2ff0eaeea68

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Example - Card Payment

Request

POST /Basic

Body

{
  "resourceType": "Basic",
  "code": {
    "coding": [
      {
        "code": "FinancialTransaction"
      }
    ]
  },
  "identifier": [
    {
      "value": "74389581",
      "use": "usual"
    }
  ],
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-type",
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "payment",
            "system": "http://terminology.hl7.org/CodeSystem/payment-type"
          }
        ]
      }
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-method",
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "CCCA",
            "display": "Credit Card",
            "system": "http://terminology.hl7.org/CodeSystem/v2-0570"
          }
        ],
        "text": "Credit Card"
      }
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-amount",
      "valueMoney": {
        "value": 12.0,
        "currency": "USD"
      }
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-date",
      "valueDate": "2005-01"
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-account-number",
      "valueString": "4321"
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-card-brand",
      "valueString": "visa"
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-allocation",
      "extension": [
        {
          "url": "target",
          "valueReference": {
            "reference": "Encounter/97953536"
          }
        },
        {
          "url": "amount",
          "valueMoney": {
            "value": 12.0,
            "currency": "USD"
          }
        }
      ]
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-alias",
      "valueString": "0111"
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-location",
      "valueString": "98920358"
    }
  ]
}

Response

Status: 201 Created

Cache-Control: no-cache
Content-Length: 0
Content-Type: application/fhir+json
Date: Mon, 04 Nov 2019 16:23:59 GMT
Etag: W/"0"
Last-Modified: Mon, 04 Nov 2019 16:23:59 GMT
Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Basic/FT-PL-74389581
Vary: Origin
X-Request-Id: 1638e30e497b93ff4383b2ff0eaeea69

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Example - Check Payment

Request

POST /Basic

Body

{
  "resourceType": "Basic",
  "code": {
    "coding": [
      {
        "code": "FinancialTransaction"
      }
    ]
  },
  "identifier": [
    {
      "value": "3335800133",
      "use": "usual"
    }
  ],
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-type",
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "payment",
            "system": "http://terminology.hl7.org/CodeSystem/payment-type"
          }
        ]
      }
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-method",
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "CCHK",
            "display": "Check",
            "system": "http://terminology.hl7.org/CodeSystem/v2-0570"
          }
        ],
        "text": "Check"
      }
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-date",
      "valueDate": "2020-01-02"
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-account-number",
      "valueString": "1234"
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-allocation",
      "extension": [
        {
          "url": "target",
          "valueReference": {
            "reference": "Encounter/97953536"
          }
        },
        {
          "url": "amount",
          "valueMoney": {
            "value": 12.12,
            "currency": "USD"
          }
        }
      ]
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-alias",
      "valueString": "0111"
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-location",
      "valueString": "98920358"
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-amount",
      "valueMoney": {
        "value": 12.12,
        "currency": "USD"
      }
    }
  ]
}

Response

Status: 201 Created

Cache-Control: no-cache
Content-Length: 0
Content-Type: application/fhir+json
Date: Mon, 04 Nov 2019 16:23:58 GMT
Etag: W/"0"
Last-Modified: Mon, 04 Nov 2019 16:23:58 GMT
Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Basic/FT-PL-3335800133
Vary: Origin
X-Request-Id: 1638e30e497b93ff4383b2ff0eaeea70

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Example - Adjustment

Request

POST /Basic

Body

{
  "resourceType": "Basic",
  "code": {
    "coding": [
      {
        "code": "FinancialTransaction"
      }
    ]
  },
  "identifier": [
    {
      "value": "3353423432432232",
      "use": "usual"
    }
  ],
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-type",
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "adjustment",
            "system": "http://terminology.hl7.org/CodeSystem/payment-type"
          }
        ]
      }
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-allocation",
      "extension": [
        {
          "url": "target",
          "valueReference": {
            "reference": "Encounter/97953536"
          }
        },
        {
          "url": "amount",
          "valueMoney": {
            "value": 1.0,
            "currency": "USD"
          }
        }
      ]
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-alias",
      "valueString": "3100"
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/financial-transaction-amount",
      "valueMoney": {
        "value": 1.0,
        "currency": "USD"
      }
    }
  ]
}

Response

Status: 201 Created

Cache-Control: no-cache
Content-Length: 0
Content-Type: application/fhir+json
Date: Mon, 04 Nov 2019 16:23:58 GMT
Etag: W/"0"
Last-Modified: Mon, 04 Nov 2019 16:23:58 GMT
Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Basic/FT-AL-3335800133
Vary: Origin
X-Request-Id: 1638e30e497b93ff4383b2ff0eaeea70

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Errors

The common errors and OperationOutcomes may be returned.