Add Case¶

Create a new patient case with specialization, referring physician, ICD codes, and insurance details.

Endpoint¶

POST /apis/soap-enrichment/v1/patientCase

Request Body¶

Parameter	Type	Required	Description
`patient_id`	integer	Yes	Unique identifier of the patient
`case_title`	string	Yes	Title/name for the case
`specialization`	string	Yes	Specialization category (see Supported Values); must be enabled for the organization
`direct_access`	boolean	No	Set to `true` if the referring physician is marked as Direct Access
`referring_physician_details`	object	No	Details of the referring physician (see Referring Physician Object)
`icd_codes`	array	No	List of ICD-10 diagnosis codes (see ICD Code Object)
`treating_icd_codes`	array	No	ICD-10 codes being actively treated (same format as `icd_codes`; distinct from diagnostic codes)
`number_of_past_visits_for_this_case`	integer	No	Number of visits already completed before this case was created
`treatment_start_date`	string (date)	No	Treatment start date in `YYYY-MM-DD` format
`date_of_injury`	string (date)	No	Date of injury in `YYYY-MM-DD` format
`date_of_surgery`	string (date)	No	Date of surgery in `YYYY-MM-DD` format
`insurance_card_list`	array	No	Insurance cards to associate with the case (see Insurance Card Object)
`treatment_status`	string	No	`ACTIVE` or `DISCHARGED`
`payment_mode`	string	No	How the case is paid: `INSURANCE_PAY`, `SELF_PAY`, `CASH`, `CARD`, `UPI`, or `WALLET`
`frequency_and_duration`	string	No	Treatment frequency and duration (e.g., `"3x/week for 6 weeks"`)
`visit_track_required`	boolean	No	Whether visit count should be tracked against an authorization
`case_visit_limit`	integer	No	Maximum number of visits allowed for this case
`body_pain_notes`	string	No	Clinical notes about the patient's pain or condition
`affected_body_part_details`	array	No	List of affected body parts (strings)
`clinic_id`	integer	No	Clinic to associate with the case
`secondary_referring_physician_details`	object	No	Secondary referring physician (same format as `referring_physician_details`)
`tertiary_referring_physician_details`	object	No	Tertiary referring physician (same format as `referring_physician_details`)

Referring Physician Object¶

Parameter	Type	Required	Description
`referring_physician_id`	integer	Yes	Referring physician ID from Spry; must be non-null and non-zero
`first_name`	string	No	First name
`last_name`	string	No	Last name
`npi`	integer	No	NPI number of the physician
`fax_number`	integer	No	Fax number
`phone_number`	integer	No	Phone number
`address1`	string	No	Address line 1
`address2`	string	No	Address line 2
`city`	string	No	City
`state`	string	No	2-letter state code (e.g., `UT`)
`zip`	integer	No	ZIP code

ICD Code Object¶

Parameter	Type	Required	Description
`id`	integer	Yes	ICD code ID from Spry (must be non-null and non-zero); use the Search ICD Codes endpoint to look up valid IDs
`code`	string	Yes	Actual ICD-10 code (e.g., `M25.50`)
`description`	string	No	Description of the diagnosis
`revision`	string	Yes	Always `"ICD10"`

Insurance Card Object¶

Pass the insurance object as returned by the Get Insurance Cards endpoint, plus the following additional field:

Parameter	Type	Required	Description
`insurance_card_type`	string	Yes	`PRIMARY`, `SECONDARY`, or `TERTIARY`

Request¶

curl --location '{base_url}/apis/soap-enrichment/v1/patientCase' \
  --header 'Authorization: Bearer JWT_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "patient_id": 1172416,
    "case_title": "Stable Burst Fracture",
    "specialization": "MSK",
    "direct_access": false,
    "referring_physician_details": {
      "referring_physician_id": 180513,
      "first_name": "MARK",
      "last_name": "STOUFFER",
      "npi": 1316131790,
      "fax_number": 4356526025,
      "phone_number": 4356526024,
      "address1": "617 E RIVERSIDE DR STE 30",
      "address2": "",
      "city": "ST GEORGE",
      "state": "UT",
      "zip": 84790
    },
    "icd_codes": [
      {
        "id": 9676,
        "code": "M72.1",
        "description": "Knuckle pads",
        "revision": "ICD10"
      }
    ],
    "number_of_past_visits_for_this_case": 0,
    "treatment_start_date": "2026-04-01",
    "date_of_injury": null,
    "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"
      }
    ],
    "treatment_status": "ACTIVE"
  }'

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": [],
    "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": null,
    "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 object with `patient_id`, `case_title`, and `treatment_status`
`referring_physician_details`	object	Resolved physician details
`icd_codes`	array	ICD codes associated with the case
`treating_icd_codes`	array	ICD codes being actively treated
`insurance_card_list`	array	Insurance cards associated with the case
`treatment_status`	string	`ACTIVE` or `DISCHARGED`
`treatment_start_date`	string	Treatment start date
`date_of_injury`	string	Date of injury
`date_of_surgery`	string	Date of surgery
`direct_access`	boolean	Whether direct access is set
`authorization_required`	boolean	Whether authorization is required
`auth_required_status`	string	Authorization requirement status: `AUTH_REQUIRED`, `AUTH_NOT_REQUIRED`, `AUTH_EXPIRED`, or `NA`
`payment_mode`	string	Payment mode for this case
`frequency_and_duration`	string	Treatment frequency and duration description
`visit_track_required`	boolean	Whether visit tracking is enabled
`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: 400 Bad Request

{
  "code": 4000,
  "message": "Error description",
  "data": null
}

Specialization Values¶

The allowed values depend on which specializations are enabled for your organization. Common values:

Value	Description
`MSK`	Musculoskeletal
`CHIROPRACTOR`	Chiropractic
`LYMPHATIC`	Lymphatic therapy
`VESTIBULAR`	Vestibular therapy
`PEDIATRIC`	Pediatric therapy

To retrieve the list of specializations enabled for your organization, use the List Specializations endpoint.

Notes¶

specialization must be one of the values enabled for the organization; submitting an unsupported value will result in an error.
referring_physician_id inside referring_physician_details must be a valid non-null, non-zero integer.
Each object in icd_codes must have a valid non-null, non-zero id; use the Search ICD Codes endpoint to find valid IDs.
insurance_card_list entries should be taken directly from the Get Insurance Cards response with an insurance_card_type field added.