Enrollment

Home » RxWare Developer Site » Webhooks » Enrollment

ENDPOINT: POST /webhook/user-enrollment

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

Media data: expected media files (e.g. insurance card, signature) can be fetched via IDs that are provided in this Enrollment API Post.

See the Get Patient’s Media request

Field	Description	Format	Example	Required
`event.message`		String, 100 max	Patient completed enrollment	No
`event.supportProgramId`		String, 100 max	b1mTs000g35ha2pt	✅ 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	No
`event.patient.gender`	Additional gender designations may be added	String	"male" "female" "prefer_not_to_say"	No
`event.patient.contactMethod`		String	phone "email"	No
`event.patient.prefLanguage`		String		No
`event.patient.email`		String		No
`event.patient.callTime`		String	morning "afternoon"	No
`event.patient.canLeaveMessage`		Boolean	true false	No
`event.patient.caregiver.name`		String	John Doe	No
`event.patient.caregiver.relationship`		String, case insensitive	Parent "Legal Guardian" "Power of Attorney" "Spouse"	No
`event.patient.caregiver.phone`	Caregiver's mobile phone	E. 164 format	+12565551212	No
`event.patient.caregiver.email`		String, max 50		No
`event.patient.secondaryCaregiver.name`		String	John Doe	No
`event.patient.secondaryCaregiver.relationship`		String, case insensitive	Parent "Legal Guardian" "Power of Attorney" "Spouse"	No
`event.patient.secondaryCaregiver.phone`	Caregiver's mobile phone	E. 164 format	+12565551212	No
`event.patient.secondaryCaregiver.email`		String, max 50		No
`event.patient.address.street`		String, max 100	512 Oak St.	No
`event.patient.address.apt`		String, max 100	#15	No
`event.patient.address.city`		String, max 100	Huntsville	No
`event.patient.address.state`		String, max 2	AL	No
`event.patient.address.zip`		String, max 5	35803	No
`event.patient.insurance.primaryInsurance.carrier`	Name of primary payer or insurance company of patient	String, max 100	Aetna	No
`event.patient.insurance.primaryInsurance.member_id`		String, max 100	5029375829	No
`event.patient.insurance.primaryInsurance.group_num`		String, max 100	H3569	No
`event.patient.insurance.primaryInsurance.cardname`		String, max 100	Jackie Doe	No
`event.patient.insurance.primaryInsurance.card_dob`		Datetime {yyyy-mm-ddT hh:mm:ss.sssZ}	1985-08-23T00:00:00+00:00	No
`event.patient.insurance.primaryInsurance.front_picture_image`				No
`event.patient.insurance.primaryInsurance.back_picture_image`				No
`event.patient.insurance.secondaryInsurance.status`		String, max 100	active "inactive"	No
`event.patient.insurance.secondaryInsurance.carrier`		String, max 100	Blue Cross	No
`event.patient.insurance.secondaryInsurance.member_id`		String, max 100	789337688	No
`event.patient.insurance.secondaryInsurance.group_num`		String, max 100	K8937	No
`event.patient.insurance.secondaryInsurance.cardname`		String, max 100	Jackie Doe	No
`event.patient.insurance.secondaryInsurance.card_dob`		Datetime {yyyy-mm-ddT hh:mm:ss.sssZ}	1985-08-23T00:00:00+00:00	No
`event.patient.insurance.secondaryInsurance.front_picture_image`	Name of image for retrieval through Media API	String, max 100	“fc497e96-9f09-4c2a-a964-89c6f7473f4d”	No
`event.patient.insurance.secondaryInsurance.back_picture_image`	Name of image for retrieval through Media API	String, max 100	“5405ec11-c9d0-4279-82db-2f70f959b904”	No
`event.patient.signature.timestamp`	Signature date in UTC	Datetime {yyyy-mm-ddT hh:mm:ss.sssZ}	2021-08-23T06:25:00+00:00	No
`event.patient.signature.image`	Name of image for retrieval through Media API	String, max 100	“85219935-52b6-41a4-82ca-2f32ed709e5c”	No
`event.patient.consents`	Can take in multiple objects	Array		No
`event.patient.consents.name`	For HIPAA Consent: `sharePHI` For FCRA: `fcra` For Marketing Communications Consent: `marketing` For TCPA: `communication`	String	"communication" "sharePHI" "fcra" "marketing"	No
`event.patient.consents.value`		Boolean	true	No
`event.patient.consents.timestamp`		Datetime {yyyy-mm-ddT hh:mm:ss.sssZ}	2021-08-23T06:25:00+00:00	No
`event.patient.externalIds`	Can take in multiple objects	Array		No
`event.patient.externalIds.source`		String, max 100	Partner	No
`event.patient.externalIds.sourceId`	Partner patient Id(s)	String, max 100	4aadb997-e9fd-3909-a2f0-833b821544bd	No
`event.patient.mediaIds`	Can take in multiple objects	Array		No
`event.patient.mediaIds.mediaType`		String, max 100	insurance, "consent"	No
`event.patient.mediaIds.mediaId`	identifier of media file	String, max 100	6253d25de50dcab75b08f0b2	No
`event.patient.mediaIds.fileType`		String, max 100	jpg, "jpeg", "gif", "png", "pdf".	No
`event.sourceName`		String, max 100	helparound	No

