Skip to main content
POST
/
encounters
/
status
curl -X 'POST' \
  'http://localhost:5001/encounters/status' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <your_access_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "encounter_id": 2
}'

{
  "encounter_id": 2,
  "gfe_no": "EN-1764655275731",
  "gfe_data": [
    {
      "category_name": "Prescription Meds",
      "sub_category_name": "Hair Loss",
      "status": "pending_review"
    }
  ],
  "order_details": {
    "order_no": "ORD-1764655275834",
    "order_status": "paid",
    "sub_total": 30,
    "grand_total": 35,
    "paid_amt": 35,
    "balance_amt": 0,
    "total_shipping_amt": 5,
    "created_date": "2025-12-02 06:01:15"
  }
}

​
Overview

Retrieve the current status of an encounter by providing one of: Encounter ID, GFE No, or Order No. This endpoint requires authentication to identify the tenant context.

​
Headers

This endpoint uses Machine-to-Machine (M2M) authentication.
​
Authorization
string
required
Standard Bearer token (e.g., Bearer <your_access_token>). See the M2M Authentication guide for details.
​
Content-Type
string
required
Must be set to application/json.

​
Request Body

This endpoint accepts a JSON request body with one of the following identifiers. At least one is required.
​
encounter_id
integer
The numeric ID of the encounter to retrieve status for.
​
gfe_no
string
The GFE (Good Faith Estimate) identifier (e.g., EN-1764655275731).
​
order_id
string
The order number (e.g., ORD-1764655275834).
curl -X 'POST' \
  'http://localhost:5001/encounters/status' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <your_access_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "encounter_id": 2
}'

​
Response Parameters

​
encounter_id
integer
The ID of the encounter.
​
gfe_no
string
The GFE identifier associated with the encounter.
​
gfe_data
array
An array of objects describing the GFE categories and status.
​
gfe_data[].category_name
string
The top-level category for the GFE item.
​
gfe_data[].sub_category_name
string
The sub-category name for the GFE item.
​
gfe_data[].status
string
Status for the specific GFE item (e.g., “pending_review”).
​
order_details
object
Details for the order associated with the encounter (if any).
​
order_details.order_no
string
The order number.
​
order_details.order_status
string
The current order status (e.g., “paid”, “pending”).
​
order_details.sub_total
number
Sub-total amount for the order.
​
order_details.grand_total
number
Grand total amount for the order.
​
order_details.paid_amt
number
Total amount paid for the order.
​
order_details.balance_amt
number
Remaining balance for the order.
​
order_details.total_shipping_amt
number
Total shipping amount charged on the order.

​
Status Codes

StatusDescription
200Success. Encounter status retrieved successfully.
400Bad Request. Invalid payload or missing required identifier.
401Unauthorized. Invalid or missing authentication token.
403Forbidden. Insufficient permissions to view this encounter.
{
  "encounter_id": 2,
  "gfe_no": "EN-1764655275731",
  "gfe_data": [
    {
      "category_name": "Prescription Meds",
      "sub_category_name": "Hair Loss",
      "status": "pending_review"
    }
  ],
  "order_details": {
    "order_no": "ORD-1764655275834",
    "order_status": "paid",
    "sub_total": 30,
    "grand_total": 35,
    "paid_amt": 35,
    "balance_amt": 0,
    "total_shipping_amt": 5,
    "created_date": "2025-12-02 06:01:15"
  }
}