Current Active Requests: Member
Welcome to the Member section of Current Active Requests. Below are options for Member. These sections will include descriptors of both, as well as sample requests/parameters for each.
Member Summary Endpoints
The Member Summary Endpoints allow for key member information to be provided, and information on the Member or Members that match the criteria to be returned. There are two endpoints for this process that allow for different criteria to be provided, with a common response object used for each.
Member Summary
Member Summary
/MemberSummary
curl --location --request POST 'https://clientapi.test.ad.rxlogic.com/MemberSummary' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'CHID=JHELIGTESTK36' \
--data-urlencode 'PC=01' \
--data-urlencode 'GroupNum=JHELIG'
Criteria of Cardholder ID (CHID), Person Code (PC) and Group Number (GroupNum) can be provided to this endpoint. CHID is required, with the other attributes used as optional.
MemberSummary/SearchMember
/MemberSummary/SearchMember
curl --location --request POST 'https://clientapi.test.ad.rxlogic.com/MemberSummary/SearchMember' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'CHID=JHELIGFULLD05' \
--data-urlencode 'FirstName=ELIGFULLFIVEPR' \
--data-urlencode 'LastName=TESTFULLFIVEPR' \
--data-urlencode 'DOB=1980-07-18'
Criteria of Cardholder ID (CHID), First Name, Last Name, and Date of Birth can be provided to this endpoint. At this time, Date Of Birth must be paired with at least one other parameter to return a response. A sample response is seen below.
Note: Gender Code returned matches the NCPDP values of 1 = male, 2 = female, and 3 = unknown in the response.
{
"ActiveCarriers": [
{
"CarrierId": 1,
"CarrierCode": "SEED",
"StartDateTime": "2018-08-14T08:18:30.7232829-04:00",
"EndDateTime": "2222-12-31T23:59:59.999-05:00"
},
{
"CarrierId": 30,
"CarrierCode": "TEST2017",
"StartDateTime": "2021-06-01T00:00:00+00:00",
"EndDateTime": null
}
],
"Status": {
"Code": "1",
"Description": "Success"
}
}
/* Enter your code */
Member Eligibility
Endpoint for receiving information back about a member in an alternate format to the Member Summary Endpoints.
Sample Request / Parameters
/MemberEligibility
curl --location --request POST 'https://clientapi.test.ad.rxlogic.com/MemberEligibility' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'apiKey: 12345678-jh11-1a18-a1e1-a111a1ea1111' \
--data-urlencode 'MemberId=511543' \
--data-urlencode 'MemberKey=SYNCONE' \
--data-urlencode 'SenderId=FREETEXT'
Member Eligibility accepts the following parameters:
|
FIELD |
REQUIRED? |
Additional Info |
|---|---|---|
|
MemberId |
Optional |
Unique Internal Member ID number assigned to a member. In most cases external parties will not have this number. |
|
MemberKey |
REQUIRED |
Cardholder ID for the member |
|
SenderId |
Optional |
Identifying value for the requestor. |
|
FirstName |
Optional |
First name of the member. Used to filter down results on the provided MemberKey, not as a standalone search. |
|
LastName |
Optional |
Last name of the member. Used to filter down results on the provided MemberKey, not as a standalone search. |
|
DateOfBirth |
Optional |
Date of birth of the member. Used to filter down results on the provided MemberKey, not as a standalone search. |
Note that the FormulayId value is determined based on a UDF of APIFORMULARYCODE on the Group Record related to the member. The defined value should be numeric for this field.
When multiple records are returned, the Status will show as:
"Status": {
"Code": "02",
"Description": "Multiple Member Eligibility Records Returned"
}
When no records are returned, the object will look like:
{
"MemberEligibilities": [],
"Status": {
"Code": "00",
"Description": "Zero Member Eligibility Records Returned"
}
}
A sample response is seen below.
{
"MemberEligibilities": [
{
"Address1": "Address1",
"Address2": "Address2",
"BirthDate": "1980-04-30T00:00:00",
"City": "MemberCity",
"PlanCode": "PRICING API Test Plan",
"PlanNum": "75",
"EligibilityEffectiveDate": "2019-12-31T19:00:00-05:00",
"EligibilityExpirationDate": "2202-12-31T18:59:59.999-05:00",
"EligibilityStatus": {
"Code": "E",
"Description": "Eligible"
},
"FirstName": "SYNC",
"Gender": {
"Code": "M",
"Description": "Male"
},
"Groupnum": "DEPSYNC",
"GroupExternalId": "112",
"LastName": "ONE",
"MemberId": 512331,
"PersonCode": "01",
"MemberKey": "SYNCONE",
"PhoneNumber": "800-123-4567",
"Relationship": {
"Code": "01",
"Description": "Employee"
},
"State": "OH",
"ZipCode": "44087",
"HICNLast4": null,
"ExternalGroupName": "Sync Dependents",
"FormularyId": null,
"LanguageIndicator": "en",
"ClientCode": "SyncDep"
}
],
"Status": {
"Code": "01",
"Description": "Single Member Eligibility Record Returned"
}
}
/* Enter your code */
Accumulator Import
Endpoint for sending new Accumulator records for a member.
Sample Request / Parameters
/AccumulatorImport
curl --location 'https://rxltestclientapi.rxlogic.com//AccumulatorImport' \
--header 'Content-Type: application/json' \
--header 'apiKey: 12345678-aa11-1a11-a1a1-a111a1ea1111' \
--data '{
"GroupNumber": "4432A",
"CardHolderId": "4432A7300000",
"PersonCode": "01",
"FirstName": "JAMIE",
"LastName": "BURTON",
"DOB": "1989-02-03",
"ProcessedDate": "11/06/2023",
"DateOfService": "11/06/2023",
"AdjustmentType": "Medical",
"DeductibleAmount": 50,
"OutOfPocketAmount": 20.25,
"BenefitCapAmount": 33.33,
"IsTest": false,
"SDCs": [
{
"SDCCode": "test",
"SDCValue": 1
}
}'
Explanation of the request elements are below.
|
FIELD |
REQUIRED? |
Additional Info |
|---|---|---|
|
GroupNumber |
REQUIRED |
Active Group Number the Member is assigned to. |
|
CardHolderId |
REQUIRED |
CardHolderId of the affected Member. |
|
FirstName |
REQUIRED |
First name of the affected Member. |
|
LastName |
REQUIRED |
Last name of the affected Member. |
|
DOB |
REQUIRED |
Date of birth of the affected Member. |
|
ProcessedDate |
REQUIRED |
Date the associated accumulator record was processed. |
|
AdjustmentType |
REQUIRED |
Valid values are “Rx” and “Medical” |
|
DeductibleAmount |
Optional |
Amount to include in the Deductible Accumulator. If this is not included, OutOfPocketAmount or BenefitCapAmount must be included. |
|
OutOfPocketAmount |
Optional |
Amount to include in the Out of Pocket Accumulator. If this is not included, DeductibleAmount or BenefitCapAmount must be included. |
|
BenefitCapAmount |
Optional |
Amount to include in the Benefit Cap Accumulator. If this is not included, OutOfPocketAmount or DeductibleAmount must be included. |
|
TransactionId |
Optional |
Associated Transaction Id of the Accumulator. |
|
IsTest |
Optional |
True or false can be set here to make the insertion a Test Accum. Defaults to false if not set. |
|
SDCs |
Optional |
SDC to associate with the Accumulator – no value is entered for this, as it has nested values. |
|
SDCs.SDCCode |
Optional |
Nested subvalue of SDCs. Designates the SDCCode. See example submissions. |
|
SDCs.SDCValue |
Optional |
Nested subvalue of SDCS. Designates the SDCValue. See example submissions. |
Sample Response (ERROR)
{
"status": "Error",
"GroupNumber": "4432A",
"CardHolderId": "4432A7300000",
"PersonCode": "01",
"Errors": [
{
"Message": "No member found for the CardHolderId, GroupNumber and PersonCode"
}
]
}
Sample Response (SUCCESS)
{
"status": "Success",
"GroupNumber": "4432A",
"CardHolderId": "4432A7300000",
"PersonCode": "01",
"Errors": null
}
A sample response is seen below.
{
"GroupNumber": "4432A",
"CardHolderId": "4432A7300000",
"PersonCode": "01",
"FirstName": "JAMIE",
"LastName": "BURTON",
"DOB": "1989-02-03",
"ProcessedDate": "11/06/2023",
"DateOfService": "11/06/2023",
"AdjustmentType": "Medical",
"DeductibleAmount": 50,
"OutOfPocketAmount": 20.25,
"BenefitCapAmount": 33.33,
"IsTest": false,
"SDCs": [
{
"SDCCode": "test",
"SDCValue": 1
}
}
/* Enter your code */
MPA Claim Submit / Pre Auth Claim Test
Endpoint for submission of trial / test claims to determine paid/rejected outcome for a claim and receive back a related PA number. The trial submission is visible within the RxLogic system as a test claim. This request will automatically generate a reversal transaction to remove the test claim.
The Pre Auth Claim Test endpoint uses the same request and response objects, but includes an additional layer of logic. If the initial claim as submitted pays with an MPA, the claim is resubmitted with the RxDate + 35 days and the result returned from that claim instead.
Sample Request / Parameters
/MPAClaimSubmit
/PreAuthClaimTest
curl --location --request POST 'https://clientapi.test.ad.rxlogic.com/MPAClaimSubmit' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'apiKey: 11111111-aa11-1af1-a1a1-a111a1aa1111' \
--data-urlencode 'MemberId=512204' \
--data-urlencode 'NPI=1942252895' \
--data-urlencode 'NDC=61958180101' \
--data-urlencode 'NABP=1936218' \
--data-urlencode 'Quantity=30' \
--data-urlencode 'DaysSupply=30' \
--data-urlencode 'GroupNum=JHELIG' \
--data-urlencode 'Gender=1' \
--data-urlencode 'DOB=1980-04-30' \
--data-urlencode 'RxDate=2021-09-22' \
--data-urlencode 'SenderId=FREETEXT'
The request elements are below. Optional elements are dependent on the plan being processed to.
|
FIELD |
REQUIRED? |
Additional Info |
|---|---|---|
|
MemberId |
REQUIRED |
RXL Internal Member ID number assigned to a member. This is returned in the Member Eligibility api call response. |
|
Npi |
Optional |
Prescriber NPI Number. If not submitted, a value of 1999999992 will be used. |
|
NDC |
REQUIRED |
NDC Number for the product being approved |
|
NABP |
REQUIRED |
NCPDP Number of the pharmacy dispensing the product |
|
Quantity |
REQUIRED |
Quantity of the product to be dispensed |
|
DaysSupply |
REQUIRED |
Days Supply of the product to be dispensed |
|
GroupNum |
Optional |
Group Number of the patient |
|
Gender |
Optional |
Gender of the patient (1 = Male, 2 = Female) |
|
DOB |
Optional |
Date of birth of the patient |
|
RxDate |
REQUIRED |
Date of service for the transaction |
|
SenderId |
Optional |
Identifying value for the requestor |
Sample Response
{
"ClaimSubmitItem": {
"ClaimStatus": "Denied",
"ClaimEpisode": "NoTransactionRecorded",
"ClaimRejectCode": "0",
"ClaimMessage": "M/I CARDHOLDER ID",
"PriorAuthNumber": null
}
}
An accepted response looks like the following:
{
"ClaimSubmitItem": {
"ClaimStatus": "Accepted",
"ClaimEpisode": "NoTransactionRecorded",
"ClaimRejectCode":"",
"ClaimMessage": "USED NETWORK MAC",
"PriorAuthNumber": null
}
}
Customer Service
Endpoint for exchange of PA and ticket related data.
Sample Request / Parameters
/CustomerService
curl --location --request POST 'https://clientapi.test.ad.rxlogic.com/CustomerService' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'apiKey: 11111111-aa11-1aa1-a1a1-a111a1aa1111' \
--data-urlencode 'EocId=12345' \
--data-urlencode 'HcsEventId=888' \
--data-urlencode 'Ignorepm=' \
--data-urlencode 'SenderID=SampleID' \
--data-urlencode 'Patient={"MemberId":"511543","MemberKey":"SYNCONE"}' \
--data-urlencode 'HCSInfo={"DrugName":"NO","NDC":"00071015523","GPI":"39400010100310","RequestStartDate":"2021-01-01","Urgent":"NO"}' \
--data-urlencode 'PatientExplanations=canLeaveBlank' \
--data-urlencode 'OUTCOMEDETAILS={"Outcome":"LOADED","OutcomeDate":"2021-01-01","EditType":"no","EventType":"loading","OutcomeBy":"Irene","DenialType":"no","PharmacistMedicaldirectorComments":"TestingComments"}' \
--data-urlencode 'Authorization={"PAHubAuthID":"12345","RetailQuantity":"30","DurationInDays":"30","AuthSubmittedOn":"2021-01-01","CoverageStartDate":"2021-01-01","CoverageEndDate":"2021-12-31","GenericIND":"False","TreatDrugAs":"M","PrescriberId":"9876541233","ProviderID":"1234567890","MiscHandler":"","MaxScriptDollars":"123","MaxMPAScripts":"1","MaxDailyDose":"0","TreatAsIncludePM":"","MinScriptDays":"0","OverrideRefillTooSoon":"false","NumberOfRefills":"0","MPAType":"Simple"}'
Note: Only a portion of the fields in this API are documented here. Please use the sample transaction as a guide.
|
FIELD |
REQUIRED? |
Additional Info |
|---|---|---|
|
Outcome |
Optional |
Values of “Approved” and “Partially Approved” are supported, both of which resolve to “Approved” on the RxLogic system.
All other value swill result in the MPA being set to Deny. |
|
MPAType |
Optional |
Values are “COMPLEX MPA”, “SIMPLE MPA”, “NO CHARGE MPA” or “NOCHARGE MPA”. Values are not case sensitive.
All other values will map as No Charge. |
|
MaxMPAScripts |
Optional |
Populates the Max Uses on an MPA
|
Sample Response
{
"ResponseStats": {
"Code": "00,",
"Description": "Successful"
},
"ExternalAuthId": "12345-4321"
}
A sample response is seen below.
{
"CustomerServiceUpdate": {
"EocId": "1234567890",
"HcsEventId": "47",
"Ignorepm": null,
"SenderID": "PAHUB",
"Patient": {
"MemberId": "515333",
"MemberKey": "0LOCKTALL38/01"
},
"HCSInfo": {
"NDC": "17478021505",
"GPI": "6110002510****",
"Urgent": ""
},
"PatientExplanations": "string",
"OUTCOMEDETAILS": {
"Outcome": "Approved",
"OutcomeDate": "03-08-2022",
"EditType": "PA REQUIRED",
"OutcomeBy": "PAHUB",
"PharmacistMedicaldirectorComments": "This is a test comment"
},
"Authorization": {
"PAHubAuthID": "12345",
"RetailQuantity": "30",
"DurationInDays": "30",
"AuthSubmittedOn": "02-27-2022",
"CoverageStartDate": "03-01-2022",
"CoverageEndDate": "03-01-2023",
"ProviderID": "PrioritizingNetwork",
"GenericIND": "Generic",
"MaxScriptDollars": "999.00",
"MaxMPAScripts": "5",
"MinScriptDays": "12",
"MaxDailyDose": "2",
"TreatAsIncludePM": "HD_TIER 1 QTY 10 30",
"NumberOfRefills": "2",
"MPAType": "SIMPLE MPA"
}
}
}
/* Enter your code */
Active Members Endpoints
Endpoint to retrieve a list of members active on the current date, either by the Group Number or by the Carrier Code.
Sample Request / Parameters
/ActiveMembersByGroup
curl -X GET --header 'Accept: application/json' --header 'apiKey: XXXXXXXX-XXXX-XXXX-XXXX-XXXX' 'https://rxltestclientapi.rxlogic.com/ActiveMembersByGroup?groupNumber=APIELIG2'
The Active Members By Group endpoint takes a single groupNumber parameter, corresponding to the alphanumeric Group Number field on the RxLogic system.
/ActiveMembersByCarrier
curl -X GET --header 'Accept: application/json' --header 'apiKey: XXXXXXXX-XXXX-XXXX-XXXX-XXXX' 'https://rxltestclientapi.rxlogic.com/ActiveMembersByCarrier?carrierCode=ISOCAR2'
The Active Members By Carrier endpoint takes a single carrierCode parameter, corresponding to the alphanumeric CarrierCode field on the RxLogic system. A member is linked to a Carrier Code via their attached group. A sample response is seen below.
{
"ActiveMembers": [
{
"CHID": "ELIGAPI223",
"DOB": "1968-11-14T00:00:00",
"SSN": "888999999",
"FirstName": "APICHANGE123",
"LastName": "TEST3",
"PersonCode": "01",
"GroupNumber": "APIELIG2",
"StartDateTime": "2022-01-01T00:00:00-05:00",
"EndDateTime": "2022-12-31T00:00:00-05:00",
"CHStartDateTime": "2020-10-01T00:00:00-04:00",
"CHEndDateTime": "2021-12-31T00:00:00-05:00"
},
{
"CHID": "OVERLAPPER1",
"DOB": "1968-11-14T00:00:00",
"SSN": "888999999",
"FirstName": "APICHANGE123",
"LastName": "TEST3",
"PersonCode": "01",
"GroupNumber": "APIELIG2",
"StartDateTime": "2022-01-11T00:00:00-05:00",
"EndDateTime": "2022-12-12T00:00:00-05:00",
"CHStartDateTime": "2020-01-05T00:00:00-05:00",
"CHEndDateTime": "2021-12-06T00:00:00-05:00"
}
{
"CHID": "MULTIPLEAPI1",
"DOB": "1968-11-14T00:00:00",
"SSN": "888999999",
"FirstName": "APICHANGE123",
"LastName": "TEST3",
"PersonCode": "01",
"GroupNumber": "APIELIG2",
"StartDateTime": "2022-01-11T00:00:00-05:00",
"EndDateTime": "2022-12-12T00:00:00-05:00",
"CHStartDateTime": "2020-01-05T00:00:00-05:00",
"CHEndDateTime": "2021-12-06T00:00:00-05:00"
},
],
"Status": {
"Code": "1",
"Description": "Success"
}
}
/* Enter your code */
Member Enrollment
The Member Enrollment endpoint is used to Add new members to the RxLogic system, or modify existing members. The API supports sending in one member, or multiple members of the same family (same cardholder ID) within the same request.
Sample Request / Parameters (All Elements and Multiple Members)
/MemberEnrollment
This sample request includes 2 members within the same family showing all elements. A list of elements and descriptions can be found below this example. While many elements are optional, please note that providing an optional element as an empty string or not providing it at all will clear the related field on the member’s eligibility record. A sample response is seen below the table.
|
FIELD |
REQUIRED? |
Additional Info |
||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CardholderID |
REQUIRED |
Cardholder ID to be used for the member/members provided. |
||||||||||||||||||||||||||||||||||
|
Members |
REQUIRED |
Array of members to be added / updated. |
||||||||||||||||||||||||||||||||||
|
Members.AlternateID |
OPTIONAL |
Member’s Alternate ID |
||||||||||||||||||||||||||||||||||
|
Members.PreviousID |
OPTIONAL |
Member’s Previous ID |
||||||||||||||||||||||||||||||||||
|
Members.PersonCode |
REQUIRED |
Person Code of the member. Each Unique person code can only be provided once per request, must be 2 digits in length, and should be a 01 for primary members. |
||||||||||||||||||||||||||||||||||
|
Members.FirstName |
REQUIRED |
|
||||||||||||||||||||||||||||||||||
|
Members.LastName |
REQUIRED |
|
||||||||||||||||||||||||||||||||||
|
Members.MiddleName |
OPTIONAL |
|
||||||||||||||||||||||||||||||||||
|
Members.DOB |
REQUIRED |
Date of Birth of member. Acceptable formats are yyyy-mm-dd or mm/dd/yyyy |
||||||||||||||||||||||||||||||||||
|
Members.SSN |
OPTIONAL |
Social Security Number. Can be provided with or without hyphens. |
||||||||||||||||||||||||||||||||||
|
Members.Sex |
REQUIRED |
Valid Values are 'M'ale, 'F'emale and 'U'nknown. |
||||||||||||||||||||||||||||||||||
|
Members.UpdateType |
REQUIRED |
Indicates how the CoverageDates, GroupCoverageDates, and SubGroupCoverageDates provided are to be used.
Allowed Values are ‘Full’ and ‘Partial’.
Full allows multiple date periods to be provided for the CoverageDates, and will completely replace any coverage dates currently on system for a member.
Partial only allows for a single coverage date period to be provided. If the dates provided interact with a single, existing coverage period, the existing coverage is auto terminated the day before the new coverage goes into effect.
|
||||||||||||||||||||||||||||||||||
|
Members.CoverageDates |
REQUIRED |
Array with dates corresponding the CH Elig dates on |
||||||||||||||||||||||||||||||||||
|
Members.CoverageDates .StartDate |
REQUIRED |
Acceptable formats are yyyy-mm-dd or mm/dd/yyyy |
||||||||||||||||||||||||||||||||||
|
Members.CoverageDates .EndDate |
REQUIRED |
Acceptable formats are yyyy-mm-dd or mm/dd/yyyy |
||||||||||||||||||||||||||||||||||
|
Members.GroupCoverageDates |
REQUIRED |
Array with coverage dates for Group Coverage |
||||||||||||||||||||||||||||||||||
|
Members.GroupCoverageDates.CoverageType |
REQUIRED |
Coverage Type for the Group Coverage. Supports F,I ,S, or C. ‘F’amily, ‘I’ndividual, Primary and ‘S’pouse, Primary and ‘C’hild. |
||||||||||||||||||||||||||||||||||
|
Members.GroupCoverageDates StartDate |
REQUIRED |
Acceptable formats are yyyy-mm-dd or mm/dd/yyyy |
||||||||||||||||||||||||||||||||||
|
Members.GroupCoverageDates EndDate |
REQUIRED |
Acceptable formats are yyyy-mm-dd or mm/dd/yyyy |
||||||||||||||||||||||||||||||||||
|
Members.GroupCoverageDates GroupNumber |
REQUIRED |
Group Number of member. Must match a value on RxLogic system. |
||||||||||||||||||||||||||||||||||
|
Members.SubGroupCoverageDates |
OPTIONAL |
Array for SubGroup Coverage and related Subgroup information.
This Array is optional, but each item within the Array is REQUIRED if the array if provided. |
||||||||||||||||||||||||||||||||||
|
Members.SubGroupCoverageDates .CoverageType |
OPTIONAL |
Coverage Type for the SubGroup Coverage. Supports F,I ,S, or C. ‘F’amily, ‘I’ndividual, Primary and ‘S’pouse, Primary and ‘C’hild. |
||||||||||||||||||||||||||||||||||
|
Members.SubGroupCoverageDates .StartDate |
OPTIONAL |
Acceptable formats are yyyy-mm-dd or mm/dd/yyyy |
||||||||||||||||||||||||||||||||||
|
Members.SubGroupCoverageDates .EndDate |
OPTIONAL |
Acceptable formats are yyyy-mm-dd or mm/dd/yyyy |
||||||||||||||||||||||||||||||||||
|
Members.SubGroupCoverageDates .GroupNumber |
OPTIONAL |
Group Number to be used to verify SubGroup validity. SubGroup codes can be listed multiple times in RxLogic and attached to different groups. |
||||||||||||||||||||||||||||||||||
|
Members.SubGroupCoverageDates .SubGroupCode |
OPTIONAL |
SubGroup Code. Must be valid for the provided GroupNumber field within the SubGroupCoverageDates Array |
||||||||||||||||||||||||||||||||||
|
Members.Address1 |
OPTIONAL |
|
||||||||||||||||||||||||||||||||||
|
Members.Address2 |
OPTIONAL |
|
||||||||||||||||||||||||||||||||||
|
Members.City |
OPTIONAL |
|
||||||||||||||||||||||||||||||||||
|
Members.State |
OPTIONAL |
|
||||||||||||||||||||||||||||||||||
|
Members.ZipCode |
OPTIONAL |
|
||||||||||||||||||||||||||||||||||
|
Members.HomePhone |
OPTIONAL |
Can be provided with or without hyphens. |
||||||||||||||||||||||||||||||||||
|
Members.WorkPhone |
OPTIONAL |
Can be provided with or without hyphens. |
||||||||||||||||||||||||||||||||||
|
Members.Email |
OPTIONAL |
|
||||||||||||||||||||||||||||||||||
|
Members.LocationCode |
OPTIONAL |
Location Code for the member. As allowed Location Codes are defined on the group, the provided location code will be checked to see if it is allowed for the group(s) provided. |
||||||||||||||||||||||||||||||||||
|
Members.RelationshipCode |
REQUIRED |
Valid values are: Primary – ‘P’ or ‘1’ Spouse – ‘S’ or ‘2’ Dependent – ‘D’ or ‘3’ |
||||||||||||||||||||||||||||||||||
|
Members.ChronicCondition |
OPTIONAL |
Corresponds to a UDF key of ChronicCondition with values of either True or False.
If providing, use values of ‘True’ or ‘False’ |
||||||||||||||||||||||||||||||||||
|
Members.DiagnosisCodes |
OPTIONAL |
Array for providing Diagnosis Codes. Can be provided as an empty Array or omitted entirely.
|
||||||||||||||||||||||||||||||||||
|
Members.DiagnosisCodes.DiagnosisCode |
OPTIONAL |
A max of 4 Diagnosis Code objects are allowed. |
||||||||||||||||||||||||||||||||||
|
Members.BenefitOverrideStartDay |
OPTIONAL |
If providing a StartDay, a StartMonth must also be provided |
||||||||||||||||||||||||||||||||||
|
Members.BenefitOverrideStartMonth |
OPTIONAL |
If providing a StartMonth, a StartDay must also be provided. |
||||||||||||||||||||||||||||||||||
|
Members.IsStudent |
REQUIRED |
Provide as ‘True’ or ‘False’ or ‘1’ and ‘0’ |
||||||||||||||||||||||||||||||||||
|
Members.PreferredLanguage |
Optional |
Provide as ISO 2 character language codes. The following is a list of supported values:
|
||||||||||||||||||||||||||||||||||
|
Members.MobilePhone |
Optional |
Hyphen and Parenthesis characters are automatically removed. |
||||||||||||||||||||||||||||||||||
|
Members.RejectPrimaryClaims |
Optional |
Provide as ‘True’ or ‘False’ or ‘1’ and ‘0’
|
curl --location --request POST 'https://rxltestclientapi.rxlogic.com//MemberEnrollment' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'apiKey: XXXXXXXX-XXXX-XXXX-XXXX-XXXX' \
--data-raw '{
"CardholderID": "APIEXAMPLE",
"Members": [
{
"AlternateID": "ALT331",
"PreviousID": "PREV1",
"PersonCode": "01",
"FirstName": "APICHANGE123",
"LastName": "TEST3",
"MiddleName": "MID"
"DOB": "1968-11-14",
"SSN": "888999999",
"Sex": "M",
"UpdateType": "Full",
"CoverageDates": [
{
"StartDate": "2020-01-05",
"EndDate": "2021-12-06",
},
{
"StartDate": "2022-01-07",
"EndDate": "2022-12-08",
}
],
"GroupCoverageDates": [
{
"StartDate": "2021-01-09",
"EndDate": "2021-12-10",
"GroupNumber": "APIELIG1",
"CoverageType": "F"
},
{
"StartDate": "2022-01-11",
"EndDate": "2022-12-12",
"GroupNumber": "APIELIG2",
"CoverageType": "F"
}
],
"SubGroupCoverageDates": [
{
"CoverageType": "F",
"StartDate": "2022-01-12",
"EndDate": "2022-07-13",
"GroupNumber": "APIELIG1",
"SubGroupCode": "APISUB2"
},
{
"CoverageType": "F",
"StartDate": "2022-08-14",
"EndDate": "2022-12-15",
"GroupNumber": "APIELIG1",
"SubGroupCode": "APISUB2"
}
],
"Address1": "1234 ADDR Dr",
"Address2": "APT 123XY",
"City": "Twinsburg",
"State": "OH",
"ZipCode": "44087",
"HomePhone": "9876543231",
"WorkPhone": "8884567890",
"Email": "XTester@Test.com",
"LocationCode": "JHLOC",
"ChronicCondition": "False",
"RelationshipCode": "P",
"DiagnosisCodes": [
{
"DiagnosisCode": "123.45"
}
],
"BenefitOverrideStartDay": "1",
"BenefitOverrideStartMonth": "1",
"IsStudent": "False",
"PreferredLanguage": "EN",
"MobilePhone": "1234567890",
"RejectPrimaryClaims": "1"
},
{
"AlternateID": "PC2ALT",
"PreviousID": "PC2PRV",
"PersonCode": "02",
"FirstName": "PC2FIRSTNAME",
"LastName": "PC2LASTNAME",
"MiddleName": "PC2MID",
"DOB": "1980-04-30",
"SSN": "222222222",
"Sex": "F",
"UpdateType": "Partial",
"CoverageDates": [
{
"StartDate": "2021-01-15",
"EndDate": "2022-12-16",
}
],
"GroupCoverageDates": [
{
"StartDate": "2021-01-19",
"EndDate": "2022-12-20",
"GroupNumber": "APIELIG1",
"CoverageType": "F"
}
],
"SubGroupCoverageDates": [
{
"CoverageType": "F",
"StartDate": "2022-01-22",
"EndDate": "2022-07-23",
"GroupNumber": "APIELIG1",
"SubGroupCode": "APISUB2"
}
],
"Address1": "1 PC2 Drive",
"Address2": "PC2 ADDR2",
"City": "CLEVELAND",
"State": "OH",
"ZipCode": "44087",
"HomePhone": "2223332222",
"WorkPhone": "2224442222",
"Email": "pc2@Test.com",
"LocationCode": "4534",
"ChronicCondition": "False",
"RelationshipCode": "S",
"DiagnosisCodes": [],
"IsStudent": "False",
"PreferredLanguage": "EN",
"MobilePhone": "1234567890",
"RejectPrimaryClaims": "1"
}
]
}'
/* Enter your code */
Sample Request (Minimum Required Elements)
{
"CardholderID": "ELIGAPI262",
"Members": [
{
"PersonCode": "02",
"FirstName": "APIPC2",
"LastName": "TEST",
"DOB": "1970-11-14",
"Sex": "M",
"UpdateType": "Partial",
"CoverageDates": [
{
"StartDate": "2021-01-01",
"EndDate": "2022-12-31"
}
],
"GroupCoverageDates": [
{
"StartDate": "2021-04-01",
"EndDate": "2022-12-15",
"GroupNumber": "APIELIG1",
"CoverageType": "I"
}
],
"RelationshipCode": "1",
"IsStudent": "TRUE"
},
]
}
/* Enter your code */
Sample Response (New Member Added)
{
"result": [
"Eligibility Processed Successfully"
],
"errors": [],
"warnings": [],
"totals": {
"cardholderAdd": 1,
"memberAdd": 1,
"memberUpdate": 0,
"cardholderMemberAdd": 1,
"cardholderMemberUpdate": 0,
"cardholderMemberDelete": 0,
"groupMemberAdd": 1,
"groupMemberUpdate": 0,
"groupMemberDelete": 0,
"subGroupMemberAdd": 0,
"subGroupMemberUpdate": 0,
"subGroupMemberDelete": 0,
"chronicConditionAdd": 0,
"chronicConditionUpdate": 0
}
}
/* Enter your code */
Sample Response (Member On File As Provided)
{
"result": [
"No Changes Found for Eligibility"
],
"errors": [],
"warnings": [],
"totals": {
"cardholderAdd": 0,
"memberAdd": 0,
"memberUpdate": 0,
"cardholderMemberAdd": 0,
"cardholderMemberUpdate": 0,
"cardholderMemberDelete": 0,
"groupMemberAdd": 0,
"groupMemberUpdate": 0,
"groupMemberDelete": 0,
"subGroupMemberAdd": 0,
"subGroupMemberUpdate": 0,
"subGroupMemberDelete": 0,
"chronicConditionAdd": 0,
"chronicConditionUpdate": 0
}
}
/* Enter your code */
Sample Response (Changes Made to Coverage Dates)
This case is most common when using a ‘Partial’ update type, and a prior period exists for the member that was terminated due to overlap with an incoming date record.
{
"result": [
"Eligibility Processed Successfully"
],
"errors": [],
"warnings": [
{
"RowIndex": 1,
"Message": "Found 1 Member eligibility with conflicting date ranges in Cardholder Members that will be modified",
"Resolution": null,
"IsFatal": false
}
],
"totals": {
"cardholderAdd": 0,
"memberAdd": 0,
"memberUpdate": 0,
"cardholderMemberAdd": 1,
"cardholderMemberUpdate": 1,
"cardholderMemberDelete": 0,
"groupMemberAdd": 0,
"groupMemberUpdate": 0,
"groupMemberDelete": 0,
"subGroupMemberAdd": 0,
"subGroupMemberUpdate": 0,
"subGroupMemberDelete": 0,
"chronicConditionAdd": 0,
"chronicConditionUpdate": 0
}
}
/* Enter your code */
Sample Response (Errors)
{
"result": [
"No Changes for One or More Records Made for Eligibility Due to Errors Encountered"
],
"errors": [
{
"RowIndex": 1,
"Message": "Sex Code Invalid for Member 02! Valid Values are 'M'ale, 'F'emale and 'U'nknown. Eligibility will be skipped",
"Resolution": null,
"IsFatal": false
}
],
"warnings": [],
"totals": {
"cardholderAdd": 0,
"memberAdd": 0,
"memberUpdate": 0,
"cardholderMemberAdd": 0,
"cardholderMemberUpdate": 0,
"cardholderMemberDelete": 0,
"groupMemberAdd": 0,
"groupMemberUpdate": 0,
"groupMemberDelete": 0,
"subGroupMemberAdd": 0,
"subGroupMemberUpdate": 0,
"subGroupMemberDelete": 0,
"chronicConditionAdd": 0,
"chronicConditionUpdate": 0
}
}
/* Enter your code */