Services

type: services

A service is a procedure, a treatment or any type of healthcare service that a patient can receive in a health facility, or that can be dispensed by a practitioner. Services are arranged in a tree, with top level services being broad healthcare categories like 'Denturology' and 'Physiotherapy'. Under those top level services are child services which are related to the category. Those child services may in turn have their own children, and so on.

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 service, where keys are ISO-639-1 language codes and values are the translated service name.

{
"names": {
"fr": "Scanner abdominal",
"en": "Abdominal CT scan"
}
}
important

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


translations

Dictionary<string, Translation>

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

{
"translations": {
"en": {
"name": {
"value": "Occupational medicine"
},
"wordCloud": []
},
"fr": {
"name": {
"value": "Médecine du travail"
},
"wordCloud": []
}
}
}
important

This attribute is only available when fetching Services through the /speciality/v1/services endpoint.


Relationships

parent

Service

Parent service. Service that is directly over the given service in the service tree.

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

children

Array<Service>

Children services. Services that are directly under the given service in the service tree.

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