EVENT: Direct-to-SMS

Home » RxWare Developer Site » Case Updates API » EVENT: Direct-to-SMS

ENDPOINT: POST /v1/patients/{patientId}/event

Endpoint Example For the Case Updates API endpoint, you will need to replace the {patientId} variable with your patient's HA ID.
Example: POST /v1/patients/ha182039129/event

Direct-to-SMS Commands are utilized when you need to notify the patient via SMS about certain events that may occur during the patient’s journey.

Heads Up: For Direct-to-SMS commands, the value in the text field should be empty.

Here is an example of notifying a patient of a missed phone call:

				
					{
  "status": {
    "name": "notify.sms.missed.call",
    "text": ""
  },
  "phoneNumber": "{{test-user-phone-number}}",
  "externalId": "{{test-user-external-user-id}}",
  "supportProgramId": "{{partners-support-program-id}}"
}

Below are the notify.sms.* text field values that we currently support:

Text Field Values	Description
`notify.sms.no.answer`	Notify patient that an outreach was attempted but patient did not answer
`notify.sms.next.call`	Notify patient of an upcoming outreach call
`notify.sms.missed.call`	Notify patient of a missed call
`notify.sms.next.appointment`	Notify patient of their next appointment
`notify.sms.pap.end`	Notify patient of Patient Assistance Program ending
`notify.sms.pap.renew`	Notify patient of a need to renew their Patient Assistance Program application
`notify.sms.claims.pa.denied`	Notify patient that their prior authorization has been denied
`notify.sms.claims.pareq`	Notify patient that their prescription requires a prior authorization
`notify.sms.claims.pa.approved`	Notify patient that their prior authorization has been approved
`notify.sms.claims.update`	Notify patient of update on claims status
`notify.sms.claims.paid.pending`
`notify.sms.claims.paid`
`notify.sms.insurance.bv.process`	Notify patient that their insurance is in review
`notify.sms.insurance.approved`	Notify patient that their insurance has approved their prescription
`notify.sms.insurance.nocoverage`	Notify patient that their insurance is inactive
`notify.sms.copay.card`
`notify.sms.copay.enroll`
`notify.sms.tracker.update`
`notify.sms.shipped`	Notify patient of order shipped
`notify.sms.shipment`
`notify.sms.shipment.issue`	Notify patient of a shipment issue
`notify.sms.program.terms`	Notify patient of program terms & conditions
`notify.sms.pharmacy.info`	Notify patient of their pharmacy's contact info
`notify.sms.refill.reminder`	Notify patient that it is time to refill their prescription
`notify.sms.hcp.info`

NEXT: ➡️ Using the additionalData Field