Response Dictionary

The Response Dictionary outlines the details of fields that should be delivered within response payloads from an RTE API.

name	type	pattern	required	description
primaryId	string		Yes	The `memberId` of the primary subscriber; primarily used for dependents. For non-dependents, this will be the same as the `memberId` field.
uniqueIdentifier	string		Yes	`uniqueIdentifier` contains the sub-object `memberId`, which is a patient's unique member identification number in 98point6 services.
groupId	string		Sometimes	Required in certain health plan scenarios. Used to identify the health plan/group associated to a patient.
relationship	string		Yes
birthDate	string		Yes	A patient's birth date. ISO format is required (YYYY-MM-DD).
sex	string	`^(M\|F\|U)$`	Yes	A patient’s declared sex.
prefix	string	`^(18\|01\|19\|23\|09\|10\|25\|53)$`		A patient’s name prefix.
firstName	string		Yes	A patient’s first name.
middleName	string		No	A patient’s middle name.
lastName	string		Yes	A patient’s last name.
suffix	string		No	A patient’s name suffix.
address1	string		Yes	A patient’s street address.
address2	string			A patient’s street address (continued).
city	string		Yes	City in which the patient resides.
state	string	`^[A-Za-z]{2}$`	Yes	US state in which the patient resides.
zip	string	`^\d{5}(-?\d{4})?$`	Yes	The zip code attributed to a patient’s mailing address.
homePhone	string	`^\d{10}$`	No	A patient’s home phone number.
cellPhone	string	`^\d{10}$`	No	A patient’s mobile phone number.
workPhone	string	`^\d{10}$`	No	A patient’s work phone number.
email	string			A patient’s email address.
language	string			A patient’s primary language.
partnerName	string		Yes	Partner’s unique name. Will be provided to partners by 98point6.
partnerId	string		Yes	Partner’s unique identifier. Will be provided to partners by 98point6.
subscriptionType	string	`^(HSA\|PPO\|EPO\|HMO\|UNKNOWN\|UNINSURED)$`	Yes	The type of 98point6 subscription attributed to a patient.
employerName	string		No	The display name of a patient’s employer.
employerId	string		No	An external identifier used to associate patients to a specific employer.
planType	string	`^(hmo\|ppo\|epo\|mm\|pos\|cobra\|other)$`	Yes	The category of plan attributed to a patient’s healthcare coverage.
planDescription	string		Yes	A display description of a patient’s healthcare coverage.
referralTier	string	`^(NO_COORDINATION\|RESOURCE_LINK\|REFER_TO_CENTRAL_COORDINATOR\|COORDINATED\|COORDINATED_PLUS_FOLLOWUP)$`	Sometimes	Required in scenarios where care coordination is needed.
coinsurancePercentage	number		Sometimes	Required in scenarios where claims submission and/or member-level cost-sharing is needed. Minimum allowed value: `0`. Maximum allowed value: `1`.
copay	integer		Sometimes	Required in scenarios where claims submission and/or member-level cost-sharing is needed. Minimum allowed value: `0`.
contractedRate	integer		Sometimes	Required in scenarios where claims submission and/or member-level cost-sharing is needed. Minimum allowed value: `0`.
priceWaiverApplies	boolean		No
payerName	string		Sometimes	Required in scenarios where claims submission is needed.
payerId	string		Sometimes	Required in scenarios where claims submission is needed.
externalPatientId	string		No	An external identifier used to cross reference patients between 98point6 and partner systems.
worksite	string		No
orgId	string		No
orgArrangement	string		No
segment	string		No
rank	integer		No	In the event that a patient has coverage from multiple sources (e.g. from their own employer and from a spouse’s), this property must be filled out in order of priority. (The lower the number, the higher the priority.) Maximum allowed value: `1`.