Update or end a coverage
curl --request PATCH \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/coverages/{coverage_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"member_id": "<string>",
"group_number": "<string>",
"group_name": "<string>",
"plan_name": "<string>",
"subscriber_first_name": "<string>",
"subscriber_last_name": "<string>",
"subscriber_date_of_birth": "2023-12-25",
"subscriber_member_id": "<string>",
"subscriber_address_line1": "<string>",
"subscriber_address_city": "<string>",
"subscriber_address_state": "<string>",
"subscriber_address_zip": "<string>",
"coverage_active": true,
"effective_date": "2023-12-25",
"termination_date": "2023-12-25",
"copay_amount": 1,
"coinsurance_percent": 50,
"deductible_amount": 1,
"out_of_pocket_max": 1,
"pre_authorization_required": true,
"is_primary": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
member_id: '<string>',
group_number: '<string>',
group_name: '<string>',
plan_name: '<string>',
subscriber_first_name: '<string>',
subscriber_last_name: '<string>',
subscriber_date_of_birth: '2023-12-25',
subscriber_member_id: '<string>',
subscriber_address_line1: '<string>',
subscriber_address_city: '<string>',
subscriber_address_state: '<string>',
subscriber_address_zip: '<string>',
coverage_active: true,
effective_date: '2023-12-25',
termination_date: '2023-12-25',
copay_amount: 1,
coinsurance_percent: 50,
deductible_amount: 1,
out_of_pocket_max: 1,
pre_authorization_required: true,
is_primary: true
})
};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/coverages/{coverage_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}/coverages/{coverage_id}"
payload = {
"payer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"member_id": "<string>",
"group_number": "<string>",
"group_name": "<string>",
"plan_name": "<string>",
"subscriber_first_name": "<string>",
"subscriber_last_name": "<string>",
"subscriber_date_of_birth": "2023-12-25",
"subscriber_member_id": "<string>",
"subscriber_address_line1": "<string>",
"subscriber_address_city": "<string>",
"subscriber_address_state": "<string>",
"subscriber_address_zip": "<string>",
"coverage_active": True,
"effective_date": "2023-12-25",
"termination_date": "2023-12-25",
"copay_amount": 1,
"coinsurance_percent": 50,
"deductible_amount": 1,
"out_of_pocket_max": 1,
"pre_authorization_required": True,
"is_primary": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"coverage_active": true,
"verification_status": "confirmed",
"source": "clinic",
"payer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>"
},
"member_id": "<string>",
"group_number": "<string>",
"group_name": "<string>",
"plan_name": "<string>",
"coverage_type": "medical",
"payment_responsibility": "P",
"relationship_to_subscriber": "self",
"subscriber": {
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"gender": "M",
"member_id": "<string>"
},
"is_primary": true,
"effective_date": "2023-12-25",
"termination_date": "2023-12-25",
"copay_amount": 123,
"coinsurance_percent": 123,
"deductible_amount": 123,
"out_of_pocket_max": 123,
"pre_authorization_required": true,
"network_status": "in_network",
"eligibility": {
"status": "<string>",
"checked_at": "2023-11-07T05:31:56Z"
},
"origin_assistant_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"idempotent_replay": 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>"
}
]
}Insurance coverage
Update or end a coverage
Permission: coverage:write
Change a coverage, or end it.
Answers 200 with the coverage. Changing who the coverage is for on a confirmed coverage sends it back to unconfirmed and inactive for staff to confirm again. coverage_active: false and termination_date end a coverage; coverage_active: true is refused (activation_requires_staff). The Idempotency-Key header is optional. Send JSON; a FHIR Coverage body is refused.
PATCH
/
v1
/
clinics
/
{clinic_id}
/
coverages
/
{coverage_id}
Update or end a coverage
curl --request PATCH \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/coverages/{coverage_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"member_id": "<string>",
"group_number": "<string>",
"group_name": "<string>",
"plan_name": "<string>",
"subscriber_first_name": "<string>",
"subscriber_last_name": "<string>",
"subscriber_date_of_birth": "2023-12-25",
"subscriber_member_id": "<string>",
"subscriber_address_line1": "<string>",
"subscriber_address_city": "<string>",
"subscriber_address_state": "<string>",
"subscriber_address_zip": "<string>",
"coverage_active": true,
"effective_date": "2023-12-25",
"termination_date": "2023-12-25",
"copay_amount": 1,
"coinsurance_percent": 50,
"deductible_amount": 1,
"out_of_pocket_max": 1,
"pre_authorization_required": true,
"is_primary": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
member_id: '<string>',
group_number: '<string>',
group_name: '<string>',
plan_name: '<string>',
subscriber_first_name: '<string>',
subscriber_last_name: '<string>',
subscriber_date_of_birth: '2023-12-25',
subscriber_member_id: '<string>',
subscriber_address_line1: '<string>',
subscriber_address_city: '<string>',
subscriber_address_state: '<string>',
subscriber_address_zip: '<string>',
coverage_active: true,
effective_date: '2023-12-25',
termination_date: '2023-12-25',
copay_amount: 1,
coinsurance_percent: 50,
deductible_amount: 1,
out_of_pocket_max: 1,
pre_authorization_required: true,
is_primary: true
})
};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/coverages/{coverage_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}/coverages/{coverage_id}"
payload = {
"payer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"member_id": "<string>",
"group_number": "<string>",
"group_name": "<string>",
"plan_name": "<string>",
"subscriber_first_name": "<string>",
"subscriber_last_name": "<string>",
"subscriber_date_of_birth": "2023-12-25",
"subscriber_member_id": "<string>",
"subscriber_address_line1": "<string>",
"subscriber_address_city": "<string>",
"subscriber_address_state": "<string>",
"subscriber_address_zip": "<string>",
"coverage_active": True,
"effective_date": "2023-12-25",
"termination_date": "2023-12-25",
"copay_amount": 1,
"coinsurance_percent": 50,
"deductible_amount": 1,
"out_of_pocket_max": 1,
"pre_authorization_required": True,
"is_primary": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"coverage_active": true,
"verification_status": "confirmed",
"source": "clinic",
"payer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>"
},
"member_id": "<string>",
"group_number": "<string>",
"group_name": "<string>",
"plan_name": "<string>",
"coverage_type": "medical",
"payment_responsibility": "P",
"relationship_to_subscriber": "self",
"subscriber": {
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"gender": "M",
"member_id": "<string>"
},
"is_primary": true,
"effective_date": "2023-12-25",
"termination_date": "2023-12-25",
"copay_amount": 123,
"coinsurance_percent": 123,
"deductible_amount": 123,
"out_of_pocket_max": 123,
"pre_authorization_required": true,
"network_status": "in_network",
"eligibility": {
"status": "<string>",
"checked_at": "2023-11-07T05:31:56Z"
},
"origin_assistant_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"idempotent_replay": 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.
Headers
Optional. A unique value you choose for this request, such as a UUID. When sent, a retry with the same key returns the first answer instead of applying the change twice. See Retries and idempotency.
Minimum string length:
1Body
application/json
A change to an existing coverage. Changing who the coverage is for (payer_id, member_id, group_number, subscriber_member_id, relationship_to_subscriber or the policy holder's name or date of birth) on a confirmed coverage sends it back to unconfirmed and inactive until staff confirm it again. Other edits keep its status. coverage_active: false and termination_date end a coverage; coverage_active: true is refused with activation_requires_staff. Nothing is ever deleted. Send JSON; a FHIR Coverage body is not accepted.
Maximum string length:
200Maximum string length:
200Maximum string length:
200Maximum string length:
200Available options:
medical, dental, vision, behavioral_health, other Available options:
P, S, T Available options:
self, spouse, child, other, employee, organ_donor, cadaver_donor, life_partner Maximum string length:
200Maximum string length:
200Available options:
M, F, U Maximum string length:
200Maximum string length:
200Maximum string length:
200Maximum string length:
200Maximum string length:
200Only false is accepted: it ends the coverage. true is refused.
Required range:
x >= 0Required range:
0 <= x <= 100Required range:
x >= 0Required range:
x >= 0Available options:
in_network, out_of_network, unknown Response
OK.
A patient's insurance coverage — the exposed-field allow-list, field by field. A coverage that came in through the API is saved straight away and visible here, but it is unconfirmed and coverage_active is false until clinic staff confirm the payer match; the clinic's own coverages are confirmed. Eligibility figures, the clinic's notes and the policy holder's address are never exposed.
Show child attributes
Show child attributes
Present and true when this Idempotency-Key was already used and the original answer is returned.