Home

Insurance

POST api/Patient/{systemID}/Insurance

Add a new insurance method for a specific patient

Request Information

Parameters

NameDescriptionAdditional information
systemID 
The SystemID of the pharmacy system.

Define this parameter in the request URI.
insurance 
PatientInsurance object
            InsuranceID - Backend Identifier [*Ignored on Create]
            PatientID - Unique Identifier for Patient
            PricePlanID - Identifier for Price Plan
            PricePlanName - Name of Price Plan  [*Ignored on Create/Update]
            PolicyNumber - Insurance Policy Number
            GroupNumber - Group Insurance Number
            PersonCode - 
            OrderNo - Priority level (0 - First Position, -1 - Last Position)
            EffectiveDate - Date Insurance Takes Effect - YYYYMMDD
            ExpirationDate - Date Insurance Expires - YYYYMMDD
            CardHolderPatientID - Unique Identifier for Card Holder
            CardHolderPatientName - Name of Card Holder [*Ignored on Create/Update]
            RelationshipToCardHolder - (See /api/RelationshipToCardHolderList for valid values)
            OtherCoverageCode - (See /api/CoverageCodeList for valid values)
            FacilityID - Facility Identifier
            AcceptAssignment - Insurance Can Be Assigned (Y/N)
            CouponCard - Insurance Accepts Coupons (Y/N)
            InActive - Deactivate Insurance Method (Y/N)
            PricePlanBin - Price Plan BIN (Optional)

Define this parameter in the request body.
    

Response Codes

    
  • OK (200)
  • BadRequest (400)
  • NotFound (404)
  • InternalServerError (500)
    •     

Request body formats

application/json, text/json

Sample: 
{
  "PatientID": "sample string 1",
  "PricePlanID": "sample string 2",
  "PricePlanName": "sample string 3",
  "PolicyNumber": "sample string 4",
  "GroupNumber": "sample string 5",
  "PersonCode": "sample string 6",
  "InsuranceID": 1,
  "OrderNo": 1,
  "EffectiveDate": "sample string 7",
  "ExpirationDate": "sample string 8",
  "CardHolderPatientID": "sample string 9",
  "CardHolderPatientName": "sample string 10",
  "RelationshipToCardHolder": "sample string 11",
  "OtherCoverageCode": "sample string 12",
  "FacilityID": "sample string 13",
  "AcceptAssignment": "sample string 14",
  "CouponCard": "sample string 15",
  "Inactive": "sample string 16",
  "PricePlanBin": "sample string 17"
}

text/javascript

Sample: 
{"PatientID":"sample string 1","PricePlanID":"sample string 2","PricePlanName":"sample string 3","PolicyNumber":"sample string 4","GroupNumber":"sample string 5","PersonCode":"sample string 6","InsuranceID":1,"OrderNo":1,"EffectiveDate":"sample string 7","ExpirationDate":"sample string 8","CardHolderPatientID":"sample string 9","CardHolderPatientName":"sample string 10","RelationshipToCardHolder":"sample string 11","OtherCoverageCode":"sample string 12","FacilityID":"sample string 13","AcceptAssignment":"sample string 14","CouponCard":"sample string 15","Inactive":"sample string 16","PricePlanBin":"sample string 17"}

application/xml, text/xml

Sample: 
<PatientInsurance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <AcceptAssignment>sample string 14</AcceptAssignment>
  <CardHolderPatientID>sample string 9</CardHolderPatientID>
  <CardHolderPatientName>sample string 10</CardHolderPatientName>
  <CouponCard>sample string 15</CouponCard>
  <EffectiveDate>sample string 7</EffectiveDate>
  <ExpirationDate>sample string 8</ExpirationDate>
  <FacilityID>sample string 13</FacilityID>
  <GroupNumber>sample string 5</GroupNumber>
  <Inactive>sample string 16</Inactive>
  <InsuranceID>1</InsuranceID>
  <OrderNo>1</OrderNo>
  <OtherCoverageCode>sample string 12</OtherCoverageCode>
  <PatientID>sample string 1</PatientID>
  <PersonCode>sample string 6</PersonCode>
  <PolicyNumber>sample string 4</PolicyNumber>
  <PricePlanBin>sample string 17</PricePlanBin>
  <PricePlanID>sample string 2</PricePlanID>
  <PricePlanName>sample string 3</PricePlanName>
  <RelationshipToCardHolder>sample string 11</RelationshipToCardHolder>
</PatientInsurance>

Response Information

PatientInsurance object

Response body formats

application/json, text/json

Sample: 
{
  "PatientID": "sample string 1",
  "PricePlanID": "sample string 2",
  "PricePlanName": "sample string 3",
  "PolicyNumber": "sample string 4",
  "GroupNumber": "sample string 5",
  "PersonCode": "sample string 6",
  "InsuranceID": 1,
  "OrderNo": 1,
  "EffectiveDate": "sample string 7",
  "ExpirationDate": "sample string 8",
  "CardHolderPatientID": "sample string 9",
  "CardHolderPatientName": "sample string 10",
  "RelationshipToCardHolder": "sample string 11",
  "OtherCoverageCode": "sample string 12",
  "FacilityID": "sample string 13",
  "AcceptAssignment": "sample string 14",
  "CouponCard": "sample string 15",
  "Inactive": "sample string 16",
  "PricePlanBin": "sample string 17"
}

text/javascript

Sample: 
{"PatientID":"sample string 1","PricePlanID":"sample string 2","PricePlanName":"sample string 3","PolicyNumber":"sample string 4","GroupNumber":"sample string 5","PersonCode":"sample string 6","InsuranceID":1,"OrderNo":1,"EffectiveDate":"sample string 7","ExpirationDate":"sample string 8","CardHolderPatientID":"sample string 9","CardHolderPatientName":"sample string 10","RelationshipToCardHolder":"sample string 11","OtherCoverageCode":"sample string 12","FacilityID":"sample string 13","AcceptAssignment":"sample string 14","CouponCard":"sample string 15","Inactive":"sample string 16","PricePlanBin":"sample string 17"}

application/xml, text/xml

Sample: 
<PatientInsurance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <AcceptAssignment>sample string 14</AcceptAssignment>
  <CardHolderPatientID>sample string 9</CardHolderPatientID>
  <CardHolderPatientName>sample string 10</CardHolderPatientName>
  <CouponCard>sample string 15</CouponCard>
  <EffectiveDate>sample string 7</EffectiveDate>
  <ExpirationDate>sample string 8</ExpirationDate>
  <FacilityID>sample string 13</FacilityID>
  <GroupNumber>sample string 5</GroupNumber>
  <Inactive>sample string 16</Inactive>
  <InsuranceID>1</InsuranceID>
  <OrderNo>1</OrderNo>
  <OtherCoverageCode>sample string 12</OtherCoverageCode>
  <PatientID>sample string 1</PatientID>
  <PersonCode>sample string 6</PersonCode>
  <PolicyNumber>sample string 4</PolicyNumber>
  <PricePlanBin>sample string 17</PricePlanBin>
  <PricePlanID>sample string 2</PricePlanID>
  <PricePlanName>sample string 3</PricePlanName>
  <RelationshipToCardHolder>sample string 11</RelationshipToCardHolder>
</PatientInsurance>