1. FHIR R4 APIs for Oracle Health Millennium Platform
  2. Tasks
  3. Account

Get a list of accounts

get

/Account/

Retrieves a list of accounts that meet supplied query parameters.

Note:

  • The account-balance extension is only returned on statement, guarantor-balance, and insurance-benefit types.
  • Account.subject is only returned on statement and financial-account types.
  • You may search with one of the following parameters:
    • _id
    • -encounter and type=guarantor-balance
    • patient, identifier, and type=statement
    • -guarantor and type=financial-account

Authorization Types

This operation supports the following authorization types:

Request

Query Parameters

  • The logical resource ID of the clinical encounter.

    Example: -encounter=98028029

  • The parties responsible for balancing the account. This parmeter should contain a reference to a related person.

    Example: -guarantor=6330015-6330017

  • The maximum number of results to return.

    Example: _count=15

    Default Value: 10
  • Minimum Number of Items: 1

    The logical resource ID associated with the resource.

    Example: _id=12345

  • The alias of the account. The system must be https://fhir.cerner.com/<EHR_source_id>/statement-number.

    Example: identifier=https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/statement-number|500000078

  • The entity that caused the expenses.

    Example: patient=Patient/12345

  • The specific type of account.

    Example: type=financial-account

Header Parameters
Back to Top

Response

Supported Media Types

200 Response

OK

Headers
Body
Example Response (application/fhir+json)
{
    "resourceType":"Bundle",
    "id":"43d52c34-385f-4871-889d-f974b2422fab",
    "type":"searchset",
    "total":"1",
    "link":[
        {
            "relation":"self",
            "url":"https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Account?patient=6330017&identifier=https%3A%2F%2Ffhir.cerner.com%2Fec2458f2-1e24-41c8-b71b-0e701af7583d%2FcodeSet%2F28200%7C68002&type=statement"
        }
    ],
    "entry":[
        {
            "fullUrl":"https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Account/S2580833",
            "resource":{
                "resourceType":"Account",
                "id":"S2580833",
                "text":{
                    "status":"generated",
                    "div":"<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Account</b></p><p><b>Account Type</b>: statement</p><p><b>Service Period Start Date</b>: Aug 13, 2019  3:01 P.M. UTC</p><p><b>Statement Number</b>: 68002</p><p><b>Guarantor</b>: 6330015-6330017</p></div>"
                },
                "extension":[
                    {
                        "url":"https://fhir-ehr.cerner.com/r4/StructureDefinition/account-balance",
                        "valueMoney":{
                            "value":"2000.00",
                            "currency":"USD"
                        }
                    },
                    {
                        "url":"https://fhir-ehr.cerner.com/r4/StructureDefinition/account-state",
                        "valueCodeableConcept":{
                            "coding":[
                                {
                                    "system":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4002640",
                                    "code":"20752989",
                                    "display":"Pending",
                                    "userSelected":true
                                }
                            ],
                            "text":"Pending"
                        }
                    },
                    {
                        "url":"https://fhir-ehr.cerner.com/r4/StructureDefinition/account-related-parts",
                        "valueReference":{
                            "reference":"Account/G2572738"
                        }
                    }
                ],
                "identifier":[
                    {
                        "use":"usual",
                        "system":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/statement-number",
                        "value":"68002"
                    }
                ],
                "status":"active",
                "type":{
                    "text":"statement"
                },
                "subject":[
                    {
                        "reference":"Patient/6330017"
                    }
                ],
                "servicePeriod":{
                    "start":"2019-08-13T15:01:17Z"
                },
                "owner":{
                    "reference":"Organization/1259855"
                },
                "guarantor":[
                    {
                        "party":{
                            "reference":"RelatedPerson/6330015-6330017"
                        }
                    }
                ]
            }
        }
    ]
}

Default Response

An OperationOutcome describing any error that occurred.
Headers
  • 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.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : issue
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : details
Type: object
Show Source
Nested Schema : location
Type: array
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top