Jump to

• Request
• Response

Create a financial transaction

post

/Basic

Creates a new financial transaction.

Note:

• Only the body fields mentioned below are supported. Unsupported fields are ignored, or can result in errors.
• When integrating your application with a customer's environment, the customer must provide the appropriate financial-transaction-alias values to send with the financial transaction.
• The Oracle Cerner Revenue Cycle Patient Accounting application must be in use at a customer site to create meaningful financial transactions.
• When creating financial transactions, a Basic OAuth2 token scope is required in addition to a FinancialTransaction Oauth2 token scope.

Authorization Types

This operation supports the following authorization types:

• Provider
• System

Request

Supported Media Types

• application/fhir+json

Header Parameters

• accept(required): string
  The media type to be requested. See what the resource's operation produces for what is supported.
• authorization(required): string
  Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

Body ()

Root Schema : FinancialTransactionCreate

Type: object

Show Source

• code(required): object code

  Identifies the type of resource, equivalent to the resource name for other resources.

• identifier(required): array identifier
  Minimum Number of Items: 1

  Identifier assigned to the resource for business purposes.

  Note:

  • At least one external transaction identifier must be provided.
  • The identifier can contain alphanumeric value and no special characters.
  • The length of the identifier cannot exceed 250 character.

• resourceType(required): string
  Allowed Values: [ "Basic" ]

  The type of the FHIR resource.

{
    "type":"object",
    "required":[
        "resourceType",
        "identifier",
        "code"
    ],
    "properties":{
        "resourceType":{
            "description":"<p>The type of the FHIR resource.</p>\n",
            "type":"string",
            "enum":[
                "Basic"
            ]
        },
        "identifier":{
            "description":"<p>Identifier assigned to the resource for business purposes.</p>\n<p><b>Note:</b> \n  <ul>\n     <li>At least one external transaction identifier must be provided.</li>\n     <li>The identifier can contain alphanumeric value and no special characters.</li>\n     <li>The length of the identifier cannot exceed 250 character.</li>\n  </ul>\n</p>\n",
            "type":"array",
            "minItems":"1",
            "items":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "example":"33358000"
                    },
                    "use":{
                        "type":"string",
                        "example":"usual"
                    }
                }
            }
        },
        "code":{
            "description":"<p>Identifies the type of resource, equivalent to the resource name for other resources.</p>\n",
            "type":"object",
            "properties":{
                "text":{
                    "type":"string"
                },
                "coding":{
                    "type":"array",
                    "minItems":"1",
                    "maxItems":"1",
                    "items":{
                        "type":"object",
                        "properties":{
                            "code":{
                                "type":"string",
                                "enum":[
                                    "FinancialTransaction"
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : code

Type: object

Identifies the type of resource, equivalent to the resource name for other resources.

Show Source

• coding: array coding
  Minimum Number of Items: 1

  Maximum Number of Items: 1
• text: string

{
    "description":"<p>Identifies the type of resource, equivalent to the resource name for other resources.</p>\n",
    "type":"object",
    "properties":{
        "text":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "minItems":"1",
            "maxItems":"1",
            "items":{
                "type":"object",
                "properties":{
                    "code":{
                        "type":"string",
                        "enum":[
                            "FinancialTransaction"
                        ]
                    }
                }
            }
        }
    }
}

Nested Schema : identifier

Type: array

Minimum Number of Items: 1

Identifier assigned to the resource for business purposes.

Note:

• At least one external transaction identifier must be provided.
• The identifier can contain alphanumeric value and no special characters.
• The length of the identifier cannot exceed 250 character.

Show Source

• Array of: object items

{
    "description":"<p>Identifier assigned to the resource for business purposes.</p>\n<p><b>Note:</b> \n  <ul>\n     <li>At least one external transaction identifier must be provided.</li>\n     <li>The identifier can contain alphanumeric value and no special characters.</li>\n     <li>The length of the identifier cannot exceed 250 character.</li>\n  </ul>\n</p>\n",
    "type":"array",
    "minItems":"1",
    "items":{
        "type":"object",
        "properties":{
            "value":{
                "type":"string",
                "example":"33358000"
            },
            "use":{
                "type":"string",
                "example":"usual"
            }
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 1

Show Source

• Array of: object items

{
    "type":"array",
    "minItems":"1",
    "maxItems":"1",
    "items":{
        "type":"object",
        "properties":{
            "code":{
                "type":"string",
                "enum":[
                    "FinancialTransaction"
                ]
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code: string
  Allowed Values: [ "FinancialTransaction" ]

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "enum":[
                "FinancialTransaction"
            ]
        }
    }
}

Nested Schema : items

Type: object

Show Source

• use: string
  Example: usual
• value: string
  Example: 33358000

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "example":"33358000"
        },
        "use":{
            "type":"string",
            "example":"usual"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/fhir+json

Default Response

Example creation of a cash payment.

Example Request:

POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Basic

Example Request 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.00,
          '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.00,
              '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.00,
          'currency': 'USD'
        }
      }
    ]
  }

Example Response:

  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: 11111111-1111-1111-1111-111111111111
  opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111

The ETag response header indicates the current If-Match version to use on a subsequent update.

Headers

• Etag: string
  For Update or Patch versioning controls. Related to If-Match. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
• X-Request-Id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

x-create-adjustment Response

Example creation of an adjustment.

Example Request:

POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Basic

Example Request 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.00,
              '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.00,
          'currency': 'USD'
        }
      }
    ]
  }

Example Response:

  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: 11111111-1111-1111-1111-111111111111
  opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111

The ETag response header indicates the current If-Match version to use on a subsequent update.

Headers

• Etag: string
  For Update or Patch versioning controls. Related to If-Match. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
• X-Request-Id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

x-create-card-payment Response

Example creation of a card payment.

Example Request:

POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Basic

Example Request 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.00,
          '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.00,
              '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'
      }
    ]
  }

Example Response:

  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: 11111111-1111-1111-1111-111111111111
  opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111

The ETag response header indicates the current If-Match version to use on a subsequent update.

Headers

• Etag: string
  For Update or Patch versioning controls. Related to If-Match. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
• X-Request-Id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

x-create-check-payment Response

Example creation of a check payment.

Example Request:

POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Basic

Example Request 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'
        }
      }
    ]
  }

Example Response:

  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: 11111111-1111-1111-1111-111111111111
  opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111

The ETag response header indicates the current If-Match version to use on a subsequent update.

Headers

• Etag: string
  For Update or Patch versioning controls. Related to If-Match. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
• X-Request-Id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

Back to Top