{"info":{"_postman_id":"a2a11d43-5196-98a9-4522-41a565c7ced8","name":"Collegium Telemedicus API Reference","description":"

CollegiumTelemedicus API docs for use by 3rd parties.

What is Collegium Telemedicus?

Visit https://collegiumtelemedicus.org for details.

About our API

API access is limited to specific partners, please contact us for details.
The API provides a subset of functionality for specific uses only.

Usage notes

The API follows approximate REST principles, using only get for requests that do not create or update and post for requests that do.
All requests return JSON
HTTP Status codes should be used in conjunction with the result property of the returned JSON to verify success of the request.

Rate limits

There are (currently) no limits on use of the API, however for performance reasons we request that you limit rate of requests to no more than 10 per minute.

Base URL

https://api.collegiumtelemedicus.org/v3/public/

Response Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP Status	Notes
401	Invalid authentication
500	Invalid parameters (e.g. limit exceeds max, missing field etc)
200/201	Success

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"What is Collegium Telemedicus?","slug":"what-is-collegium-telemedicus"},{"content":"About our API","slug":"about-our-api"}],"owner":"1651345","collectionId":"a2a11d43-5196-98a9-4522-41a565c7ced8","publishedId":"6thxfjV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-05-22T21:59:12.000Z"},"item":[{"name":"Authentication","item":[{"name":"Login","event":[{"listen":"test","script":{"id":"0561f0cf-2954-473a-8c10-0db35ff29164","exec":["tests[\"Status code is 200\"] = responseCode.code === 401;","","","","var jsonData = JSON.parse(responseBody);","tests[\"Result is error\"] = jsonData.result === \"error\";","//tests[\"Enviroment is live\"] = jsonData.version.api_environment === \"Live\";"],"type":"text/javascript"}}],"id":"41b0c7f3-c367-aa56-1711-2a1aceeb895a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"username","type":"text"},{"key":"password","value":"password","type":"text"}]},"url":"{{baseurl}}/login","description":"

API users

Currently the API supports referrers and coordinators only
Use the same authentication details as on the web application
Users must be part of a Network that has been approved for API access

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP Status	Notes
401	Invalid authentication details, or API access not allowed for this user
201	Login success

Example JSON response

{\n    \"result\": \"success\",\n    \"token\": \"...\",\n    \"token_expire_time\": \"2017-09-23T13:09:40+01:00\",\n    \"name\": \"...\",\n    \"user_id\": 1,\n    \"email\": \"...\",\n    \"user_lang\": \"en\",\n    \"user_gmt_offset\": -5,\n    \"network_id\": 1,\n    \"network_name\": \"...\",\n    \"network_lang\": \"en\",\n    \"ref_templates\": [ ... ],\n    \"hospital_id\": 1,\n    \"hospital_name\": \"...\",\n    \"city\": \"...\",\n    \"country\": \"...\",\n    \"organization\": \"...\",\n    \"expert_groups\": [...],\n    \"version\": {\n        \"api_version\": \"...\",\n        \"mobile_app_version\": \"...\",\n        \"api_environment\": \"...\"\n    }\n}\n

token : must be passed as X-CT-Authorization HTTP Header in all other requests
token_expire_time : a new token must be requested after this time
name, email etc : details of the current user
version : the API version

\n","urlObject":{"path":["login"],"host":["{{baseurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"41b0c7f3-c367-aa56-1711-2a1aceeb895a"}],"id":"57e97827-1358-525f-6cb2-b5a98a2b6db7","description":"

To access any API end points you must first login and obtain an authentication token. This token is then used in all subsequent API calls.

\n","_postman_id":"57e97827-1358-525f-6cb2-b5a98a2b6db7"},{"name":"Cases","item":[{"name":"/cases","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","var jsonData = JSON.parse(responseBody);","tests[\"Results contain 10 cases\"] = jsonData.length === 10;"]}}],"id":"2342c014-42b8-c9dc-acfe-b2d2858209c8","request":{"method":"GET","header":[{"key":"X-CT-Authorization","value":"Bearer {{authtoken}}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"referrer","type":"text"},{"key":"password","value":"123","type":"text"}]},"url":"{{baseurl}}/cases?page=1&limit=10","description":"

GET Cases for the current user.

Notes

page and limit are optional (defaults to first 10 cases)
limit cannot exceed 500
Returned cases are ordered by date/time case was opened (most recent first)

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP Status	Notes
401	Invalid authentication
500	Invalid parameters (e.g. limit exceeds max)
200	Success

Example JSON response

[\n    {\n        \"record_no\": 1,\n        \"case_no\": 1,\n        \"network_id\": 1,\n        \"case_status\": \"a\",\n        \"clinical\": \"P\",\n        \"clinical_full\": \"...\",\n        \"received\": \"2016-09-29T07:29:14.000Z\",\n        \"type_ref\": \"General\",\n        \"primary_reason\": \"...\",\n        \"city\": \"...\",\n        \"country\": \"...\",\n        \"patient_name\": \"...\",\n        \"sex\": \"...\",\n        \"age\": \"...\",\n        \"referrer_id\": \"...\",\n        \"from_fullname\": \"...\",\n        \"n_query\": 0,\n        \"n_message\": 1,\n        \"case_lang\": \"EN\",\n        \"case_changed_on\": \"1901-01-01T00:00:00.000Z\",\n        \"fu_date\": null,\n        \"reply_date\": \"\",\n        \"hospital\": {\n            \"id\": 3,\n            \"name\": \"Royal Masonic Homeopathy Hospital\",\n            \"city\": \"London\",\n            \"country\": \"United Kingdom\",\n            \"organization\": \"Homeopathy UK\"\n        },\n        \"last_viewed\": \"2000-01-01T00:00:00.000Z\"\n    },\n    ...\n ]\n

","urlObject":{"path":["cases"],"host":["{{baseurl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"2342c014-42b8-c9dc-acfe-b2d2858209c8"}],"id":"6acbffe7-ed99-af3f-1f26-0bc21925399b","description":"

Referrers only

\n","_postman_id":"6acbffe7-ed99-af3f-1f26-0bc21925399b"},{"name":"Users","item":[{"name":"/users/invite","event":[{"listen":"test","script":{"id":"284f905c-1120-4220-ae58-e984ef2fc607","exec":[""],"type":"text/javascript"}}],"id":"8ecb3d67-478e-4fbb-a431-4b5c591080d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-CT-Authorization","value":"Bearer {{authtoken}}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"data","value":"{ \n \"type\": \"Specialist\",\n \"email\": \"apispecialist@api.com\", \n \"gmt_offset\": \"-2\", \n \"title\": \"Dr\", \n \"first_name\": \"Name\", \n \"family_name\": \"Surname\", \n \"organisation\": \"organisation\", \n \"city\": \"city\", \n \"country\": \"ALA\", \n \"contact_details\": \"contact\", \n \"tel\": \"tel\", \n \"postal_address\": \"address\", \n \"pro_num\": \"xxxx\", \n \"pro_body\": \"yyyyy\", \n \"employer\": \"Employer\", \n \"notes\": \"\", \n \"cat_1\": \"Allied Health\", \n \"cat_2\": \"Physiotherapy\", \n \"cat_3\": \"\", \n \"sex\": \"Female\", \n \"user_langs\": \"en,fr\"\n}","type":"text"}]},"url":"{{baseurl}}/users/invite","description":"

Coordinators only

Create new Specialist or Referrer users and send invite email with instructions to set up password.

Notes

Allows creation of new users (Specialist or Referrers) exactly as if the Coordinator had completed the form in the web platform.
The user will receive an invite email with their link to set up their password etc & immediately be able to use the platform.
Referrers will need to set up password using a web browser, before downloading and accessing the mobile app

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n

Post	Notes
data	Required JSON object with details of new user

User data definition

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Required	Example value	Notes
type	Yes	\"Specialist\"	Must be either \"Specialist\" or \"Referrer\"
email	Yes	\"apispecialist@api.com\"	Must be valid email
gmt_offset	Yes	\"-2\"	User's timezone, hours offset from GMT
user_langs	Yes	\"en,fr\"	CSV of language(s) the user can speak. Must use two letter codes as follows: English='en', French='fr', Spanish='sp',Arabic='ar', Portuguese='pt
cat_1	Yes (Specialist only)	\"Allied Health\"	Must exactly match list of primary Specialisms
cat_2	No (Specialist only)	\"Physiotherapy\"	Must exactly match list of secondary Specialisms
cat_3	No (Specialist only)	\"\"	Must exactly match list of tertiary Specialisms
hospital_id	Yes (Referrer only)	\"330\"	Collegium's ID of the user's hospital
alloc_type	Yes (Referrer only)	\"Automatic\"	Allocation type. Must be one of \"Automatic\", \"Semi-Automatic\" or \"Manual\"
alloc_groups	Yes, if alloc_type not \"Manual\" (Referrer only)	\"4,6\"	CSV of Expert group IDs. Required for Referrer's only and if allocation type is \"Automatic\" or \"Semi-Automatic\"
title	No	\"Dr\"	User's title
first_name	Yes	\"Name\"
family_name	Yes	\"Surname\"
country	Yes	\"ALA\"	Country where user located. Must be ISO 3166-1 alpha-3
organisation	No	\"organisation\"	User's Organisation
city	No	\"city\"	Town or city where user located
sex	No	\"Female\"	Must be either \"Male\" or \"Female\"
contact_details	No	\"contact\"	Other contact details
tel	No	\"tel\"	Users telephone number
postal_address	No	\"address\"	Users title
pro_num	No	\"xxxx\"	User's registration number with professional body. Note: this information is only available to the network Coordinators -- it is not visible to other users
pro_body	No	\"yyyyy\"	User's professional regulatory body
employer	No	\"Employer\"	Users employer
notes	No	\"\"	Notes for coordinator

Example JSON for new Specialist

{ \n    \"type\": \"Specialist\",\n    \"email\": \"apispecialist@api.com\", \n    \"gmt_offset\": \"+5.5\", \n    \"first_name\": \"Name\", \n    \"family_name\": \"Surname\", \n    \"country\": \"IND\", \n    \"cat_1\": \"Internal Medicine\", \n    \"user_langs\": \"en,fr\"\n}\n

Example JSON for new Referrer

{ \n    \"type\": \"Referrer\",\n    \"email\": \"apiref@api.com\", \n    \"gmt_offset\": \"-2\", \n    \"first_name\": \"Api\", \n    \"family_name\": \"Tester1\", \n    \"country\": \"ALA\", \n    \"hospital_id\": \"330\",\n    \"user_langs\": \"en,fr\",\n    \"alloc_type\": \"Automatic\",\n    \"alloc_groups\": \"4,6\"\n}\n

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP Status	Notes
401	Invalid authentication
500	Invalid data (eg invalid json, or missing required values)
201	Success

Example JSON response

{\n    \"result\": \"success\",\n    \"user_id\": 102009\n}\n

","urlObject":{"path":["users","invite"],"host":["{{baseurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8ecb3d67-478e-4fbb-a431-4b5c591080d7"}],"id":"d0ee33b6-53b3-4047-81a8-f764327dd542","_postman_id":"d0ee33b6-53b3-4047-81a8-f764327dd542","description":""}],"event":[{"listen":"prerequest","script":{"id":"22337271-11df-43e2-bc63-eaec7ba243c1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"12dd6c37-5fd8-4653-ae43-fe25fd24510b","type":"text/javascript","exec":["","var jsonData = JSON.parse(\"not json }\");",""]}}]}