Get an insurer plan
curl --request GET \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/insurance/plans/{plan_id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/insurance/plans/{plan_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.clinikehr.com/v1/clinics/{clinic_id}/insurance/plans/{plan_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"insurance_company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"code": "<string>",
"id_from_hmo": "<string>",
"plan_type": "<string>",
"coverage_type": "<string>",
"description": "<string>",
"amount_limit": 123,
"co_payment_value": 123,
"cover_dependants": true,
"dependant_limit": 123,
"pre_authorization_required": true,
"network_type": "<string>",
"waiting_period_days": 123,
"active": true,
"updated_at": "2023-11-07T05:31:56Z",
"benefits": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"coverage_type": "<string>",
"claim_category": "<string>",
"covered": true,
"coverage_percentage": 123,
"co_payment_value": 123,
"limit_type": "<string>",
"limit_value": 123,
"max_amount": 123,
"waiting_period": 123,
"enrollee_type": "<string>",
"gender": "<string>",
"active": true
}
]
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}HMO insurance
Get an insurer plan
Permission: insurance.plans:read
Get one plan with its benefits.
Returns the plan and up to 500 benefit lines.
GET
/
v1
/
clinics
/
{clinic_id}
/
insurance
/
plans
/
{plan_id}
Get an insurer plan
curl --request GET \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/insurance/plans/{plan_id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/insurance/plans/{plan_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.clinikehr.com/v1/clinics/{clinic_id}/insurance/plans/{plan_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"insurance_company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"code": "<string>",
"id_from_hmo": "<string>",
"plan_type": "<string>",
"coverage_type": "<string>",
"description": "<string>",
"amount_limit": 123,
"co_payment_value": 123,
"cover_dependants": true,
"dependant_limit": 123,
"pre_authorization_required": true,
"network_type": "<string>",
"waiting_period_days": 123,
"active": true,
"updated_at": "2023-11-07T05:31:56Z",
"benefits": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"coverage_type": "<string>",
"claim_category": "<string>",
"covered": true,
"coverage_percentage": 123,
"co_payment_value": 123,
"limit_type": "<string>",
"limit_value": 123,
"max_amount": 123,
"waiting_period": 123,
"enrollee_type": "<string>",
"gender": "<string>",
"active": true
}
]
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
OK.
A plan of an insurer the clinic linked to your organization. The list omits benefits; the single-plan read carries them (up to 500).
Show child attributes
Show child attributes