Sign in
Cases

Create Case

Create a case, resolving or creating its patient. Idempotent on external_id: a repeat returns the existing case unchanged.

post/api/v1/cases

Request body

external_idstring required
payorstring nullable
planstring nullable
member_idstring nullable
custom_dataobject
source_urlstring nullable

Response

Successful Response

idstring required
external_idstring required
status'IN_PROGRESS' | 'NEEDS_ACTION' | 'READY' | 'CANCELLED' required
patient_idstring required
payorstring nullable required
planstring nullable required
member_idstring nullable required
appointment_external_idstring nullable required
appointment_atstring date-time nullable required
appointment_typestring nullable required
cpt_codesstring[] required
locationobject required
providerobject required
custom_dataobject required
source_urlstring nullable required
closed_atstring date-time nullable required
created_atstring date-time required

Changes

Changed in 3 of the 12 revisions of this API.5

  • 6a15543258a52See the full diff
    • ○

      removed the BLOCKED enum value from the status response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the QUEUED enum value from the tasks/items/status response property for the response status 201

      response-property-enum-value-removed

  • 43f85a5ab3482See the full diff
    • ○

      added the new optional request property source_url

      new-optional-request-property

    • ○

      added the required property source_url to the response with the 201 status

      response-required-property-added

  • bd124844fd9f1See the full diff
    • ○

      endpoint added

      endpoint-added