Outreach Management API

Cancel all outstanding outreaches for a patient

Cancel all outstanding outreaches for a patient identified by external_contact_id.

Authentication: This endpoint supports dual authentication methods:

  • Auth0 JWT Bearer Token: For partners using Auth0 authentication

    • Header: Authorization: Bearer <JWT_TOKEN>
    • Token must include partner_id claim
    • Token is validated for signature, expiration, issuer, and audience
  • Verification Token: For partners using legacy authentication

    • Header: verification-token: <ENCRYPTED_TOKEN>
    • Token format: partner_id:verification_token (encrypted)
    • Validated against partner credentials

Your partner account is configured for one of these methods. Please use the authentication method assigned to your account. If you attempt to use the wrong method, you will receive a 401 Unauthorized error.

Behavior: All active outreaches for the patient are cancelled in a single request. The response includes the list of cancelled outreach IDs and their updated status.

Response Codes:

  • 200 OK: Successfully cancelled one or more outreaches
  • 404 Not Found: Patient not found OR no outstanding outreaches found
  • 401 Unauthorized: Authentication failed or wrong authentication method used
  • 500 Internal Server Error: Server error during processing

Request Body:

{
    "external_contact_id": "MRN123456",
    "reason": "Patient requested cancellation"  // Optional
}

Success Response (200):

{
    "version": "1.0",
    "status": "success",
    "message": "Successfully cancelled 2 outreach(es)",
    "cancelled_outreaches": [
        {"outreach_id": "uuid-1", "status": "archived"},
        {"outreach_id": "uuid-2", "status": "archived"}
    ],
    "patient_id": "patient-uuid"
}

Error Response (404):

{
    "detail": "No outstanding outreaches found for patient"
}
post/api/v1/outreach/cancel

Request

  • Base URL
    https://api.hippocraticai.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

external_contact_idstring required

External contact ID (MRN)

reasonstring nullable

Reason for cancellation

Response

Successful Response

versionstring

API version

statusstring required

Overall status: 'success', 'not_found', or 'error'

messagestring required

Human-readable status message

patient_idstring nullable

HAI patient ID (for debugging)

Changes

No recorded changes to this operation across all 1 revision of this API.