Enrollment API v2

/rxcdi/api/v2/enrollment

Before You Start

Please enroll with Engagedmedia

Limitations
  • Must have valid Client credentials
  • Must have valid medication code
  • Must have valid trigger

Parameters

Key Desc.
Auth Username *****
Password *****
Authorization Basic
Required trigger
medCode Program ID
PATIENT id
firstName First name of patient
lastName Last name of patient
sex Gender of patient (M,F,O)
language Langauge code Eg: en
dob Date of Birth Format: YYYY-MM-DD
phone *Note: You can provide multiple phone numbers with its type in array format
number
type
PROVIDER tenantId
NPINumber
name
phone
prefix
firstName
lastName
patientPortalURL
MEDICATIONS *Note: You can provide multiple details of medications in array format with it properties given below format
id
code
name
duration
refills
educationURL
PROGRAM PARAMETERS parameter0 Flexible optional parameter
parameter1 Flexible optional parameter
parameter2 Flexible optional parameter
parameter3 Flexible optional parameter
parameter4 Flexible optional parameter
parameter5 Flexible optional parameter
parameter6 Flexible optional parameter
parameter7 Flexible optional parameter
parameter8 Flexible optional parameter
parameter9 Flexible optional parameter
parameter10 Flexible optional parameter

Request Sample

    PUT /rxcdi/api/v2/enrollment HTTP/1.1
    Host: https://engagedmedia.com:8443
    Authorization: Basic LkeweuNOIh3uNLi=
    Content-Type: application/json
    {
        "trigger":"XYZweb4a",
        "medCode":"XYZ",
        "programStatus":"ENROLL",
        "commercialPayer":1,
        "programId":2,
        "patientProgramId":22,
        "dischargeDate":"2021-04-16T09:34:00.279Z",
        "patient":{
            "id":"E-16",
            "firstName":"Jhon",
            "lastName":"Doe",
            "sex":"M",
            "language":"en",
            "dob":"1989-05-26",
            "phone":[
                {
                    "number":"1234567890",
                    "type":"MC"
                }
            ]
        },
        "provider":{
            "tenantId":"ATL101",
            "NPINumber":1234567890,
            "name":"Urgent Care Facility",
            "phone":"1-800-123-4455",
            "prefix":"",
            "firstName":"LUCY",
            "lastName":"SMITH",
            "patientPortalURL":"https://mychart.cdhospital.org"
        },
        "medications":[
            {
                    "id":1234567890123,
                    "code":"4",
                    "name":"XYZ",
                    "duration":28,
                    "refills":2,
                    "educationURL":"http://bit.ly/xyz"
            }
        ],
        "programParameters": {
            "parameter0": "",
            "parameter1": "",
            "parameter2": "",
            "parameter3": "",
            "parameter4": "",
            "parameter5": "",
            "parameter6": "",
            "parameter7": "",
            "parameter8": "",
            "parameter9": "",
            "parameter10": ""
        }
    }

Response Sample

  HTTP/1.1 200 OK
  Content-Type: application/json
  {
    "trigger":"XYZweb4a",
    "medCode":"XYZ",
    "programStatus":"ENROLL",
    "commercialPayer":1,
    "programId":2,
    "patientProgramId":22,
    "dischargeDate":"2021-04-16T09:34:00.279Z",
    "patient":{
        "id":"E-16",
        "firstName":"Jhone",
        "lastName":"Doe",
        "sex":"M",
        "language":"en",
        "dob":"1989-05-26",
        "phone":[
            {
                "number":"1234567890",
                "type":"MC"
            }
        ]
    },
    "provider":{
        "tenantId":"ATL101",
        "NPINumber":1234567890,
        "name":"Urgent Care Facility",
        "phone":"1-800-123-4455",
        "prefix":"",
        "firstName":"LUCY",
        "lastName":"SMITH",
        "patientPortalURL":"https://mychart.cdhospital.org"
    },
    "medications":[
        {
            "id":1234567890123,
            "code":"4",
            "name":"XYZ",
            "duration":28,
            "refills":2,
            "educationURL":"http://bit.ly/xyz"
        }
    ],
    "programParameters": {
        "parameter0": "",
        "parameter1": "",
        "parameter2": "",
        "parameter3": "",
        "parameter4": "",
        "parameter5": "",
        "parameter6": "",
        "parameter7": "",
        "parameter8": "",
        "parameter9": "",
        "parameter10": ""
    }
}