GET api/groups/{groupid}/groupplans/{groupplanid}/ruleplanformularies/{id}

Gets a standard plan formulary rule for the specified group plan and rule identifier

Request Information

URI Parameters

Name	Description	Type	Additional information
groupid	Group identifier	integer	Required
groupplanid	Group Plan identifier	integer	Required
id	Rule identifier	integer	Required

Body Parameters

None.

Response Information

Resource Description

A standard plan formulary rule

RulePlanFormularyModel

Name	Description	Type	Additional information
RuleActionTypeUrl	Gets or sets the link to the rule action type resource	string	None.
RuleActionTypeNo	Gets or sets the identifier to the rule action type	integer	None.
AlternatePricingGroupUrl	Gets or sets the link to the alternate pricing group used by this rule	string	None.
AlternatePricingGroupNo	Gets or sets the identifier to the alternate pricing group	integer	None.
EndProcessing	Gets or sets whether more benefit rules are processed if all criteria has been met	boolean	None.
DAWEnforceRule	Gets or sets whether to enforce drug criteria checks that would normally be skipped due to DAW	boolean	None.
RejectCode	Gets or sets Reject Code for which the rule applies	string	None.
ShortCycle	Gets or sets whether the rule applies to claims identified as short cycle	boolean	None.
NewStartDrug	Gets or sets whether the rule applies to new a start medication (based on plan's New Start Days)	boolean	None.
NewStartDrugByDrugName	Gets or sets whether the new start drug is based on the drug name (10 digit GPI)	boolean	None.
NewDrug	Gets or sets whether the rule is applied for drugs recently added to the catalog	boolean	None.
FirstFillByRx	Gets or sets whether the rule applies to first fills	boolean	None.
RefillExpired	Gets or sets whether the rule applies for expired refills (based on plan's Rx Expire Days)	boolean	None.
OnPlan	Gets or sets whether the rule applies when the drug is on the plan	boolean	None.
InCompound	Gets or sets whether the rule applies to compounds being priced using ingredients	boolean	None.
DiagnosisCodes	Gets or sets the DiagnosisCodes for which the rule applies	Collection of RuleDiagnosisCodeModel	None.
Members	Gets or sets members for which the rule applies; if the list is empty it applies to all	Collection of RuleMemberModel	None.
Networks	Gets or sets networks for which the rule applies; if the list is empty it applies to all	Collection of RuleNetworkModel	None.
Headquarters	Gets or sets headquarters for which the rule applies; if the list is empty it applies to all	Collection of RulePharmacyHeadquarterModel	None.
Pharmacies	Gets or sets pharmacies for which the rule applies; if the list is empty it applies to all	Collection of RulePharmacyModel	None.
Prescribers	Gets or sets prescribers for which the rule applies; if the list is empty it applies to all	Collection of RulePrescriberModel	None.
Facilities	Gets or sets the Facilities for which the rule applies	Collection of RuleFacilityBranchModel	None.
QuantityMin	Gets or sets the minimum quantity in order for the rule to apply	decimal number	None.
QuantityMax	Gets or sets the maximum quantity in order for the rule to apply	decimal number	None.
IsBrand	Gets or sets whether the drug criteria is based on brand	boolean	None.
IsRx	Gets or sets whether the drug criteria is for prescription only (non-OTC)	boolean	None.
IsMultiSourced	Gets or sets whether the drug criteria is based on multi-source	boolean	None.
IsRepackaged	Gets or sets whether the drug criteria is based on repackaged value	boolean	None.
GenericAvailable	Gets or sets whether the drug criteria applies if a generic is available	boolean	None.
OTCAvailable	Gets or sets whether the drug criteria applies if an OTC is available	boolean	None.
IsMaintenanceDrug	Gets or sets whether the drug criteria applies to maintenance drug	boolean	None.
DEAClassCodes	Gets or sets the applicable DEA schedules for the drug criteria	Collection of DEAScheduleModel	None.
BrandNameCodes	Gets or sets the applicable brand codes for the drug criteria	Collection of BrandNameCodeModel	None.
MultiSourceCodes	Gets or sets the applicable multi-source codes for the drug criteria	Collection of MultiSourceCodeModel	None.
IncludeCustomDrugs	Gets or sets whether the drug criteria applies to custom drugs	boolean	None.
GPIs	Gets or sets the list of GPIs associated with the drug criteria	Collection of RuleGPIModel	None.
PricingGroups	Gets or sets the list of pricing groups associated with the drug criteria	Collection of RulePricingGroupModel	None.
ROAs	Gets or sets the list of ROAs associated with the drug criteria	Collection of RuleROAModel	None.
DosageForms	Gets or sets the dosage forms associated with the drug criteria	Collection of RuleDosageFormModel	None.
FormularyTiers	Gets or sets the list of formulary tiers associated with the drug criteria	Collection of RuleFormularyTierModel	None.
isSpecialty	Gets or Sets a flag indicating whether this rule's criteria should include specialty drugs	boolean	None.
DrugProfiles	Gets or Sets a a list of which drug profiles are associated with this rule	Collection of RuleDrugProfileModel	None.
GroupPlanNo	Gets or sets the group plan id associated with the rule	integer	None.
Description	Gets or sets the description	string	None.
Priority	Gets or sets the priority	integer	None.
ReferenceCode	Gets or sets the reference code	string	None.
Message	Gets or sets the message	string	None.
ChangeNote	Gets the latest change note or sets a change note to be saved on a patch	string	None.
EffectiveStartDate	Gets or sets the effective start date	date	None.
EffectiveEndDate	Gets or sets the effective end date	date	None.
Active	Gets or sets whether the rule is active	boolean	None.
DaysSupplyMin	Gets or sets the minimum days supply in order for the rule to apply	integer	None.
DaysSupplyMax	Gets or sets the maximum days supply in order for the rule to apply	integer	None.
MemberAgeMin	Gets or sets the minimum age of the member in order for the rule to apply	integer	None.
MemberAgeMax	Gets or sets the maximum age of the member in order for the rule to apply	integer	None.
MemberAgeUnits	Gets or sets the age units.	string	None.
DependentRelationshipCodes	Gets or sets the dependent relationship code as a delimited list for which the rule applies.	Collection of RelationshipModel	None.
ServiceCategory	Gets or sets the service category	string	None.
MemberGender	Gets or sets the gender (if necessary) for which the rule applies	string	None.
PharmacyTypes	Gets or sets the list of acceptable pharmacy types	Collection of RulePharmacyTypeModel	None.
SubmissionClarificationCodeCriteriaType	Gets or sets the rule's submission clarification code match criteria if applicable (possible values: Blank, Match, n/a)	string	None.
SubmissionClarificationCodes	Gets or sets the submission clarification codes for which the rule applies (This list is only used if SubmissionClarificationCodeCriteriaType is set to match)	Collection of RuleSubmissionClarificationCodeModel	None.
PharmacyServiceTypeCriteriaType	Gets or sets the pharmacy service criteria type	string	None.
PharmacyServiceType	Gets or sets the pharmacy service value. Uses standarded NCPDP values.	string	None.
PatientResidenceCriteriaType	Gets or sets the patient residence criteria type	string	None.
PatientResidence	Gets or sets the patient residence value. Uses standarded NCPDP values.	string	None.
PlaceOfServiceCriteriaType	Gets or sets the place of service criteria type	string	None.
PlaceOfService	Gets or sets the place of service value. Uses standarded NCPDP values.	string	None.
BenefitCodeUrl	Gets or sets the Benefit Code Url	string	None.
BenefitCodeNo	Gets or sets the Benefit Code number	integer	None.
PriorFillsGPIChars	Gets or sets the Prior Fills GPI Chars	string	None.
DiagnosisCodeCriteriaType	Gets or sets the rule's submission clarification code match criteria if applicable (possible values: Blank, Match, n/a)	string	None.
DAWCodes	Gets or sets the acceptable DAW code values that apply to the rule	Collection of DAWCodeModel	None.
ContractCodes	Gets or sets the list of contract codes associated with the general criteria	Collection of RuleContractCodeModel	None.
ARCodes	Gets or sets the list of AR codes associated with the general criteria	Collection of RuleARCodeModel	None.
CoverageLevels	Gets or sets the coverage levels associated with the general criteria	Collection of RuleCoverageLevelModel	None.
EmployeeStatuses	Gets or sets the list of employee statuses associated with the general criteria	Collection of RuleEmployeeStatusModel	None.
OtherStatuses	Gets or sets the list of other statuses associated with the general criteria	Collection of RuleOtherStatusModel	None.
PharmacyStates	Gets or sets the list of US States associated with the general criteria	Collection of RuleStateModel	None.
isTemplate	Gets or sets whether the rule is a template	boolean	None.
Url	Gets or sets the link representing a link back to the resource	string	None.
ID	Gets or sets the identifier for the resource	integer	None.

Response Formats

application/json, text/json, application/json-patch+json

Sample:

{
  "url": "sample string 24",
  "id": 25,
  "ruleActionTypeUrl": "sample string 1",
  "ruleActionTypeNo": 2,
  "alternatePricingGroupUrl": "sample string 4",
  "alternatePricingGroupNo": 1,
  "endProcessing": true,
  "dawEnforceRule": true,
  "rejectCode": "sample string 5",
  "shortCycle": true,
  "newStartDrug": true,
  "newStartDrugByDrugName": true,
  "newDrug": true,
  "firstFillByRx": true,
  "refillExpired": true,
  "onPlan": true,
  "inCompound": true,
  "diagnosisCodes": [
    {
      "url": "sample string 5",
      "id": 6,
      "ruleNo": 1,
      "diagnosisCode": "sample string 2",
      "description": "sample string 3"
    },
    {
      "url": "sample string 5",
      "id": 6,
      "ruleNo": 1,
      "diagnosisCode": "sample string 2",
      "description": "sample string 3"
    }
  ],
  "members": [
    {
      "url": "sample string 9",
      "id": 10,
      "ruleNo": 1,
      "lastName": "sample string 2",
      "firstName": "sample string 3",
      "middleName": "sample string 4",
      "dateOfBirth": "2025-05-30T21:11:04.9130175-05:00",
      "ssn": "sample string 5",
      "memberSeqNo": 6,
      "locationName": "sample string 8"
    },
    {
      "url": "sample string 9",
      "id": 10,
      "ruleNo": 1,
      "lastName": "sample string 2",
      "firstName": "sample string 3",
      "middleName": "sample string 4",
      "dateOfBirth": "2025-05-30T21:11:04.9130175-05:00",
      "ssn": "sample string 5",
      "memberSeqNo": 6,
      "locationName": "sample string 8"
    }
  ],
  "networks": [
    {
      "url": "sample string 5",
      "id": 6,
      "ruleNo": 1,
      "description": "sample string 2",
      "networkNo": 4
    },
    {
      "url": "sample string 5",
      "id": 6,
      "ruleNo": 1,
      "description": "sample string 2",
      "networkNo": 4
    }
  ],
  "headquarters": [
    {
      "url": "sample string 5",
      "id": 6,
      "ruleNo": 1,
      "description": "sample string 2",
      "pharmacyHeadquarterNo": 4
    },
    {
      "url": "sample string 5",
      "id": 6,
      "ruleNo": 1,
      "description": "sample string 2",
      "pharmacyHeadquarterNo": 4
    }
  ],
  "pharmacies": [
    {
      "url": "sample string 4",
      "id": 5,
      "ruleNo": 1,
      "npi": "sample string 2",
      "pharmacyName": "sample string 3"
    },
    {
      "url": "sample string 4",
      "id": 5,
      "ruleNo": 1,
      "npi": "sample string 2",
      "pharmacyName": "sample string 3"
    }
  ],
  "prescribers": [
    {
      "url": "sample string 4",
      "id": 5,
      "ruleNo": 1,
      "npi": "sample string 2",
      "prescriberName": "sample string 3",
      "effectiveStartDate": "2025-05-30T21:11:04.9130175-05:00",
      "effectiveEndDate": "2025-05-30T21:11:04.9130175-05:00"
    },
    {
      "url": "sample string 4",
      "id": 5,
      "ruleNo": 1,
      "npi": "sample string 2",
      "prescriberName": "sample string 3",
      "effectiveStartDate": "2025-05-30T21:11:04.9130175-05:00",
      "effectiveEndDate": "2025-05-30T21:11:04.9130175-05:00"
    }
  ],
  "facilities": [
    {
      "url": "sample string 6",
      "id": 7,
      "ruleNo": 1,
      "facilityName": "sample string 2",
      "pharmacyBranch": "sample string 3",
      "facilityBranchSeqNo": 4
    },
    {
      "url": "sample string 6",
      "id": 7,
      "ruleNo": 1,
      "facilityName": "sample string 2",
      "pharmacyBranch": "sample string 3",
      "facilityBranchSeqNo": 4
    }
  ],
  "quantityMin": 1.0,
  "quantityMax": 1.0,
  "isBrand": true,
  "isRx": true,
  "isMultiSourced": true,
  "isRepackaged": true,
  "genericAvailable": true,
  "otcAvailable": true,
  "isMaintenanceDrug": true,
  "deaClassCodes": [
    {
      "displayName": "sample string 1"
    },
    {
      "displayName": "sample string 1"
    }
  ],
  "brandNameCodes": [
    {
      "displayName": "sample string 1"
    },
    {
      "displayName": "sample string 1"
    }
  ],
  "multiSourceCodes": [
    {
      "displayName": "sample string 1"
    },
    {
      "displayName": "sample string 1"
    }
  ],
  "includeCustomDrugs": true,
  "gpIs": [
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "genericProductIdentifier": "sample string 2"
    },
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "genericProductIdentifier": "sample string 2"
    }
  ],
  "pricingGroups": [
    {
      "url": "sample string 6",
      "id": 7,
      "ruleNo": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "planPricingGroupNo": 5
    },
    {
      "url": "sample string 6",
      "id": 7,
      "ruleNo": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "planPricingGroupNo": 5
    }
  ],
  "roAs": [
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "routeOfAdministration": "sample string 2"
    },
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "routeOfAdministration": "sample string 2"
    }
  ],
  "dosageForms": [
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "dosageForm": "sample string 2"
    },
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "dosageForm": "sample string 2"
    }
  ],
  "formularyTiers": [
    {
      "url": "sample string 6",
      "id": 7,
      "ruleNo": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "tier": 1,
      "formularyTierNo": 4
    },
    {
      "url": "sample string 6",
      "id": 7,
      "ruleNo": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "tier": 1,
      "formularyTierNo": 4
    }
  ],
  "isSpecialty": true,
  "drugProfiles": [
    {
      "url": "sample string 5",
      "id": 6,
      "ruleNo": 1,
      "drugProfileUrl": "sample string 3",
      "drugProfileNo": 4
    },
    {
      "url": "sample string 5",
      "id": 6,
      "ruleNo": 1,
      "drugProfileUrl": "sample string 3",
      "drugProfileNo": 4
    }
  ],
  "groupPlanNo": 6,
  "description": "sample string 7",
  "priority": 1,
  "referenceCode": "sample string 8",
  "message": "sample string 9",
  "changeNote": "sample string 10",
  "effectiveStartDate": "2025-05-30T21:11:04.9130175-05:00",
  "effectiveEndDate": "2025-05-30T21:11:04.9130175-05:00",
  "active": true,
  "daysSupplyMin": 1,
  "daysSupplyMax": 1,
  "memberAgeMin": 1,
  "memberAgeMax": 1,
  "memberAgeUnits": "sample string 11",
  "dependentRelationshipCodes": [
    {
      "displayName": "sample string 1"
    },
    {
      "displayName": "sample string 1"
    }
  ],
  "serviceCategory": "sample string 12",
  "memberGender": "sample string 13",
  "pharmacyTypes": [
    {
      "url": "sample string 6",
      "id": 7,
      "ruleNo": 1,
      "description": "sample string 2",
      "pharmacyTypeCode": "sample string 3"
    },
    {
      "url": "sample string 6",
      "id": 7,
      "ruleNo": 1,
      "description": "sample string 2",
      "pharmacyTypeCode": "sample string 3"
    }
  ],
  "submissionClarificationCodeCriteriaType": "sample string 14",
  "submissionClarificationCodes": [
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "submissionClarificationCode": "sample string 2"
    },
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "submissionClarificationCode": "sample string 2"
    }
  ],
  "pharmacyServiceTypeCriteriaType": "sample string 15",
  "pharmacyServiceType": "sample string 16",
  "patientResidenceCriteriaType": "sample string 17",
  "patientResidence": "sample string 18",
  "placeOfServiceCriteriaType": "sample string 19",
  "placeOfService": "sample string 20",
  "benefitCodeUrl": "sample string 21",
  "benefitCodeNo": 1,
  "priorFillsGPIChars": "sample string 22",
  "diagnosisCodeCriteriaType": "sample string 23",
  "dawCodes": [
    {
      "displayName": "sample string 1"
    },
    {
      "displayName": "sample string 1"
    }
  ],
  "contractCodes": [
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "contractCode": "sample string 2"
    },
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "contractCode": "sample string 2"
    }
  ],
  "arCodes": [
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "arShortCode": "sample string 2"
    },
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "arShortCode": "sample string 2"
    }
  ],
  "coverageLevels": [
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "coverageLevelCode": "sample string 2"
    },
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "coverageLevelCode": "sample string 2"
    }
  ],
  "employeeStatuses": [
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "employeeStatus": "sample string 2"
    },
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "employeeStatus": "sample string 2"
    }
  ],
  "otherStatuses": [
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "otherStatus": "sample string 2"
    },
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "otherStatus": "sample string 2"
    }
  ],
  "pharmacyStates": [
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "stateCode": "sample string 2"
    },
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "stateCode": "sample string 2"
    }
  ],
  "isTemplate": true
}