PAparticlehealth
Subscriptions

Trigger Sandbox Workflow [Sandbox only]

Changed on

🚧 Sandbox only. This endpoint is available only in the Sandbox environment and is not available in Production.

post/api/v1/patients/{particle_patient_id}/subscriptions/trigger-sandbox-workflow

Request

  • Base URL
    https://sandbox.particlehealth.com
  • URL
    https://sandbox.particlehealth.com/api/v1/patients/{particle_patient_id}/subscriptions/trigger-sandbox-workflow
  • Auth
    API key in header Authorization

Path parameters

particle_patient_idstring required

Particle Patient ID

Request body

callback_urlstring

Optional. Only used when neither your project nor its parent organization has a callback endpoint registered for this alert type: the URL is registered on your project and the alert is sent there. Without a registered endpoint or a callback_url, the request returns 400. Otherwise alerts go to the registered endpoints.

display_namestring

Optional. Names the endpoint registered from callback_url. Defaults to "Sandbox <workflow>".

event_typestring

Valid Event Type values: A01, A02, A03, A04, A08 (required when workflow is ADT)

workflowstring

Valid Workflow values: ADT, NETWORK_ALERT, TRANSITION_ALERT, MEDICATION_FILLS_ALERT. All other values return 400, including the removed NEW_ENCOUNTER_ALERT, REFERRAL_ALERT, DISCHARGE_SUMMARY_ALERT, ADMIT_TRANSITION_ALERT, DISCHARGE_TRANSITION_ALERT, TRANSFER_TRANSITION_ALERT, and AI_OUTPUTS.

Response

OK

callback_urlsstring[]

The callback endpoints registered on your project that the alert was sent to. Endpoints registered on your parent organization also receive the alert but are not listed. Omitted when the only endpoint for the alert type is organization-level.

messagestring required
query_idstring

The ID of the query the workflow started. Omitted for workflows that don't run a query, such as ADT.

Changes

  • b59a5413a488Revision changes
    • breaking

      the response's body type changed from string to object for status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status