Update an outside care provider
curl --request PATCH \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/care-providers/{care_provider_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"practice_name": "<string>",
"specialty": "<string>",
"npi": "<string>",
"phone": "<string>",
"fax": "<string>",
"address": "<string>",
"is_primary": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
practice_name: '<string>',
specialty: '<string>',
npi: '<string>',
phone: '<string>',
fax: '<string>',
address: '<string>',
is_primary: true
})
};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/care-providers/{care_provider_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}/care-providers/{care_provider_id}"
payload = {
"name": "<string>",
"practice_name": "<string>",
"specialty": "<string>",
"npi": "<string>",
"phone": "<string>",
"fax": "<string>",
"address": "<string>",
"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",
"type": "pcp",
"name": "<string>",
"is_primary": true,
"source": "clinic",
"editable": true,
"practice_name": "<string>",
"specialty": "<string>",
"npi": "<string>",
"phone": "<string>",
"fax": "<string>",
"address": "<string>",
"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>"
}
]
}Care providers
Update an outside care provider
Permission: care_providers:write
Change an outside care provider your app added.
Answers 200 with the contact. Only a contact an app added can be changed, and only by an app of the same owner; a contact the clinic added (editable: false) answers 409 care_provider_clinic_managed. The patient cannot be changed. The Idempotency-Key header is optional.
PATCH
/
v1
/
clinics
/
{clinic_id}
/
care-providers
/
{care_provider_id}
Update an outside care provider
curl --request PATCH \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/care-providers/{care_provider_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"practice_name": "<string>",
"specialty": "<string>",
"npi": "<string>",
"phone": "<string>",
"fax": "<string>",
"address": "<string>",
"is_primary": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
practice_name: '<string>',
specialty: '<string>',
npi: '<string>',
phone: '<string>',
fax: '<string>',
address: '<string>',
is_primary: true
})
};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/care-providers/{care_provider_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}/care-providers/{care_provider_id}"
payload = {
"name": "<string>",
"practice_name": "<string>",
"specialty": "<string>",
"npi": "<string>",
"phone": "<string>",
"fax": "<string>",
"address": "<string>",
"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",
"type": "pcp",
"name": "<string>",
"is_primary": true,
"source": "clinic",
"editable": true,
"practice_name": "<string>",
"specialty": "<string>",
"npi": "<string>",
"phone": "<string>",
"fax": "<string>",
"address": "<string>",
"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 outside care provider your app added. The patient cannot be changed. is_primary: true makes the patient's other contacts of the same type non-primary.
Required string length:
1 - 200Available options:
pcp, referring, specialist, other Maximum string length:
200Maximum string length:
100Pattern:
^[0-9]{10}$Maximum string length:
40Maximum string length:
40Maximum string length:
500Response
OK.
An outside clinician a patient names (their own doctor, a referring doctor, a specialist) — the exposed-field allow-list, field by field. source is clinic for a contact the clinic recorded (including one taken from an intake form) and api for one an app added. editable is true only when this key's app added the contact, so it may change or remove it; every other contact is read only to apps. The clinic's own notes on a contact 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.