Sample Request

				
					{
  "event": {
    "message": "Patient complete 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",
      "contactMethod": "Phone",
      "prefLanguage": "English",
      "email": "test@gmail.com",
      "callTime": "Morning",
      "canLeaveMessage": true,
      "caregiver": {
        "firstName": "test",
        "lastName": "foo",
        "relationship": "Parent",
        "phoneNumber": "+12099999999",
        "email": "test@gmail.com"
      },
      "secondaryCaregiver": {
        "firstName": "test",
        "lastName": "foo",
        "relationship": "Parent",
        "phoneNumber": "+12099999999",
        "email": "test@gmail.com"
      },
      "address": {
        "street": "test",
        "apt": "12",
        "city": "test",
        "state": "AL",
        "zip": "12345"
      },
      "insurance": {
        "primaryInsurance": {
          "carrier": "test",
          "memberId": "123",
          "groupNum": "ds43",
          "cardname": "test",
          "cardDob": "2020-08-23T06:25:00+00:00",
          "frontPictureImage": "7b20a933-9292-41e4-91ea-59eba72f2221",
          "backPictureImage": "eb6f8886-11e0-4339-801a-ee645351042b"
        },
        "secondaryInsurance": {
          "status": "yes",
          "carrier": "test2",
          "memberId": "234234",
          "groupNum": "hg89",
          "cardname": "test2",
          "cardDob": "2020-09-23T06:25:00+00:00",
          "frontPictureImage": "fc497e96-9f09-4c2a-a964-89c6f7473f4d",
          "backPictureImage": "5405ec11-c9d0-4279-82db-2f70f959b904"
        }
      },
      "signature": {
        "timestamp": "2021-08-23T06:15:00+00:00",
        "image": "85219935-52b6-41a4-82ca-2f32ed709e5c"
      },
      "consents": [
        {
          "name": "communication",
          "value": true,
          "timestamp": "2021-08-23T06:10:00+00:00"
        },
        {
          "name": "sharePHI",
          "value": true,
          "timestamp": "2021-08-23T06:11:00+00:00"
        }
      ],
      "mediaIds": [
        {
          "mediaType": "consent",
          "mediaId": "6253d25de50dcab75b08f0b2",
          "fileType": "pdf"
        }
      ],
      "externalIds": [
        {
          "source": "partner",
          "sourceId": "Id_of_patient_in_partner_system"
        }
      ]
    }
  },
  "sourceName": "helparound",
  "eventName": "HelpAround.Patient.CompleteEnrollment"
}

NEXT: ➡️ Enrollment Consent Only Flow