Product Composer for Healthcare REST APIs
Product Composer for Healthcare provides the healthcarepcsAPI service package name. The REST services include CreatePCSPlan and PlanCostShareRanges.
CreatePCSPlan
This REST service takes the existing plan ID as an input and applies these
customizations to create a new plan. The new PlanID is returned as a response to the
requesting system. The CreatePCS Plan API can be found at CreatePCSPlan
healthcarepcsAPI/v1/PlanCostShareRanges
.
Method: POST
Query parameters: None
Request parameters
Name | Type | Description |
SourcePlanId | Text | The plan ID of the source plan. |
CustomerPlanText | Text | Holds the configurations, if any, to be done on the target plan. |
Sample request:
{
“SourcePlanId” : “PLAN-2506”, “CustomPlanText”:”Update the benefit Ambulance to have copay of 15$ for in Network and 25$ for Out network”
}
Sample response:
{
“planID” : “PLAN-2801”
}
Response codes
Status code | Message |
400 | Invalid Request |
500 | Server Error |
404 | Not Found Error |
PlanCostShareRanges
This service returns cost share ranges of the base plan, which acts as reference point so that custom plan costshares can be configured appropriately. The incoming request would include plan type, network details, product line and market segment along with plan ID.
Method: POST
Query parameters: None
Request parameters
Name | Type | Description |
PlanSearchCriteria | List of name or value pairs | Holds search criteria as name or value pairs |
Sample request:
Example 1 (multiple search criteria)
{
"PlanSearchCriteria":[
{
"Name":"Category",
"Value":"Medical"
},
{
"Name":"Version",
"Value":"01"
}
]
}
Example 2 (unique plan ID)
{
"PlanSearchCriteria":[
{
"Name":"PlanID",
"Value":"PLAN-1022"
}
]
}
Sample response:
{
"Status": "Success",
"BaseName": "PLAN-30267",
"Product": <Plan costshare range details>
"ProductID": " PRD-34268-1560237289568",
"ContractID": "PLAN-30267",
"NetworkNodes": <Plan network costshare range details>
"BenefitCategoriesList”: <Plan benefit costshare range details for the default benefit of the benefit category>
"Version": "01-01",
"AliasName": "API Test Plan",
"SubCategory": "Medical",
"PlanType": "Standard",
"TermDate": "20181231",
"VersionIdentity": "June11 PLn2 (01-01)",
"ProductLine": "POS",
"EffectiveDate": "20180101"
}
Response codes
Status code | Description |
400 | Invalid Request |
500 | Server Error |
Previous topic Extending union data Next topic Customizing reports