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

Gets an NDC specific claim limit rule for a given group plan and rule identifier

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupid

Group identifier

integer

Required

groupplanid

Group Plan identifier

integer

Required

id

Rule identifier

integer

Required

Body Parameters

None.

Response Information

Resource Description

An NDC specific claim limit rule

RuleClaimLimitNDCSpecificModel
NameDescriptionTypeAdditional information
ClaimLimit

Gets or sets the claim limits associated with this rule claim limit

RuleClaimLimitModel

None.

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.

PharmacyPriceMin

Gets or sets the minimum pharmacy price in order for the rule to apply

decimal number

None.

PharmacyPriceMax

Gets or sets the minimum pharmacy price in order for the rule to apply

decimal number

None.

PharmacyPricePreTax

Gets or sets the option for whether the pharmacy price range is the pre-tax amount

boolean

None.

PharmacyPriceCentsMin

Gets or sets the minimum cents portion of the pharmacy price in order for the rule to apply

decimal number

None.

PharmacyPriceCentsMax

Gets or sets the maximum cents portion of the pharmacy price in order for the rule to apply

decimal number

None.

PharmacyPriceCentsPreTax

Gets or sets the option for whether the cents portion of the pharmacy price range is the pre-tax amount

boolean

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.

StepTherapy

Gets or sets whether the rule applies to step therapy medication

boolean

None.

ClaimTagItemID1

Gets or sets the Claim Tag Item ID 1 identifier

globally unique identifier

None.

ClaimTagItemID2

Gets or sets the Claim Tag Item ID 2 identifier

globally unique identifier

None.

ClaimTagItemID3

Gets or sets the Claim Tag Item ID 3 identifier

globally unique identifier

None.

DependentRelationshipCode

Gets or sets the Dependent Relationship Code

string

None.

OnFormulary

Gets or sets the On Formulary indicator

boolean

None.

FormularyNotCoveredException

Gets or sets whether to enforce the formulary not covered exception indicator

boolean

None.

FormularyAgeLimitException

Gets or sets whether to enforce the formulary age exception indicator

boolean

None.

FormularyGenderLimitException

Gets or sets whether to enforce the formulary gender exception indicator

boolean

None.

FormularyQtyLimitException

Gets or sets whether to enforce the formulary quantity exception indicator

boolean

None.

FormularyStepMedException

Gets or sets whether to enforce the formulary step med exception indicator

boolean

None.

FormularyPriorAuthException

Gets or sets whether to enforce the formulary prior auth exception indicator

boolean

None.

DiagnosisCodes

Gets or sets the DiagnosisCodes for which the rule applies

Collection of RuleDiagnosisCodeModel

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.

Facilities

Gets or sets the Facilities for which the rule applies

Collection of RuleFacilityBranchModel

None.

AllowRefillPercentConsumedByNDC

Gets or sets where to check for refill too soon by NDC. If false will be checked by GPI

boolean

None.

AllowRefillPercentConsumedGPIChars

Gets or sets the the GPI Chars used to check for refill too soon if RefillTooSoonConsumedByNDC is false. If RefillTooSoonConsumedByNDC is true and RefillTooSoonConsumedGPIChars is not set then it will be defaulted to 10.

string

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.

NDCs

Gets or sets the list of NDCs associated with the rule criteria. These values can be posted/added at individual rule controllers, but should be patched at the RuleDrug endpoint - api/groups/{groupid}/groupplans/{groupplanid}/rules/{ruleid}/ruledrugs/{id}.

Collection of RuleDrugModel

None.

PricingGroups

Gets or sets the list of pricing groups associated with the drug criteria

