Health Facilities

type: health-facilities

Health facilities are physical establishments where a patient can seek and receive health care services. Health facilities can take many forms, and this is why Clinia manages them using many variants in order to specialize user experience. There are currently 7 sub-types of health facilities :

Each of these types has his own attributes and relationships. All of the possible attributes and relationships for all the different sub-types of health facilities are listed below. For more information on the supported attributes and relationships of a specific sub-type, refer to this sub-type's section.

important

The usage of types and sub-types can be confusing at first, because they both use a type field at their respective level.

{
"data": {
"type" : "health-facilities", // Type of the resource.
"attributes": {
"type": "clinic", // Sub-type
...
}
...
}
}

Health Facility

Supported 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"
}

name

string

Name of the resource.

{
"name": "PermaDerm Foot Clinic"
}

type

string read-only

Sub-type of health facility. Not to be mixed with the actual type of a resource.

{
"type": "clinic"
}
note

This parameter is marked as read-only because it cannot be changed on an existing resource. Nonetheless, it must be specified upon creation so the API knows what sub-type of resource to create.

tags

Array<string>

Tags that better describes the resource.

{
"tags": ["CHSLD"]
}
important

The current version of the api (V1) currently supports a maximum of 1 email per resource.

Only the Rehabilitation center and the Long term care subtypes support this field.

For rehabilitation centers, possible values are :

  • CRDP
  • CRDITED

For long term care, possible values are :

  • CHSLD
  • RI
  • Residence
  • Palliative care residence

address

Address

Physical address of the resource.

{
"address": {
"street-number": "2248",
"route": "rue Asselin",
"postal-code": "J4M2M8",
"place": "Longueuil",
"region": "Quebec",
"region-code": "QC",
"country": "Canada",
"country-code": "CA"
}
}

location

GeoPoint

Geographic coordinates of the resource's address.

{
"location": {
"lat": 45.5465,
"lng": -73.4456
}
}

phones

Array<Phone>

List of phones associated with this resource.

{
"phones": [
{
"id": "phone-a6f658f8-89bf-45ef-a88e-8024da7537d1",
"number": "4509992929",
"type": "MAIN"
}
]
}

faxes

Array<Phone>

List of faxes associated with this resource.

{
"faxes": [
{
"id": "fax-a6f658f8-89bf-45ef-a88e-8024da7537d1",
"number": "4509992929",
"type": "FAX"
}
]
}

emails

Array<Email>

List of emails associated with this resource.

{
"emails": [
{
"id": "email-a6f658f8-89bf-45ef-a88e-8024da7537d1",
"address": "support@clinia.com"
}
]
}
important

The current version of the api (V1) currently supports a maximum of 1 email per resource.

online-bookings

Array<OnlineBooking>

List of online booking methods associated with this resource.

{
"online-bookings": [
{
"id": "online-booking-a6f658f8-89bf-45ef-a88e-8024da7537d1",
"url": "https://clinia.com/booking"
}
]
}
important

The current version of the api (V1) currently supports a maximum of 1 online-booking per resource.

opening-hours

Array<OpeningHour>

Opening hours.

{
"opening-hours": [
{
"day": 1,
"intervals": [
{
"start": "08:00:00",
"end": "17:00:00"
}
]
},
{
"day": 2,
"intervals": [
{
"start": "08:00:00",
"end": "17:00:00"
}
]
},
{
"day": 3,
"intervals": [
{
"start": "08:00:00",
"end": "17:00:00"
}
]
}
]
}

socials

Array<Social>

List of social media or website associated with this resource.

{
"socials": [
{
"id": "social-a6f658f8-89bf-45ef-a88e-8024da7537d1",
"url": "https://clinia.com"
}
]
}
important

The current version of the api (V1) currently supports a maximum of 1 social per resource.

supported-languages

Array<string>

List of ISO-639-1 language codes.

{
"supported-languages": ["ENGLISH", "FRENCH"]
}
note

Possible values for this attributes are :

  • FRENCH
  • ENGLISH
  • SPANISH
  • ITALIAN
  • CANTONESE
  • MANDARIN
  • ARAB
  • PENDJABI
  • HINDI
  • CREOLE
  • BENGALI
  • URDU
  • TAMIL
  • TAGALOG
  • PORTUGUESE
  • VIETNAMESE

note

string

Notes concerning this resource. This field contains additional information that does not fit in any other field.

{
"note": "There is construction work being done in the building. Patients need to access the clinic from a secondary door."
}

Supported relationships

walk-in

WalkIn

Walk-in information associated with this resource.

{
"walk-in": {
"id": "a6f658f8-89bf-45ef-a88e-8024da7537d1",
"type": "walk-ins"
}
}

sectors

Array<Sector>

List of sectors associated with this resource.

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

practices

Array<Practice>

List of practices associated with this resource.

{
"practice": {
"id": "a6f658f8-89bf-45ef-a88e-8024da7537d1",
"type": "walk-ins"
}
}

services

Array<Service>

List of services associated with this resource.

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

Clinic

type: health-facilities sub-type: clinic

All resources offering health services in a physical place or at home.

Attributes

Relationships

CLSC

type: health-facilities sub-type: clsc

In Quebec, a CLSC is a public organization offering frontline health services.

Attributes

Relationships

Pharmacy

type: health-facilities sub-type: pharmacy

A pharmacy is a location where drugs are distributed and sold.

Attributes

Relationships

Hospital

type: health-facilities sub-type: hospital

A hospital is an institution where the sick or injured are given medical or surgical care.

Attributes

Relationships

Community Resource

type: health-facilities sub-type: community

A communicaty resource is a helpline, an addiction center, a shelter, etc.

Attributes

Relationships

Rehabilitation Center

type: health-facilities sub-type: rehabilitation-center

A rehabilitation center is a medical establishment that provides programs for rehabilitating mentally or physically disabled individuals.

Attributes

Relationships

Long Term Care

type: health-facilities sub-type: long-term-care

A long term care facility provides rehabilitative, restaurative, and/or ongoing skilled nursing care to patients or residents in need of assistance with activities of daily living.

Attributes

Relationships