UserAction – PAP Enrollment

Home » RxWare Developer Site » Webhooks » UserAction – PAP Enrollment

ENDPOINT: POST /webhook/user-enrollment

After a patient or caregiver completes a PAP mini enrollment flow, RxWare sends the information gathered to the partner via a POST request.

Signature: The expected patient signature can be fetched via the ID that is provided in this PAP Enrollment callback.

See the Get Patient Media request for more details.

Sample Request

				
					{
  "event": {
    "message": "Patient complete pap enrollment.",
    "supportProgramId": "78ef982b-00ea-39c2-a875-f549c40e92ad",
    "sendDate": "2021-08-23T06:25:00+00:00",
    "status": "success",
    "patient": {
      "id": "ha61236024160af",
      "phoneNumber": "+12099999999",
      "firstName": "John",
      "lastName": "Doe",
      "dob": "1988-08-23T00:00:00+00:00",
      "gender": "male",
      "signature": {
        "timestamp": "2021-08-23T06:15:00+00:00",
        "image": "85219935-52b6-41a4-82ca-2f32ed709e5c"
      },
      "consents": [
        {
          "name": "fcra",
          "value": true,
          "timestamp": "2021-08-23T06:10:00+00:00"
        }
      ],
      "externalIds": [
        {
          "source": "partner",
          "sourceId": "Id_of_patient_in_partner_system"
        }
      ]
    }
  },
  "sourceName": "helparound",
  "eventName": "HelpAround.Patient.UserAction"
}

Field	Description	Format	Example	Required
`event.message`		String, 100 max	Patient complete pap enrollment.
`event.supportProgramId`		String, 100 max	78ef982b-00ea-39c2-a875-f549c40e92ad	✅ YES
`event.sendDate`	Send date in UTC	Datetime {yyyy-mm-ddT hh:mm:ss.sssZ}	2021-08-23T06:25:00+00:00	✅ YES
`event.status`		String, 100 max	success
`event.patient.id`	RxWare patient ID	String, 100 max	ha61b9db97350d1	✅ YES
`event.patient.phoneNumber`	Patient's mobile phone number	E.164 format	+12565551212	✅ YES
`event.patient.firstName`		String, max 100, ASCII 128	John	✅ YES
`event.patient.lastName`		String, max 100,ASCII 128	Doe	✅ YES
`event.patient.dob`		Datetime {yyyy-mm-ddT hh:mm:ss.sssZ}	1985-08-23T00:00:00+00:00
`event.patient.gender`	Additional gender designations may be added	String	"male" "female" "prefer_not_to_say"
`event.patient.signature.timestamp`	Signature date in UTC	Datetime {yyyy-mm-ddT hh:mm:ss.sssZ}	2021-08-23T06:25:00+00:00
`event.patient.signature.image`	Name of image for retrieval through Media API	String, max 100	“85219935-52b6-41a4-82ca-2f32ed709e5c”
`event.patient.consents`	Can take in multiple objects	Array
`event.patient.consents.name`	For HIPAA Consent: sharePHI For FCRA: fcra For Marketing Communications Consent: marketing For TCPA: communication	String	"fcra"
`event.patient.consents.value`		Boolean	True
`event.patient.consents.timestamp`		Datetime {yyyy-mm-ddT hh:mm:ss.sssZ}	2021-08-23T06:25:00+00:00
`event.patient.externalIds`	Can take in multiple objects	Array
`event.patient.externalIds.source`		String, max 100	Partner
`event.patient.externalIds.sourceId`	Partner patient Id(s)	String, max 100	4aadb997-e9fd-3909-a2f0-833b821544bd
`event.sourceName`		String, max 100	helparound
`event.eventName`		String, max 100	Helpround.Patient.CompleteEnrollment	✅ YES