Collection of RulePricingGroupModel

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.

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 26",
  "id": 27,
  "claimLimit": {
    "allowClaimLimitChecksOnFutureRules": true,
    "quantityLimitPerFill": 1.0,
    "quantityLimitPerDaysSupply": 1.0,
    "quantityLimitPerInterval": 1.0,
    "quantityLimitIntervalDays": 1,
    "quantityLimitGraceDays": 1,
    "quantityLimitPerPeriod": 1.0,
    "quantityLimitPerPeriodGPIChars": "sample string 1",
    "quantityLimitPerYear": 1.0,
    "quantityLimitPerYearGPIChars": "sample string 2",
    "quantityLimitTotal": 1.0,
    "quantityLimitTotalGPIChars": "sample string 3",
    "minDaysSupplyPerFill": 1,
    "maxDaysSupplyPerFill": 1,
    "maxDaysSupplyPerPeriod": 1,
    "maxDaysSupplyPerPeriodGPIChars": "sample string 4",
    "maxDaysSupplyPerYear": 1,
    "maxDaysSupplyPerYearGPIChars": "sample string 5",
    "maxDaysSupplyTotal": 1,
    "maxDaysSupplyTotalGPIChars": "sample string 6",
    "maxPricePerFill": 1.0,
    "maxPricePerFillNetworkResultID": 1,
    "maxPricePerFillNetworkOnly": true,
    "maxPricePerDaySupply": 1.0,
    "maxPricePerDaySupplyNetworkResultID": 1,
    "maxPricePerDaySupplyNetworkOnly": true,
    "maxPricePerUnit": 1.0,
    "maxPricePerUnitNetworkResultID": 1,
    "maxPricePerUnitNetworkOnly": true,
    "refillTooSoonMinPercentConsumed": 1.0,
    "maxFillsPerInterval": 1,
    "maxFillsIntervalDays": 1,
    "maxFillsGraceDays": 1,
    "maxFillsPerPeriod": 1,
    "maxFillsPerPeriodGPIChars": "sample string 7",
    "maxFillsPerYear": 1,
    "maxFillsPerYearGPIChars": "sample string 8",
    "maxFillsTotal": 1,
    "maxFillsTotalGPIChars": "sample string 9",
    "claimLimitsMinMemberAge": 1,
    "claimLimitsMaxMemberAge": 1,
    "claimLimitsMemberAgeUnits": "sample string 10",
    "usualAndCustomaryMarginPercent": 1.0,
    "limitQtyToPackageSize": true,
    "maxFillsPerDaysIntervalSpecial": 1,
    "fillDaysIntervalSpecial": 1,
    "fillGraceDaysSpecial": 1
  },
  "ruleActionTypeUrl": "sample string 1",
  "ruleActionTypeNo": 2,
  "alternatePricingGroupUrl": "sample string 4",
  "alternatePricingGroupNo": 1,
  "endProcessing": true,
  "dawEnforceRule": true,
  "rejectCode": "sample string 5",
  "pharmacyPriceMin": 1.0,
  "pharmacyPriceMax": 1.0,
  "pharmacyPricePreTax": true,
  "pharmacyPriceCentsMin": 1.0,
  "pharmacyPriceCentsMax": 1.0,
  "pharmacyPriceCentsPreTax": true,
  "shortCycle": true,
  "newStartDrug": true,
  "newStartDrugByDrugName": true,
  "newDrug": true,
  "firstFillByRx": true,
  "refillExpired": true,
  "onPlan": true,
  "inCompound": true,
  "stepTherapy": true,
  "claimTagItemID1": "cadbabfd-04eb-4602-b802-be35cb0d891f",
  "claimTagItemID2": "02a43691-0304-4b3b-8be4-88e5cf5f2484",
  "claimTagItemID3": "d3a525b7-94fd-4a06-933b-abd2fb281b92",
  "dependentRelationshipCode": "sample string 6",
  "onFormulary": true,
  "formularyNotCoveredException": true,
  "formularyAgeLimitException": true,
  "formularyGenderLimitException": true,
  "formularyQtyLimitException": true,
  "formularyStepMedException": true,
  "formularyPriorAuthException": 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"
    }
  ],
  "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"
    }
  ],
  "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
    }
  ],
  "allowRefillPercentConsumedByNDC": true,
  "allowRefillPercentConsumedGPIChars": "sample string 7",
  "quantityMin": 1.0,
  "quantityMax": 1.0,
  "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
    }
  ],
  "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,
  "groupPlanNo": 8,
  "description": "sample string 9",
  "priority": 1,
  "referenceCode": "sample string 10",
  "message": "sample string 11",
  "changeNote": "sample string 12",
  "effectiveStartDate": "2025-05-30T21:29:36.9721584-05:00",
  "effectiveEndDate": "2025-05-30T21:29:36.9721584-05:00",
  "active": true,
  "daysSupplyMin": 1,
  "daysSupplyMax": 1,
  "memberAgeMin": 1,
  "memberAgeMax": 1,
  "memberAgeUnits": "sample string 13",
  "dependentRelationshipCodes": [
    {
      "displayName": "sample string 1"
    },
    {
      "displayName": "sample string 1"
    }
  ],
  "serviceCategory": "sample string 14",
  "memberGender": "sample string 15",
  "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 16",
  "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 17",
  "pharmacyServiceType": "sample string 18",
  "patientResidenceCriteriaType": "sample string 19",
  "patientResidence": "sample string 20",
  "placeOfServiceCriteriaType": "sample string 21",
  "placeOfService": "sample string 22",
  "benefitCodeUrl": "sample string 23",
  "benefitCodeNo": 1,
  "priorFillsGPIChars": "sample string 24",
  "diagnosisCodeCriteriaType": "sample string 25",
  "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,
  "ndCs": [
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "ndc": "sample string 2"
    },
    {
      "url": "sample string 3",
      "id": 4,
      "ruleNo": 1,
      "ndc": "sample string 2"
    }
  ]
}