IPrimeSuiteAPI REST API Documentation
MedicationFormularyGet
Method: POST
URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/MedicationFormularyGet
Request Format: Xml or Json
Request XML Example (schema):
<?xml version="1.0" encoding="utf-16"?>
<MedicationFormularyGetRequest>
<Header>
<SourceSiteID>String Content</SourceSiteID>
<DestinationSiteID>String Content</DestinationSiteID>
<PrimeSuiteUserID>0</PrimeSuiteUserID>
</Header>
<Credentials>
<PrimeSuiteCredential>
<PrimeSuiteSiteId>String Content</PrimeSuiteSiteId>
<PrimeSuiteUserName>String Content</PrimeSuiteUserName>
<PrimeSuiteUserPassword>String Content</PrimeSuiteUserPassword>
<PrimeSuiteUserAlias>String Content</PrimeSuiteUserAlias>
</PrimeSuiteCredential>
<VendorCredential>
<VendorLogin>String Content</VendorLogin>
<VendorPassword>String Content</VendorPassword>
</VendorCredential>
</Credentials>
<MNID>0</MNID>
<MEDID>0</MEDID>
<PBMPatientInfo>
<CopayID>String Content</CopayID>
<CoverageID>String Content</CoverageID>
<AlternativeID>String Content</AlternativeID>
<FormularyID>String Content</FormularyID>
<PlanName>String Content</PlanName>
<PayerName>String Content</PayerName>
</PBMPatientInfo>
</MedicationFormularyGetRequest>
Request Json Example (schema):
{
"Header": {
"SourceSiteID": "String Content",
"DestinationSiteID": "String Content",
"PrimeSuiteUserID": 0
},
"Credentials": {
"PrimeSuiteCredential": {
"PrimeSuiteSiteId": "String Content",
"PrimeSuiteUserName": "String Content",
"PrimeSuiteUserPassword": "String Content",
"PrimeSuiteUserAlias": "String Content"
},
"VendorCredential": {
"VendorLogin": "String Content",
"VendorPassword": "String Content"
}
},
"MNID": 0,
"MEDID": 0,
"PBMPatientInfo": {
"CopayID": "String Content",
"CoverageID": "String Content",
"AlternativeID": "String Content",
"FormularyID": "String Content",
"PlanName": "String Content",
"PayerName": "String Content"
}
}
Response Format: Xml
Response XML Example (schema):
<?xml version="1.0" encoding="utf-16"?>
<MedicationFormularyGetResponse>
<Formulary>
<FormularyID>String Content</FormularyID>
<FormularyStatus>String Content</FormularyStatus>
<FormularyStatusDescription>String Content</FormularyStatusDescription>
<CoverageID>String Content</CoverageID>
<AlternativeID>String Content</AlternativeID>
<CopayID>String Content</CopayID>
<GorB>String Content</GorB>
<DrugExclusion>String Content</DrugExclusion>
<RxRequired>String Content</RxRequired>
</Formulary>
<Copays>
<CoPayID>String Content</CoPayID>
<medid>String Content</medid>
<PharmacyType>String Content</PharmacyType>
<FlatCoPayAmount>String Content</FlatCoPayAmount>
<PercentCoPayRate>String Content</PercentCoPayRate>
<FirstCoPayTerm>String Content</FirstCoPayTerm>
<MinimumCoPay>String Content</MinimumCoPay>
<MaximumCoPay>String Content</MaximumCoPay>
<DaysSupplyPerCoPay>String Content</DaysSupplyPerCoPay>
<CoPayTier>String Content</CoPayTier>
<MaximumCoPayTier>String Content</MaximumCoPayTier>
<ProductType>String Content</ProductType>
<FormularyStatusDesc>String Content</FormularyStatusDesc>
<ProductServiceID>String Content</ProductServiceID>
<MedicationDescription>String Content</MedicationDescription>
<OutOfPocketRangeStart>String Content</OutOfPocketRangeStart>
<OutOfPocketRangeEnd>String Content</OutOfPocketRangeEnd>
</Copays>
<Coverage>
<CoverageListID>String Content</CoverageListID>
<AgeLimits>
<DrugReferenceNumber>String Content</DrugReferenceNumber>
<DrugReferenceQualifier>String Content</DrugReferenceQualifier>
<MinimumAge>String Content</MinimumAge>
<MinimumAgeQualifier>String Content</MinimumAgeQualifier>
<MaximumAge>String Content</MaximumAge>
<MaximumAgeQualifier>String Content</MaximumAgeQualifier>
<MedicationDescription>String Content</MedicationDescription>
<medid>String Content</medid>
</AgeLimits>
<GenderLimits>
<DrugReferenceNumber>String Content</DrugReferenceNumber>
<DrugReferenceQualifier>String Content</DrugReferenceQualifier>
<Gender>0</Gender>
<MedicationDescription>String Content</MedicationDescription>
<medid>String Content</medid>
</GenderLimits>
<TextList>
<DrugReferenceNumber>String Content</DrugReferenceNumber>
<DrugReferenceQualifier>String Content</DrugReferenceQualifier>
<MessageShort>String Content</MessageShort>
<MessageLong>String Content</MessageLong>
<MedicationDescription>String Content</MedicationDescription>
<medid>String Content</medid>
</TextList>
<QuantityLimits>
<DrugReferenceNumber>String Content</DrugReferenceNumber>
<DrugReferenceQualifier>String Content</DrugReferenceQualifier>
<MaximumAmount>String Content</MaximumAmount>
<MaximumAmountQualifier>String Content</MaximumAmountQualifier>
<MaximumAmountTimePeriod>String Content</MaximumAmountTimePeriod>
<MaximumAmountTimePeriodStartDate>String Content</MaximumAmountTimePeriodStartDate>
<MaximumAmountTimePeriodEndDate>String Content</MaximumAmountTimePeriodEndDate>
<MaximumAmountTimePeriodUnits>String Content</MaximumAmountTimePeriodUnits>
<MedicationDescription>String Content</MedicationDescription>
<medid>String Content</medid>
</QuantityLimits>
<StepMedications>
<DrugReferenceNumberSource>String Content</DrugReferenceNumberSource>
<ProductServiceIDStepDrug>String Content</ProductServiceIDStepDrug>
<DrugReferenceNumberStepDrug>String Content</DrugReferenceNumberStepDrug>
<DrugReferenceQualifierStepDrug>String Content</DrugReferenceQualifierStepDrug>
<DrugQualifierStepDrug>String Content</DrugQualifierStepDrug>
<ClassIDStepDrug>String Content</ClassIDStepDrug>
<SubclassIDStepDrug>String Content</SubclassIDStepDrug>
<NumberOfDrugsToTry>String Content</NumberOfDrugsToTry>
<StepOrder>String Content</StepOrder>
<DiagnosisCode>String Content</DiagnosisCode>
<DiagnosisCodeQualifier>String Content</DiagnosisCodeQualifier>
<MedicationDescription>String Content</MedicationDescription>
<StepMedicationDescription>String Content</StepMedicationDescription>
<medid>String Content</medid>
</StepMedications>
<ResourceLink>
<ResourceLinkType>String Content</ResourceLinkType>
<URL>String Content</URL>
<ProductServiceID>String Content</ProductServiceID>
</ResourceLink>
<ResourceLinksDrugSpecific>
<ResourceLinkType>String Content</ResourceLinkType>
<MedicationDescription>String Content</MedicationDescription>
<URL>String Content</URL>
<medid>String Content</medid>
</ResourceLinksDrugSpecific>
<CoverageTypes>
<ProductServiceID>String Content</ProductServiceID>
<CoverageType>String Content</CoverageType>
<CoverageTypeDesc>String Content</CoverageTypeDesc>
<MedicationDescription>String Content</MedicationDescription>
<medid>String Content</medid>
</CoverageTypes>
</Coverage>
<FormularyMeds>
<medid>String Content</medid>
<Altmedid>String Content</Altmedid>
<MedDescription>String Content</MedDescription>
<MedDescription1>String Content</MedDescription1>
<AlternativeDescription>String Content</AlternativeDescription>
<PreferenceLevel>String Content</PreferenceLevel>
<DrugName>String Content</DrugName>
<Strength>String Content</Strength>
<StrengthUnits>String Content</StrengthUnits>
<ProductServiceID>String Content</ProductServiceID>
<GCNSeqNo>String Content</GCNSeqNo>
<FormularyStatus>String Content</FormularyStatus>
<FormularyStatusID>String Content</FormularyStatusID>
<RxRequired>String Content</RxRequired>
<GorB>String Content</GorB>
<MNID>String Content</MNID>
<DoseForm>String Content</DoseForm>
<DoseFormID>String Content</DoseFormID>
<DoseQuantityUnit>String Content</DoseQuantityUnit>
<DefaultPackage>String Content</DefaultPackage>
<RouteID>String Content</RouteID>
<Route>String Content</Route>
<DeaCode>String Content</DeaCode>
</FormularyMeds>
</MedicationFormularyGetResponse>
Response Format: Json
Response Example (schema):
{
"Formulary": {
"FormularyID": "String Content",
"FormularyStatus": "String Content",
"FormularyStatusDescription": "String Content",
"CoverageID": "String Content",
"AlternativeID": "String Content",
"CopayID": "String Content",
"GorB": "String Content",
"DrugExclusion": "String Content",
"RxRequired": "String Content"
},
"Copays": [
{
"CoPayID": "String Content",
"medid": "String Content",
"PharmacyType": "String Content",
"FlatCoPayAmount": "String Content",
"PercentCoPayRate": "String Content",
"FirstCoPayTerm": "String Content",
"MinimumCoPay": "String Content",
"MaximumCoPay": "String Content",
"DaysSupplyPerCoPay": "String Content",
"CoPayTier": "String Content",
"MaximumCoPayTier": "String Content",
"ProductType": "String Content",
"FormularyStatusDesc": "String Content",
"ProductServiceID": "String Content",
"MedicationDescription": "String Content",
"OutOfPocketRangeStart": "String Content",
"OutOfPocketRangeEnd": "String Content"
}
],
"Coverage": {
"CoverageListID": "String Content",
"AgeLimits": [
{
"DrugReferenceNumber": "String Content",
"DrugReferenceQualifier": "String Content",
"MinimumAge": "String Content",
"MinimumAgeQualifier": "String Content",
"MaximumAge": "String Content",
"MaximumAgeQualifier": "String Content",
"MedicationDescription": "String Content",
"medid": "String Content"
}
],
"GenderLimits": [
{
"DrugReferenceNumber": "String Content",
"DrugReferenceQualifier": "String Content",
"Gender": 0,
"MedicationDescription": "String Content",
"medid": "String Content"
}
],
"TextList": [
{
"DrugReferenceNumber": "String Content",
"DrugReferenceQualifier": "String Content",
"MessageShort": "String Content",
"MessageLong": "String Content",
"MedicationDescription": "String Content",
"medid": "String Content"
}
],
"QuantityLimits": [
{
"DrugReferenceNumber": "String Content",
"DrugReferenceQualifier": "String Content",
"MaximumAmount": "String Content",
"MaximumAmountQualifier": "String Content",
"MaximumAmountTimePeriod": "String Content",
"MaximumAmountTimePeriodStartDate": "String Content",
"MaximumAmountTimePeriodEndDate": "String Content",
"MaximumAmountTimePeriodUnits": "String Content",
"MedicationDescription": "String Content",
"medid": "String Content"
}
],
"StepMedications": [
{
"DrugReferenceNumberSource": "String Content",
"ProductServiceIDStepDrug": "String Content",
"DrugReferenceNumberStepDrug": "String Content",
"DrugReferenceQualifierStepDrug": "String Content",
"DrugQualifierStepDrug": "String Content",
"ClassIDStepDrug": "String Content",
"SubclassIDStepDrug": "String Content",
"NumberOfDrugsToTry": "String Content",
"StepOrder": "String Content",
"DiagnosisCode": "String Content",
"DiagnosisCodeQualifier": "String Content",
"MedicationDescription": "String Content",
"StepMedicationDescription": "String Content",
"medid": "String Content"
}
],
"ResourceLink": {
"ResourceLinkType": "String Content",
"URL": "String Content",
"ProductServiceID": "String Content"
},
"ResourceLinksDrugSpecific": [
{
"ResourceLinkType": "String Content",
"MedicationDescription": "String Content",
"URL": "String Content",
"medid": "String Content"
}
],
"CoverageTypes": [
{
"ProductServiceID": "String Content",
"CoverageType": "String Content",
"CoverageTypeDesc": "String Content",
"MedicationDescription": "String Content",
"medid": "String Content"
}
]
},
"FormularyMeds": {
"medid": "String Content",
"Altmedid": "String Content",
"MedDescription": "String Content",
"MedDescription1": "String Content",
"AlternativeDescription": "String Content",
"PreferenceLevel": "String Content",
"DrugName": "String Content",
"Strength": "String Content",
"StrengthUnits": "String Content",
"ProductServiceID": "String Content",
"GCNSeqNo": "String Content",
"FormularyStatus": "String Content",
"FormularyStatusID": "String Content",
"RxRequired": "String Content",
"GorB": "String Content",
"MNID": "String Content",
"DoseForm": "String Content",
"DoseFormID": "String Content",
"DoseQuantityUnit": "String Content",
"DefaultPackage": "String Content",
"RouteID": "String Content",
"Route": "String Content",
"DeaCode": "String Content"
}
}