Skip to content

Get Case

Retrieve a single patient case record by its Spry case ID.

Endpoint

GET /apis/soap-enrichment/v1/patientCase/{spry_case_id}

Path Parameters

Parameter Type Required Description
spry_case_id string Yes The spry_case_id of the case (format: SPRY_CASE_<id>)

Request

curl --location '{base_url}/apis/soap-enrichment/v1/patientCase/SPRY_CASE_69cd0c97e7562d613ea89bc7' \
  --header 'Authorization: Bearer JWT_TOKEN'

Response

Success Response

Code: 200 OK

{
  "code": 2000,
  "data": {
    "created_date": "2026-04-01T12:16:23.032Z",
    "updated_date": "2026-04-01T12:50:23.691471Z",
    "id": "69cd0c97e7562d613ea89bc8",
    "spry_case_id": "SPRY_CASE_69cd0c97e7562d613ea89bc7",
    "case_title": "Stable Burst Fracture",
    "patient_id": 1172416,
    "specialization": "MSK",
    "affected_body_part_details": [],
    "patient_case_identifier": {
      "patient_id": 1172416,
      "case_title": "Stable Burst Fracture",
      "treatment_status": "ACTIVE"
    },
    "referring_physician_details": {
      "first_name": "MARK",
      "last_name": "STOUFFER",
      "npi": "1316131790",
      "ref_physician_id": 180513,
      "fax_number": "4356526025",
      "phone_number": "4356526024",
      "address1": "617 E RIVERSIDE DR STE 30",
      "address2": "",
      "city": "ST GEORGE",
      "state": "UT",
      "zip": "84790-7049"
    },
    "icd_codes": [
      {
        "id": 9676,
        "code": "M72.1",
        "description": "Knuckle pads",
        "revision": "ICD10"
      }
    ],
    "treating_icd_codes": [],
    "insurance_card_list": [
      {
        "insurance_card_id": 1089201,
        "insurance_payer": {
          "payer_reg_id": 2207,
          "name": "PEHP - Utah Public Employee Health Plan",
          "payer_id": "SX106"
        },
        "insurance_number": "M0000121643",
        "plan_start_date": "2025-09-01",
        "plan_end_date": "2026-08-31",
        "insurance_card_type": "PRIMARY"
      }
    ],
    "number_of_past_visits_for_this_case": 0,
    "treatment_status": "ACTIVE",
    "treatment_start_date": "2026-04-01",
    "date_of_injury": null,
    "date_of_surgery": null,
    "direct_access": false,
    "authorization_required": true,
    "auth_required_status": "NA",
    "payment_mode": null,
    "frequency_and_duration": null,
    "visit_track_required": false,
    "case_visit_limit": 0,
    "body_pain_notes": null,
    "created_at": "2026-04-01T12:16:23.032",
    "updated_at": "2026-04-01T12:50:23.68939",
    "organisation_id": 638
  },
  "message": "Success"
}

Response Fields

Field Type Description
id string Internal MongoDB document ID
spry_case_id string Spry case identifier (format: SPRY_CASE_<id>)
case_title string Title of the case
patient_id integer Patient ID
specialization string Specialization assigned to the case
affected_body_part_details array Affected body parts
patient_case_identifier object Summary with patient_id, case_title, and treatment_status
referring_physician_details object Resolved referring physician details
icd_codes array ICD-10 codes associated with the case
treating_icd_codes array ICD-10 codes being actively treated
insurance_card_list array Insurance cards associated with the case
number_of_past_visits_for_this_case integer Visits completed before this case was created
treatment_status string ACTIVE or DISCHARGED
treatment_start_date string Treatment start date (YYYY-MM-DD)
date_of_injury string Date of injury (YYYY-MM-DD), or null
date_of_surgery string Date of surgery (YYYY-MM-DD), or null
direct_access boolean Whether direct access is set
authorization_required boolean Whether prior authorization is required
auth_required_status string Authorization requirement status: AUTH_REQUIRED, AUTH_NOT_REQUIRED, AUTH_EXPIRED, or NA
payment_mode string Payment mode: INSURANCE_PAY, SELF_PAY, CASH, CARD, UPI, or WALLET
frequency_and_duration string Treatment frequency and duration description
visit_track_required boolean Whether visit tracking is enabled against an authorization
case_visit_limit integer Maximum visits allowed for the case (0 means no limit)
body_pain_notes string Clinical notes about the patient's condition
organisation_id integer Organization ID
created_at string Creation timestamp
updated_at string Last update timestamp

Error Response

Code: 200 OK

{
  "code": 4004,
  "data": null,
  "message": "Case not found"
}