Specialists

type: specialists

A specialist is a profession that a practitioner can have, like 'Dentist' or 'Physiotherapist'. Similar to services, specialists are arranged in a tree that currently HAS only 1 level, which means all resources can be retrieved without having to navigate the tree.

important

The specialist resource type, when used as a practitioner's specialities relationship, should use the specialities resource type, instead of the specialists resource type.

{
"specialities": {
"data": [
{
"type": "specialities",
"id": "910ab773-db3d-4ccf-bc0c-102d53b6fd6b"
}
]
}
}

Attributes

id

string

Identifier of the resource.

{
"id": "186d22b2-4f64-431a-abcf-63fa058c0f02"
}

created-at

string read-only

Date of creation of the resource. Format is yyyy-MM-ddTHH:mm:ssZ.

{
"created-at": "2020-10-14T17:28:58.9540769Z"
}

updated-at

string read-only

Date at which the resource was last updated. Format is yyyy-MM-ddTHH:mm:ssZ.

{
"updated-at": "2020-10-14T17:28:58.9540769Z"
}

names

Dictionary<string, string>

Names of the specialist, where keys are ISO-639-1 language codes and values are the translated specialist name.

{
"names": {
"fr": "Cardiologiste",
"en": "Cardiologist"
}
}
important

This attribute is only available when Specialists are fetched as included resources as part of another resource payload.


translations

Dictionary<string, Translation>

Names of the specialist, where keys are ISO-639-1 language codes and values are translated objects.

{
"translations": {
"en": {
"name": {
"value": "Psychologist"
},
"wordCloud": []
},
"fr": {
"name": {
"value": "Psychologue"
},
"wordCloud": []
}
}
}
important

This attribute is only available when fetching Specialists through the /speciality/v1/specialists endpoint.


Relationships

service

Service

The top level service associated with this specialist.

{
"service": {
"id": "a6f658f8-89bf-45ef-a88e-8024da7537d1",
"type": "services"
}
}

parent

Specialist

Parent specialist.

{
"parent": {
"id": "a6f658f8-89bf-45ef-a88e-8024da7537d1",
"type": "specialists"
}
}

children

Array<Specialist>

Children specialists.

{
"children": [
{
"id": "a6f658f8-89bf-45ef-a88e-8024da7537d1",
"type": "specialists"
}
]
}