{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d4ad7065-afe6-44d0-ac5e-8b694aad39b1","name":"Webdoc API Documentation","description":"This is the official Carasent Sweden REST API documentation describing the different endpoints that can be used by external systems to interact with the EMR - Webdoc SE.\n\n

Changelog

\n\n
VersionRelease dateNotes
6.93
2026-03-04
Updated POST Documents with added ability to send creation time in the request.
6.91
2026-01-21
Updated GET Clinic Bookings and GET Bookings to only return a value to the parameter \"injuryNumber\" in bookings if their patient types are related to insurance companies.
6.90
2025-12-10
Added \"title\" to the \"user\" objects in GET Bookings responses.

Updated GET Clinic Bookings to always return payment info in the patient bookings.
6.83
2025-06-04
Added ability to add fee and patient type to bookings via PATCH Bookings.
6.82
2025-05-14
Updated GET Clinic Bookings to require personal number in the request.
6.81
2025-04-23
Added ability to update action codes in bookings via PATCH Bookings.
6.79
2025-03-12
Updated POST Documents to support file uploads also for foreign patients.
6.78
2025-02-19
Updated GET Bookings responses with included injury number. Also added ability to filter requested bookings by arrival status.

Added ability to enable SMS reminders via PATCH Bookings.
6.76
2024-12-04
Added ability to save injury number via PATCH Bookings.
6.75
2024-11-13
Added ability to save injury number via POST Bookings.
6.72
2024-08-21
6.69
2024-05-02
6.66
2024-02-28
Added smsConfirmation a boolean option to POST Bookings and PATCH Bookings.
6.65
2024-02-07
Added userId, recordTemplateId and isSigned filters to GET Visits.
6.64
2024-01-17
  • Added possibility to update booking times also for unbooked bookings (bookings without patient) via PATCH Bookings.

  • Improved and clarified error response for invalid userId in the request to POST Bookings.

6.62
2023-11-15
Added name to bookingType in GET Bookings.
6.57
2023-06-14
Added phoneNumber and email to patient in  GET Bookings.

Added possibility to update the note in a booking through PATCH Bookings.
6.56
2023-05-24

  • Added note to GET Bookings.

  • Added JSON Schemata to the following:

    • GET Clinic Bookings[v1]

    • GET Booking Types[v1]

    • POST Bookings[v1]

    • PATCH Booking[v1]

    • DEL Bookings[v1]

    • GET Bookings[v1]

    • GET Organizations[v1]

    • POST Organization[v1]

    • PUT Add Patient to Organization[v1]

    • GET National Registry[v1]

    • GET Patients[v2]

    • GET Patient Type by id

    • GET Patient Types

    • GET Users[v1]

    • GET User by id[v1]

    • GET User Permissions by id[v1]

    • GET Visits[v1]

6.55
2023-05-03
Added actionCodes and personalNumber, firstName and lastName for user and patient in GET Bookings.
6.53
2023-03-22
Added new endpoint to get information about document types: GET Document Types.
6.51
2023-02-08
Updated information for the endpoint: POST External Records.
6.48
2022-11-17
6.47
2022-10-05
6.43.8
2022-09-14

  • Updated information about http arrays.

6.43.7
2022-07-04
6.43
2022-06-08
6.42
2022-05-18
6.41
2022-04-27

  • Updated PATCH
    Booking     with added body parameter \"id\" for caregiver to enable to reschedule a booking from one
    caregiver to another.

6.39
2022-03-23
6.38
2022-03-02
6.34
2021-11-17
6.30
2021-08-25
6.29
2021-06-16

  • Created a new endpoint to be able to GET Action Codes.

  • Updated GET Clinic
    Bookings     to return action code IDs in requested bookings response.

  • Created a new endpoint, GET Bookings, to be able to fetch larger sets of bookings.

  • Updated PATCH Booking to enable update of time in a booking.

  • Managing overlapping bookings when
    updating a booking or creating a new one.

6.28
2021-05-26

  • Updated PATCH Booking to enable update of booking type in a booking.

6.26
2021-04-14

  • Updated PATCH Booking to enable to add/remove a patient to/from a booking.

  • Updated GET Clinic Bookings with new filters to support pagination.

  • Created sequence diagrams to clarify some contexts regarding interaction with different Webdoc endpoints (provided by request).

6.25
2021-03-24

  • Created a new endpoint to be able to POST Notes.

6.24
2021-03-03
6.23
2021-02-10
6.22
2021-01-20
\n\n

Scopes

\n\n
NameDescription
api
Intended to be used for different API functions (deprecated).
self-service
Intended to be used for endpoints where patients should be able to do their own check-ins.
system-admin
Intended for endpoints that will be used by Webdoc administrators.
actioncodes:read
Read permissions of action codes.
actioncodes:write
Write permissions of action codes.
bookings:read
Read permissions of booking data.
bookings:write
Write permissions of booking data.
clinics:read
Read permissions of clinic data.
clinics:write
Write permissions of clinic data.
organization:read
Read permissions of organization data.
organization:write
Write permissions of organization data.
patient:read
Read permissions of patient data.
patient:write
Write permissions of patient data.
patient-types:read
Read permissions of patient type data.
patient-types:write
Write permissions of patient type data.
record-signatures:write
Write permissions of visit record signatures, i.e. records of types journals, notes or vaccinations.
users:read
Read permissions of user data, i.e. caregiver and Webdoc admin data.
users:write
Write permissions of user data, i.e. caregiver and Webdoc admin data.
document-types:read
Read permissions for document types.
documents:write
Write permissions for posting documents.
\n\n

Sandbox

\n\nTypical **Webdoc API** responses can be tested and received through calls to the Webdoc API sandbox. \nThe sandbox is hosted on the following domain:\n\n```\nhttps://7b757a50-bb04-49cd-a738-35dd157aafca.mock.pstmn.io\n\n ```\n\nTo make a call to the sandbox:\n\n
  1. Change the ENVIRONMENT (top-left of this page) to No environment.
  2. Locate the request URL you want to call.
  3. Locate {{auth}} or {{url}} found at the beginning of the request and replace it with the sandbox domain mentioned above.
\n\n

Example

\n\nTo test **GET Record Templates** change\n\n```\n{{url}}/v1/recordTemplates\n\n ```\n\ninto\n\n```\nhttps://7b757a50-bb04-49cd-a738-35dd157aafca.mock.pstmn.io/v1/recordTemplates\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"25789139","collectionId":"d4ad7065-afe6-44d0-ac5e-8b694aad39b1","publishedId":"2sA3JT2yJK","public":true,"publicUrl":"https://docs.webdoc.com","privateUrl":"https://go.postman.co/documentation/25789139-d4ad7065-afe6-44d0-ac5e-8b694aad39b1","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/b1211c7f-ed32-42d5-a045-bd2f4dd07642/V2ViZG9jX0xvZ29fRklOQUxfbWFpbl9zY3JlZW4ucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/969ed357-9a21-4adf-841a-e444570dfdfb/V2ViZG9jX0xvZ29fRklOQUxfbWFpbl9zY3JlZW4ucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-05-18T07:55:06.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/969ed357-9a21-4adf-841a-e444570dfdfb/V2ViZG9jX0xvZ29fRklOQUxfbWFpbl9zY3JlZW4ucG5n","logoDark":"https://content.pstmn.io/b1211c7f-ed32-42d5-a045-bd2f4dd07642/V2ViZG9jX0xvZ29fRklOQUxfbWFpbl9zY3JlZW4ucG5n"}},"statusCode":200},"environments":[{"name":"Documentation","id":"509dc94f-8fb3-458c-8275-6725b96911c5","owner":"25789139","values":[{"key":"url","value":"https://api.atlan.se","enabled":true},{"key":"auth","value":"https://auth.atlan.se","enabled":true},{"key":"bookingID","value":"","enabled":true},{"key":"access_token","value":"","enabled":true,"type":"any"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/986f9c2031ee43bc6bd3560ee0064009c806d914044867aca58ec88f3c92cb84","favicon":"https://webdoc.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Documentation","value":"25789139-509dc94f-8fb3-458c-8275-6725b96911c5"}],"canonicalUrl":"https://docs.webdoc.com/view/metadata/2sA3JT2yJK"}