Update Practitioner's Overspecializations

Updates a practitioner's overspecializations.

PATCH /directory/v1/practitioners/{id}/relationships/overspecializations

Path Parameters

id

string required

Id of the desired resource.

Request Body Parameters

Data

Array<Relationship>

Overspecializations to assign to this practitioner.

{
"data": [
{
"type": "overspecializations",
"id": "7907886b-6a98-4992-8978-93cd173ed357"
},
{
"type": "overspecializations",
"id": "82c2deed-18b9-4a9d-8b0b-0374ddc02dd9"
}
]
}
important

When assigning an overspecialization, one should make sure to assign both the service and the specialist associated with this overspecialization to the practitioner. This will allow users to get better results when searching for terms in the same family as the ones assigned to the resource.

Example of the optimal definition of a resource :

{
"data": {
"type": "practitioners",
"id": "1d6319c1-8510-4803-bbfc-52e5c1303845",
"relationships": {
"specialities": {
"data": [
{
"type": "specialities",
"id": "bb84be48-ae59-43b2-bd80-d0265e773728" // Critical care physician
}
]
},
"services": {
"data": [
{
"type": "services",
"id": "ef267c09-2e75-4c67-a36f-36fc91c46c2c" // Critical care medicine top level service
}
]
},
"overspecializations": {
"data": [
{
"type": "overspecializations",
"id": "d9ac79d3-ce53-4da0-a0ab-a26e8b638b6d"
}, // Breast surgery (Critical care medecine overspecialization)
{
"type": "overspecializations",
"id": "bc06e107-3211-47f0-a0fc-9d6203788ae3"
}, // Cardiology (Critical care medecine overspecialization)
{
"type": "overspecializations",
"id": "423852c1-1096-479f-b2e3-c4c43c46a6ac"
} // Cardiac surgery (Critical care medecine overspecialization)
]
},
"practices": {}
}
}
}
important

Overspecializations sent in an update request will overwrite any existing overspecializations, so make sure to send all overspecializations to associate on each update request.

Examples

Update Overspecializations

curl -X PATCH "https://api.clinia.ca/directory/v1/practitioners/${ID}/relationships/overspecializations" \
-H "Content-Type: application/vnd.api+json"
--data-binary '{
"data": [
{
"type": "overspecializations",
"id": "d9ac79d3-ce53-4da0-a0ab-a26e8b638b6d"
},
{
"type": "overspecializations",
"id": "bc06e107-3211-47f0-a0fc-9d6203788ae3"
},
{
"type": "overspecializations",
"id": "423852c1-1096-479f-b2e3-c4c43c46a6ac"
}
]
}'
{
"data": {
"attributes": {
"created-at": "2020-12-14T20:59:27.9989049Z",
"updated-at": "2020-12-15T19:41:31.4647174Z",
"first-name": "Jcques ",
"last-name": "Plantes",
"title": null,
"gender": null,
"registrations": null,
"accept-new-patients": null,
"is-validated": null,
"is-paying-member": null,
"note": null,
"internal-note": null,
"modalities": null,
"cases-to-refer": null,
"communications": null,
"clientele": null,
"phones": null,
"faxes": null,
"emails": null
},
"relationships": {
"specialities": {
"data": [
{
"type": "specialities",
"id": "bb84be48-ae59-43b2-bd80-d0265e773728"
}
]
},
"overspecializations": {
"data": [
{
"type": "overspecializations",
"id": "d9ac79d3-ce53-4da0-a0ab-a26e8b638b6d"
},
{
"type": "overspecializations",
"id": "423852c1-1096-479f-b2e3-c4c43c46a6ac"
},
{
"type": "overspecializations",
"id": "bc06e107-3211-47f0-a0fc-9d6203788ae3"
}
]
},
"services": {
"data": [
{
"type": "services",
"id": "ef267c09-2e75-4c67-a36f-36fc91c46c2c"
}
]
},
"practices": {}
},
"type": "practitioners",
"id": "977b4d27-f76f-4012-bb45-b56b82f73374"
},
"included": [
{
"attributes": {
"created-at": null,
"updated-at": null,
"names": {
"en": "Critical care physician",
"fr": "Médecin de soins intensifs"
}
},
"relationships": {
"service": {
"data": {
"type": "services",
"id": "ef267c09-2e75-4c67-a36f-36fc91c46c2c"
}
},
"parent": {},
"children": { "data": [] }
},
"type": "specialities",
"id": "bb84be48-ae59-43b2-bd80-d0265e773728"
},
{
"attributes": {
"createdAt": null,
"updatedAt": null,
"names": {
"en": "Critical care medicine",
"fr": "Médecine des soins intensifs"
}
},
"relationships": {
"specialist": {},
"parent": {},
"children": {
"data": [
{
"type": "services",
"id": "0809b416-6bce-43c7-9978-efff0f703eef"
}
]
}
},
"type": "services",
"id": "ef267c09-2e75-4c67-a36f-36fc91c46c2c"
},
{
"attributes": {
"created-at": null,
"updated-at": null,
"names": { "en": "Breast surgery", "fr": "Chirurgie du sein" },
"specialty-id": "ef267c09-2e75-4c67-a36f-36fc91c46c2c"
},
"type": "overspecializations",
"id": "d9ac79d3-ce53-4da0-a0ab-a26e8b638b6d"
},
{
"attributes": {
"created-at": null,
"updated-at": null,
"names": { "en": "Cardiac surgery", "fr": "Chirurgie cardiaque" },
"specialty-id": "ef267c09-2e75-4c67-a36f-36fc91c46c2c"
},
"type": "overspecializations",
"id": "423852c1-1096-479f-b2e3-c4c43c46a6ac"
},
{
"attributes": {
"created-at": null,
"updated-at": null,
"names": { "en": "Cardiology", "fr": "Cardiologie" },
"specialty-id": "ef267c09-2e75-4c67-a36f-36fc91c46c2c"
},
"type": "overspecializations",
"id": "bc06e107-3211-47f0-a0fc-9d6203788ae3"
}
]
}