POST api/patients/{patientId}/insurance
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| patientId | integer |
Required |
Body Parameters
CustomInsuranceRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| PatientInsuranceIdentifierType | PatientInsuranceIdentifierType |
Required |
|
| PatientInsuranceIdentifier | string |
Required String length: inclusive between 0 and 35 |
|
| PersonCode | string |
String length: inclusive between 0 and 2 |
|
| PayerName | string |
None. |
|
| CustomEligibilityDetails | Collection of CustomEligibilityInfo |
None. |
Request Formats
application/json, text/json
Sample:
{
"PatientInsuranceIdentifierType": 1,
"PatientInsuranceIdentifier": "sample string 1",
"PersonCode": "sample string 2",
"PayerName": "sample string 3",
"CustomEligibilityDetails": [
{
"CustomEligibilityInfoType": 3,
"CustomEligibilityInfoValue": "sample string 1"
},
{
"CustomEligibilityInfoType": 3,
"CustomEligibilityInfoValue": "sample string 1"
}
]
}
application/xml, text/xml
Sample:
<CustomInsuranceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
<CustomEligibilityDetails>
<CustomEligibilityInfo>
<CustomEligibilityInfoType>CardholderID</CustomEligibilityInfoType>
<CustomEligibilityInfoValue>sample string 1</CustomEligibilityInfoValue>
</CustomEligibilityInfo>
<CustomEligibilityInfo>
<CustomEligibilityInfoType>CardholderID</CustomEligibilityInfoType>
<CustomEligibilityInfoValue>sample string 1</CustomEligibilityInfoValue>
</CustomEligibilityInfo>
</CustomEligibilityDetails>
<PatientInsuranceIdentifier>sample string 1</PatientInsuranceIdentifier>
<PatientInsuranceIdentifierType>PayerID</PatientInsuranceIdentifierType>
<PayerName>sample string 3</PayerName>
<PersonCode>sample string 2</PersonCode>
</CustomInsuranceRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IdentifierResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| Result | Result |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": 1,
"Result": {
"ResultCode": "sample string 1",
"ResultDescription": "sample string 2"
}
}
application/xml, text/xml
Sample:
<IdentifierResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
<Result>
<ResultCode>sample string 1</ResultCode>
<ResultDescription>sample string 2</ResultDescription>
</Result>
<Id>1</Id>
</IdentifierResponse>