{"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

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\n

Typical Webdoc API responses can be tested and received through calls to the Webdoc API sandbox.
The sandbox is hosted on the following domain:

\n
https://7b757a50-bb04-49cd-a738-35dd157aafca.mock.pstmn.io\n\n

To make a call to the sandbox:

\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\n

To test GET Record Templates change

\n
{{url}}/v1/recordTemplates\n\n

into

\n
https://7b757a50-bb04-49cd-a738-35dd157aafca.mock.pstmn.io/v1/recordTemplates\n\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Changelog","slug":"changelog"},{"content":"Scopes","slug":"scopes"},{"content":"Sandbox","slug":"sandbox"}],"owner":"25789139","collectionId":"d4ad7065-afe6-44d0-ac5e-8b694aad39b1","publishedId":"2sA3JT2yJK","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-05-18T07:55:06.000Z"},"item":[{"name":"Auth","item":[{"name":"Client Credentials","id":"a921c367-1323-488e-a4a3-bf12ec161c1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"","username":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"scope","value":"self-service patient:write","type":"text","description":"

A space separated list can be used for multiple scopes.

\n"}]},"url":"{{auth}}/oauth/token","description":"

The grant type \"client_credentials\" can be used to request an access token based on a \"client_id\", \"client secret\", and defined \"scopes\". Moreover, by using this grant type, you do not need to specify a \"code\" or \"redirect_uri\" in access token requests (which is required for the grant_type \"authorization_code\" used in SSO flows).

\n

Note! The grant type \"client_credentials\" will only work for web server requests. In case when API calls are made from mobile applications or for the WD SSO flows, the grant type \"authorization_code\" is required.

\n

You can read more about how the authorization flows work in Webdoc with example requests on the following tutorial pages:

\n","urlObject":{"path":["oauth","token"],"host":["{{auth}}"],"query":[],"variable":[]}},"response":[{"id":"0d331ee4-6888-4456-bb26-5b07c7357590","name":"Client Credentials","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"scope","value":"self-service","type":"text"}]},"url":"{{auth}}/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 13 Oct 2020 11:39:00 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.6"},{"key":"Cache-Control","value":"no-store, private"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"122"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"024012bd60a926b9a80abe4700599ab8d9ad777f\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\",\n \"scope\": \"self-service\"\n}"},{"id":"410418e4-9860-4dbd-814d-6e0412789f09","name":"JSON Schema","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"JSON_Schema","value":"true"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Client credentials\",\n \"required\": [\n \"grant_type\",\n \"scope\"\n ],\n \"properties\": {\n \"grant_type\": {\n \"title\": \"Grant type\",\n \"default\": \"\",\n \"pattern\": \"^client_credentials|authorization_code$\",\n \"examples\": [\n \"client_credentials\", \"authorization_code\"\n ],\n \"$id\": \"#/properties/grant_type\",\n \"type\": \"string\"\n },\n \"scope\": {\n \"title\": \"Scope\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"api self-service patient:write patient:read system-admin bookings:read bookings:write users:read users:write patient-types:read patient-types:write actioncodes:read actioncodes:write\"\n ],\n \"$id\": \"#/properties/scope\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"http://webdoc.api/request/auth/post/client_credentials\",\n \"type\": \"object\",\n \"definitions\": {},\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}","options":{"raw":{"language":"json"}}},"url":"{{auth}}/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 13 Oct 2020 11:39:00 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.6"},{"key":"Cache-Control","value":"no-store, private"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"122"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Client credentials\",\n \"required\": [\n \"access_token\",\n \"expires_in\",\n \"token_type\",\n \"scope\"\n ],\n \"properties\": {\n \"access_token\": {\n \"title\": \"Access token\",\n \"default\": \"\",\n \"pattern\": \"^[0-9a-fA-F]+$\",\n \"examples\": [\n \"024012bd60a926b9a80abe4700599ab8d9ad777f\"\n ],\n \"$id\": \"#/properties/access_token\",\n \"type\": \"string\"\n },\n \"expires_in\": {\n \"title\": \"Expires in\",\n \"default\": 0,\n \"examples\": [\n 3600\n ],\n \"$id\": \"#/properties/expires_in\",\n \"type\": \"integer\"\n },\n \"token_type\": {\n \"title\": \"Token type\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Bearer\"\n ],\n \"$id\": \"#/properties/token_type\",\n \"type\": \"string\"\n },\n \"scope\": {\n \"title\": \"Scope\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"self-service\", \"api\", \"patient:write\", \"patient:read\", \"system-admin\",\n \"bookings:read\", \"bookings:write\", \"users:read\", \"users:write\",\n \"patient-types:read\", \"patient-types:write\", \"actioncodes:read\", \"actioncodes:write\"\n ],\n \"$id\": \"#/properties/scope\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"http://webdoc.api/response/auth/post/client_credentials\",\n \"type\": \"object\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}"}],"_postman_id":"a921c367-1323-488e-a4a3-bf12ec161c1e"}],"id":"271c90ad-dcbe-4279-bcdf-f3a223b338d0","description":"

\n\n

(You can read more detailed tutorials about the authorization and authentication flows in the context of Webdoc from the Integrator Portal \"FAQ\" page.)

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"a5d7b503-7066-45b9-b14d-3406a07dbc52","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4901402e-6a4d-49d8-b02a-de5f6626d231","type":"text/javascript","exec":[""]}}],"_postman_id":"271c90ad-dcbe-4279-bcdf-f3a223b338d0"},{"name":"Action Codes","item":[{"name":"v1","item":[{"name":"Action Codes","id":"e7ef3763-18c4-4cde-b495-215c7c6a5f25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/v1/actionCodes","description":"

Get available action codes that can be assigned to bookings. Action codes specify whether a booking for a patient concerns e.g. a vaccination, a surgery or such like. Moreover, the action codes determine the prices of patient visits.

\n

Allowed with one of the following scopes:

\n","urlObject":{"path":["v1","actionCodes"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f3f5b643-8dd8-4300-84fe-856f7597430d","name":"Action Codes - All codes","originalRequest":{"method":"GET","header":[{"key":"","value":"","disabled":true}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/v1/actionCodes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"articleNo\": null,\n \"codeName\": \"Surgery\",\n \"codeDescription\": \"\",\n \"account\": 3010,\n \"fee\": \"1000\",\n \"compensation\": \"500\",\n \"active\": 1\n },\n {\n \"id\": 2,\n \"articleNo\": null,\n \"codeName\": \"Knee joint surgery\",\n \"codeDescription\": \"Right knee.\",\n \"account\": 3010,\n \"fee\": \"5000\",\n \"compensation\": \"4500\",\n \"active\": 1\n },\n {\n \"id\": 3,\n \"articleNo\": null,\n \"codeName\": \"Vaccination\",\n \"codeDescription\": \"\",\n \"account\": 3010,\n \"fee\": \"150\",\n \"compensation\": \"100\",\n \"active\": 1\n },\n {\n \"id\": 4,\n \"articleNo\": null,\n \"codeName\": \"Revisit\",\n \"codeDescription\": \"\",\n \"account\": 3010,\n \"fee\": \"100\",\n \"compensation\": \"100\",\n \"active\": 1\n }\n]"}],"_postman_id":"e7ef3763-18c4-4cde-b495-215c7c6a5f25"}],"id":"e3c045e0-bcf9-4357-ba6d-d7b1371397e6","_postman_id":"e3c045e0-bcf9-4357-ba6d-d7b1371397e6","description":""}],"id":"a6dca613-5c2c-4fd3-a804-eb48b59386b6","_postman_id":"a6dca613-5c2c-4fd3-a804-eb48b59386b6","description":""},{"name":"Bookings","item":[{"name":"v1","item":[{"name":"Clinic Bookings","event":[{"listen":"test","script":{"id":"28ffc757-b1d8-4ce1-b19c-b7d876f10384","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Response time is less than 10000ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(10000);\r","});\r","\r","pm.test(\"Content type json\", function () {\r"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.eql(\"application/json\")\r","});\r","\r","var jsonData = pm.response.json();\r","\r","pm.test(\"Patient is 19680502-9268\", function () {\r"," pm.expect(jsonData[0].patient.personalNumber).to.eql(\"19680502-9268\");\r","}); \r"," \r","\r","pm.test(\"Caregiver id is correct\", function () {\r"," pm.expect(jsonData[0].caregiver.id).to.eql(\"aac7897a-b677-47e2-9ccc-6de13195d2c1\");\r","}); \r","\r","pm.test(\"Caregiver name is Christoffer\", function () {\r"," pm.expect(jsonData[0].caregiver.firstName).to.eql(\"CHRISTOFFER ROBERT\");\r","});\r","\r","\r","pm.test(\"Price on booking is 1500\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData[0].payments[0].price).to.eql(\"1500\");\r","});\r","\r","\r","pm.test(\"Date in response matches date in request\", function () {\r"," pm.expect(jsonData[0].date).to.eql(pm.variables.get(\"date\"));\r","\r","});\r","\r","// Fetches and store the the Booking id in a variable to be used in later tests\r","var booking;\r","var jsonData = JSON.parse(responseBody);\r","pm.environment.set(\"booking\", jsonData[0].id);\r","var jsonData = JSON.parse(responseBody);\r","console.log(jsonData)\r","\r","\r","pm.test(\"Booking ID Equals:\", function () {\r"," pm.expect(jsonData[0].id).to.eql(\"4b17e3d7-69de-4954-9dbc-d312ad304126\");\r","});\r","\r","pm.test(\"Date Equals: 2020-04-10\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData[0].date).to.eql(\"2020-04-10\");\r","});\r","\r","pm.test(\"Arrived is 1 :\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData[0].arrived).to.eql(1);\r","});\r","\r","pm.test(\"Booked Patienttype Equals: SEB\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData[0].bookedPatientType).to.eql(\"SEB\");\r","});\r","\r","\r","pm.test(\"Payment Price Equals: \" + jsonData[0].payments[0].price , function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData[0].payments[0].price).to.eql(\"1500\");\r","});\r",""],"type":"text/javascript"}}],"id":"005eb40c-3c7e-47ad-a5d4-a7a24254a428","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"challengeAlgorithm":"","grant_type":"","client_authentication":"","accessToken":""},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/v1/clinics/:clinicId/bookings?personalNumber=19121212-1212&date=2021-01-01&fromDate=2021-01-01&toDate=2021-02-01&arrived=0&selfService=true&bookingTypeId=12&booked=false&userId=136186d5-073a-47af-924a-5d6f3624de07&limit=10&offset=5&reservedForOrganizationId=50&reservedForDepartmentId=65","description":"

NOTE! This endpoint shall ONLY be used to get patient bookings associated with a clinic during self-service flows via arrival terminals. If you want to get bookings in other contexts, please use GET Bookings instead. (You can read a more detailed tutorial about the self-service flow on the Integrator Portal: https://integratorportal.carasent.net/faq/wd-arrival-registration-docs)

\n

Allowed with one of the following scopes:

\n
    \n

  • self-service

    \n
    • \n

  • bookings:read

    \n
    • \n

  • bookings:write

    \n
    • \n
\n","urlObject":{"path":["v1","clinics",":clinicId","bookings"],"host":["{{url}}"],"query":[{"description":{"content":"

Required - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX.\nForeign personal numbers are also supported. The format needs to be YYYYMMDD-ZXXX, YYYYMMDD+ZXXX, YYYYMMDDZXXX or even in the reduced format of YYMMDD-ZXXX, YYMMDD+ZXXX and YYMMDDZXXX where Z is either M, K or X.

\n","type":"text/plain"},"key":"personalNumber","value":"19121212-1212"},{"description":{"content":"

Optional - Bookings date in the format of YYYY-MM-DD. Timezone: 'CET'.

\n","type":"text/plain"},"key":"date","value":"2021-01-01"},{"description":{"content":"

Optional - Lower limit date in the format of YYYY-MM-DD. Timezone: 'CET'.

\n","type":"text/plain"},"key":"fromDate","value":"2021-01-01"},{"description":{"content":"

Optional - Upper limit date in the format of YYYY-MM-DD. Timezone: 'CET'.

\n","type":"text/plain"},"key":"toDate","value":"2021-02-01"},{"description":{"content":"

Optional - Filter bookings by arrived status.\n

Search values:

\n
    \n
  • 0 - Not arrived
    • \n
  • 1 - Arrived, but not paid
    • \n
  • 2 - Arrived and paid
    • \n
\n","type":"text/plain"},"key":"arrived","value":"0"},{"description":{"content":"

Optional - Filter bookings by booking type with self service flag.\n
Default: true

\n","type":"text/plain"},"key":"selfService","value":"true"},{"description":{"content":"

Optional - Filter bookings with the given booking type id.

\n","type":"text/plain"},"key":"bookingTypeId","value":"12"},{"description":{"content":"

Optional - Booking state selector.\n

This is a ternary filter:

\n
    \n
  • true - Select booked time slots.
    • \n
  • false - Select available time slots.
    • \n
  • <empty> - Leave empty to select all time slots - both booked and available.
    • \n
\n","type":"text/plain"},"key":"booked","value":"false"},{"description":{"content":"

Optional - Filter bookings by a caregiver based on a userId (UUID).

\n","type":"text/plain"},"key":"userId","value":"136186d5-073a-47af-924a-5d6f3624de07"},{"description":{"content":"

Optional - Limit the number of bookings that's being returned

\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"

Optional - Offset the bookings that's being returned

\n","type":"text/plain"},"key":"offset","value":"5"},{"description":{"content":"

Optional - Get bookings that are reserved to an organization

\n","type":"text/plain"},"key":"reservedForOrganizationId","value":"50"},{"description":{"content":"

Optional - Get bookings that are reserved to a department

\n","type":"text/plain"},"key":"reservedForDepartmentId","value":"65"}],"variable":[{"description":{"content":"

Required - Clinic identifier (UUID).

\n","type":"text/plain"},"type":"any","value":"873ab456-097c-12fd-aaab-98365cb34009","key":"clinicId"}]}},"response":[{"id":"f56a1afe-c5db-46ab-b6a9-1db4ff32f1f0","name":"Clinic Bookings","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/clinics/:clinicId/bookings?personalNumber=19121212-1212&date=2020-03-24&arrived=2","host":["{{url}}"],"path":["v1","clinics",":clinicId","bookings"],"query":[{"key":"personalNumber","value":"19121212-1212","description":"Required - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX."},{"key":"date","value":"2020-03-24","description":"Filter bookings by date."},{"key":"fromDate","value":"","description":"Filter bookings by from date.","disabled":true},{"key":"toDate","value":null,"description":"Filter bookings by to date.","disabled":true},{"key":"arrived","value":"2","description":"Filter bookings by arrived status. **Search values:**\n * 0 - Not arrived\n * 1 - Arrived, but not paid\n * 2 - Arrived and paid"}],"variable":[{"key":"clinicId","value":"def60545-12fd-86cb-12dc-9834cb00961a"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 14 Oct 2020 08:08:47 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.6"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"985"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"adefd797-fdc2-444a-a04a-b3e80bffc7ad\",\n \"clinicId\": \"def60545-12fd-86cb-12dc-9834cb00961a\",\n \"date\": \"2020-03-24\",\n \"startTime\": \"10:30\",\n \"endTime\": \"10:50\",\n \"arrived\": 2,\n \"actionCodes\": [\n {\n \"id\": 2\n },\n {\n \"id\": 5\n }\n ],\n \"bookingDescription\": \"Test description\",\n \"bookingType\": \"Booking\",\n \"bookedPatientType\": \"Health Care Contract\",\n \"injuryNumber\": \"\",\n \"payments\": [\n {\n \"price\": 200,\n \"amount\": 1,\n \"comment\": \"Test comment\",\n \"account\": \"3010\",\n \"VATPercentage\": 25,\n \"VAT\": 50,\n \"expiryDate\": \"2020-05-24\",\n \"freeByFreeCard\": false,\n \"reducedByFreeCard\": false,\n \"articleName\": \"Action code name\"\n }\n ],\n \"patient\": {\n \"isListed\": true,\n \"personalNumber\": \"19121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Insurance company\",\n \"address\": {\n \"streetName\": \"Test street 55A\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\"\n },\n \"mobilePhone\": \"+46701740635\",\n \"listing\": {\n \"hsaId\": \"SE1234567891-E000000001234\",\n \"countyName\": \"Test County\"\n },\n \"freeCard\": {\n \"cardNumber\": \"q1234567\",\n \"validFrom\": \"2020-01-12\",\n \"validUntil\": null,\n \"amountToLimit\": 900\n }\n },\n \"caregiver\": {\n \"id\": \"574d3bfe-1128-4721-b259-2086c60bc405\",\n \"title\": \"Dr\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19121212-1212\"\n }\n }\n]"},{"id":"dbf348b9-5178-4156-8be6-5cd37ea5002a","name":"Clinic Bookings - Only bookings","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/clinics/:clinicId/bookings?personalNumber=121212-1212&fromDate=2020-08-01&booked=true","host":["{{url}}"],"path":["v1","clinics",":clinicId","bookings"],"query":[{"key":"personalNumber","value":"121212-1212","description":"Required - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX."},{"key":"date","value":"2020-03-24","description":"Filter bookings by date.","disabled":true},{"key":"fromDate","value":"2020-08-01","description":"Filter bookings by from date."},{"key":"toDate","value":"2019-03-24","description":"Filter bookings by to date.","disabled":true},{"key":"arrived","value":"0","description":"Filter bookings by arrived status. **Search values:**\n* 0 - Not arrived\n* 1 - Arrived, but not paid\n* 2 - Arrived and paid","disabled":true},{"key":"self-service","value":"true","description":"Filter bookings by booking type with self service flag. **Default:** true","disabled":true},{"key":"bookingTypeId","value":"1","description":"Filter bookings by booking type Id","disabled":true},{"key":"booked","value":"true","description":"A ternary filter for returned bookings:\ntrue: return only booked ones\nfalse: return only available time slots (empty bookings)\nempty: return both booked and empty ones"}],"variable":[{"key":"clinicId","value":"def60545-12fd-86cb-12dc-9834cb00961a"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 12 Jan 2021 10:08:36 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.6"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"3993"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"a5ba581d-d0d9-47a8-893f-e3e94c4efdb4\",\n \"clinicId\": \"def60545-12fd-86cb-12dc-9834cb00961a\",\n \"date\": \"2026-01-10\",\n \"startTime\": \"11:00\",\n \"endTime\": \"11:20\",\n \"arrived\": 2,\n \"actionCodes\": [\n {\n \"id\": 1\n }\n ],\n \"bookingDescription\": \"Test description\",\n \"bookingType\": \"Booking\",\n \"bookedPatientType\": \"Insurance company\",\n \"injuryNumber\": \"FN2026-12345\",\n \"payments\": [\n {\n \"price\": 200,\n \"amount\": 1,\n \"comment\": \"Test comment\",\n \"account\": \"3010\",\n \"VATPercentage\": 25,\n \"VAT\": 50,\n \"expiryDate\": \"2026-02-10\",\n \"freeByFreeCard\": false,\n \"reducedByFreeCard\": false,\n \"articleName\": \"Action code name\"\n }\n ],\n \"patient\": {\n \"isListed\": true,\n \"personalNumber\": \"20121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Insurance company\",\n \"address\": {\n \"streetName\": \"Test street 55A\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\"\n },\n \"mobilePhone\": \"+46701740635\",\n \"listing\": {\n \"hsaId\": \"SE1234567891-E000000001232\",\n \"countyName\": \"Test County\"\n }\n },\n \"caregiver\": {\n \"id\": \"6222731b-acdc-4fa2-8500-3022fd0eeea3\",\n \"title\": \"Dr\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19121212-1212\"\n }\n },\n {\n \"id\": \"b08895b5-7be7-456a-b865-855e75842df5\",\n \"clinicId\": \"def60545-12fd-86cb-12dc-9834cb00961a\",\n \"date\": \"2026-01-13\",\n \"startTime\": \"09:50\",\n \"endTime\": \"10:10\",\n \"arrived\": 1,\n \"actionCodes\": [\n {\n \"id\": 2\n }\n ],\n \"bookingDescription\": \"Test description\",\n \"bookingType\": \"Dropin\",\n \"bookedPatientType\": \"Insurance company\",\n \"injuryNumber\": \"FN2026-67891\",\n \"payments\": [\n {\n \"price\": 100,\n \"amount\": 1,\n \"comment\": \"Test comment\",\n \"account\": \"3010\",\n \"VATPercentage\": 25,\n \"VAT\": 25,\n \"expiryDate\": \"2026-02-13\",\n \"freeByFreeCard\": false,\n \"reducedByFreeCard\": false,\n \"articleName\": \"Action code name\"\n }\n ],\n \"patient\": {\n \"isListed\": true,\n \"personalNumber\": \"20121212-1212\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Health Care Contract\",\n \"address\": {\n \"streetName\": \"Test Street 123\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\",\n \"coAddress\": \"John Doe\"\n },\n \"mobilePhone\": \"+46701740605\",\n \"listing\": {\n \"hsaId\": \"SE1234567891-E000000001234\",\n \"countyName\": \"Test County\"\n },\n \"freeCard\": {\n \"cardNumber\": \"q1234567\",\n \"validFrom\": \"2020-07-04\",\n \"validUntil\": null,\n \"amountToLimit\": 1050\n }\n },\n \"caregiver\": {\n \"id\": \"574d3bfe-1128-4721-b259-2086c60bc405\",\n \"title\": \"Dr\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19121212-1212\"\n }\n },\n {\n \"id\": \"795b22ef-63de-4c5e-8021-5016f0851e9a\",\n \"clinicId\": \"def60545-12fd-86cb-12dc-9834cb00961a\",\n \"date\": \"2026-01-13\",\n \"startTime\": \"11:00\",\n \"endTime\": \"11:20\",\n \"arrived\": 1,\n \"actionCodes\": [\n {\n \"id\": 4\n }\n ],\n \"bookingDescription\": \"Test description\",\n \"bookingType\": \"Online\",\n \"bookedPatientType\": \"Health Care Contract\",\n \"injuryNumber\": \"\",\n \"payments\": [\n {\n \"price\": 0,\n \"amount\": 1,\n \"comment\": \"Test comment\",\n \"account\": \"3010\",\n \"VATPercentage\": 25,\n \"VAT\": 0,\n \"expiryDate\": \"2026-02-13\",\n \"freeByFreeCard\": true,\n \"reducedByFreeCard\": false,\n \"articleName\": \"Action code name\"\n }\n ],\n \"patient\": {\n \"isListed\": false,\n \"personalNumber\": \"20121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Health Care Contract\",\n \"address\": {\n \"streetName\": \"Test street 23\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\",\n \"coAddress\": \"Jane Doe\"\n },\n \"mobilePhone\": \"\",\n \"listing\": null,\n \"freeCard\": {\n \"cardNumber\": \"q1234567\",\n \"validFrom\": \"2020-04-04\",\n \"validUntil\": \"2021-04-04\",\n \"amountToLimit\": 0\n }\n },\n \"caregiver\": {\n \"id\": \"574d3bfe-1128-4721-b259-2086c60bc405\",\n \"title\": \"Dr\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19121212-1212\"\n }\n },\n {\n \"id\": \"adefd797-fdc2-444a-a04a-b3e80bffc7ad\",\n \"clinicId\": \"def60545-12fd-86cb-12dc-9834cb00961a\",\n \"date\": \"2026-01-11\",\n \"startTime\": \"10:30\",\n \"endTime\": \"10:50\",\n \"arrived\": 1,\n \"actionCodes\": [\n {\n \"id\": 2\n },\n {\n \"id\": 5\n }\n ],\n \"bookingDescription\": \"Test description\",\n \"bookingType\": \"Booking\",\n \"bookedPatientType\": \"Health Care Contract\",\n \"injuryNumber\": \"\",\n \"payments\": [\n {\n \"price\": 200,\n \"amount\": 1,\n \"comment\": \"Test comment\",\n \"account\": \"3010\",\n \"VATPercentage\": 25,\n \"VAT\": 50,\n \"expiryDate\": \"2026-02-11\",\n \"freeByFreeCard\": false,\n \"reducedByFreeCard\": false,\n \"articleName\": \"Action code name\"\n }\n ],\n \"patient\": {\n \"isListed\": true,\n \"personalNumber\": \"20121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Insurance company\",\n \"address\": {\n \"streetName\": \"Test street 55A\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\"\n },\n \"mobilePhone\": \"+46701740635\",\n \"listing\": {\n \"hsaId\": \"SE1234567891-E000000001234\",\n \"countyName\": \"Test County\"\n },\n \"freeCard\": {\n \"cardNumber\": null,\n \"validFrom\": \"2020-07-12\",\n \"validUntil\": null,\n \"amountToLimit\": 900\n }\n },\n \"caregiver\": {\n \"id\": \"574d3bfe-1128-4721-b259-2086c60bc405\",\n \"title\": \"Dr\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19121212-1212\"\n }\n }\n]"},{"id":"c7fefffd-c496-46b2-8515-d675c9fa6449","name":"Clinic Bookings - All bookings and time slots","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/clinics/:clinicId/bookings?personalNumber=121212-1212&fromDate=2020-08-01","host":["{{url}}"],"path":["v1","clinics",":clinicId","bookings"],"query":[{"key":"personalNumber","value":"121212-1212","description":"Required - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX."},{"key":"date","value":"2020-03-24","description":"Filter bookings by date.","disabled":true},{"key":"fromDate","value":"2020-08-01","description":"Filter bookings by from date."},{"key":"toDate","value":"2019-03-24","description":"Filter bookings by to date.","disabled":true},{"key":"arrived","value":"0","description":"Filter bookings by arrived status. **Search values:**\n* 0 - Not arrived\n* 1 - Arrived, but not paid\n* 2 - Arrived and paid","disabled":true},{"key":"self-service","value":"true","description":"Filter bookings by booking type with self service flag. **Default:** true","disabled":true},{"key":"bookingTypeId","value":"1","description":"Filter bookings by booking type Id","disabled":true},{"key":"booked","value":"true","description":"A ternary filter for returned bookings:\ntrue: return only booked ones\nfalse: return only available time slots (empty bookings)\nempty: return both booked and empty ones","disabled":true}],"variable":[{"key":"clinicId","value":"def60545-12fd-86cb-12dc-9834cb00961a"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 12 Jan 2021 10:06:57 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.6"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"4854"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"a5ba581d-d0d9-47a8-893f-e3e94c4efdb4\",\n \"clinicId\": \"def60545-12fd-86cb-12dc-9834cb00961a\",\n \"date\": \"2026-01-10\",\n \"startTime\": \"11:00\",\n \"endTime\": \"11:20\",\n \"arrived\": 2,\n \"actionCodes\": [\n {\n \"id\": 1\n }\n ],\n \"bookingDescription\": \"Test description\",\n \"bookingType\": \"Booking\",\n \"bookedPatientType\": \"Insurance company\",\n \"injuryNumber\": \"FN2026-12345\",\n \"payments\": [\n {\n \"price\": 200,\n \"amount\": 1,\n \"comment\": \"Test comment\",\n \"account\": \"3010\",\n \"VATPercentage\": 25,\n \"VAT\": 50,\n \"expiryDate\": \"2026-02-10\",\n \"freeByFreeCard\": false,\n \"reducedByFreeCard\": false,\n \"articleName\": \"Action code name\"\n }\n ],\n \"patient\": {\n \"isListed\": true,\n \"personalNumber\": \"20121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Insurance company\",\n \"address\": {\n \"streetName\": \"Test street 55A\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\"\n },\n \"mobilePhone\": \"+46701740635\",\n \"listing\": {\n \"hsaId\": \"SE1234567891-E000000001232\",\n \"countyName\": \"Test County\"\n }\n },\n \"caregiver\": {\n \"id\": \"6222731b-acdc-4fa2-8500-3022fd0eeea3\",\n \"title\": \"Dr\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19121212-1212\"\n }\n },\n {\n \"id\": \"b08895b5-7be7-456a-b865-855e75842df5\",\n \"clinicId\": \"def60545-12fd-86cb-12dc-9834cb00961a\",\n \"date\": \"2026-01-13\",\n \"startTime\": \"09:50\",\n \"endTime\": \"10:10\",\n \"arrived\": 1,\n \"actionCodes\": [\n {\n \"id\": 2\n }\n ],\n \"bookingDescription\": \"Test description\",\n \"bookingType\": \"Dropin\",\n \"bookedPatientType\": \"Insurance company\",\n \"injuryNumber\": \"FN2026-67891\",\n \"payments\": [\n {\n \"price\": 100,\n \"amount\": 1,\n \"comment\": \"Test comment\",\n \"account\": \"3010\",\n \"VATPercentage\": 25,\n \"VAT\": 25,\n \"expiryDate\": \"2026-02-13\",\n \"freeByFreeCard\": false,\n \"reducedByFreeCard\": false,\n \"articleName\": \"Action code name\"\n }\n ],\n \"patient\": {\n \"isListed\": true,\n \"personalNumber\": \"20121212-1212\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Health Care Contract\",\n \"address\": {\n \"streetName\": \"Test Street 123\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\",\n \"coAddress\": \"John Doe\"\n },\n \"mobilePhone\": \"+46701740605\",\n \"listing\": {\n \"hsaId\": \"SE1234567891-E000000001234\",\n \"countyName\": \"Test County\"\n },\n \"freeCard\": {\n \"cardNumber\": \"q1234567\",\n \"validFrom\": \"2020-07-04\",\n \"validUntil\": null,\n \"amountToLimit\": 1050\n }\n },\n \"caregiver\": {\n \"id\": \"574d3bfe-1128-4721-b259-2086c60bc405\",\n \"title\": \"Dr\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19121212-1212\"\n }\n },\n {\n \"id\": \"795b22ef-63de-4c5e-8021-5016f0851e9a\",\n \"clinicId\": \"def60545-12fd-86cb-12dc-9834cb00961a\",\n \"date\": \"2026-01-13\",\n \"startTime\": \"11:00\",\n \"endTime\": \"11:20\",\n \"arrived\": 1,\n \"actionCodes\": [\n {\n \"id\": 4\n }\n ],\n \"bookingDescription\": \"Test description\",\n \"bookingType\": \"Online\",\n \"bookedPatientType\": \"Health Care Contract\",\n \"injuryNumber\": \"\",\n \"payments\": [\n {\n \"price\": 0,\n \"amount\": 1,\n \"comment\": \"Test comment\",\n \"account\": \"3010\",\n \"VATPercentage\": 25,\n \"VAT\": 0,\n \"expiryDate\": \"2026-02-13\",\n \"freeByFreeCard\": true,\n \"reducedByFreeCard\": false,\n \"articleName\": \"Action code name\"\n }\n ],\n \"patient\": {\n \"isListed\": false,\n \"personalNumber\": \"20121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Health Care Contract\",\n \"address\": {\n \"streetName\": \"Test street 23\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\",\n \"coAddress\": \"Jane Doe\"\n },\n \"mobilePhone\": \"\",\n \"listing\": null,\n \"freeCard\": {\n \"cardNumber\": \"q1234567\",\n \"validFrom\": \"2020-04-04\",\n \"validUntil\": \"2021-04-04\",\n \"amountToLimit\": 0\n }\n },\n \"caregiver\": {\n \"id\": \"574d3bfe-1128-4721-b259-2086c60bc405\",\n \"title\": \"Dr\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19121212-1212\"\n }\n },\n {\n \"id\": \"adefd797-fdc2-444a-a04a-b3e80bffc7ad\",\n \"clinicId\": \"def60545-12fd-86cb-12dc-9834cb00961a\",\n \"date\": \"2026-01-11\",\n \"startTime\": \"10:30\",\n \"endTime\": \"10:50\",\n \"arrived\": 1,\n \"actionCodes\": [\n {\n \"id\": 2\n },\n {\n \"id\": 5\n }\n ],\n \"bookingDescription\": \"Test description\",\n \"bookingType\": \"Booking\",\n \"bookedPatientType\": \"Health Care Contract\",\n \"injuryNumber\": \"\",\n \"payments\": [\n {\n \"price\": 200,\n \"amount\": 1,\n \"comment\": \"Test comment\",\n \"account\": \"3010\",\n \"VATPercentage\": 25,\n \"VAT\": 50,\n \"expiryDate\": \"2026-02-11\",\n \"freeByFreeCard\": false,\n \"reducedByFreeCard\": false,\n \"articleName\": \"Action code name\"\n }\n ],\n \"patient\": {\n \"isListed\": true,\n \"personalNumber\": \"20121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Insurance company\",\n \"address\": {\n \"streetName\": \"Test street 55A\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\"\n },\n \"mobilePhone\": \"+46701740635\",\n \"listing\": {\n \"hsaId\": \"SE1234567891-E000000001234\",\n \"countyName\": \"Test County\"\n },\n \"freeCard\": {\n \"cardNumber\": null,\n \"validFrom\": \"2020-07-12\",\n \"validUntil\": null,\n \"amountToLimit\": 900\n }\n },\n \"caregiver\": {\n \"id\": \"574d3bfe-1128-4721-b259-2086c60bc405\",\n \"title\": \"Dr\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19121212-1212\"\n }\n }\n]"},{"id":"b976330a-a3e0-480f-8d08-334abc91d23a","name":"Clinic Bookings, Duplicate patient","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/clinics/:clinicId/bookings?personalNumber=121212-1212&fromDate=2020-03-24&toDate=2020-03-24&arrived=0&selfService=true","host":["{{url}}"],"path":["v1","clinics",":clinicId","bookings"],"query":[{"key":"personalNumber","value":"121212-1212","description":"Required - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX."},{"key":"date","value":"2020-03-24","description":"Filter bookings by date.","disabled":true},{"key":"fromDate","value":"2020-03-24","description":"Filter bookings by from date."},{"key":"toDate","value":"2020-03-24","description":"Filter bookings by to date."},{"key":"arrived","value":"0","description":"Filter bookings by arrived status. **Search values:**\n* 0 - Not arrived\n* 1 - Arrived, but not paid\n* 2 - Arrived and paid"},{"key":"selfService","value":"true","description":"Filter bookings by booking types used for patient self service."}],"variable":[{"key":"clinicId","value":"def60545-12fd-86cb-12dc-9834cb00961a"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 16 Oct 2020 07:52:53 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.6"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"93"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 5001,\n \"message\": \"More than one patient matches personal number 121212-1212\"\n }\n}"},{"id":"7f29e198-180c-4b68-a3a5-efbb2572d039","name":"JSON Schema","originalRequest":{"method":"GET","header":[{"key":"JSON_Schema","value":"true"}],"url":{"raw":"{{url}}/v1/clinics/:clinicId/bookings?JSON_Schema=true","host":["{{url}}"],"path":["v1","clinics",":clinicId","bookings"],"query":[{"key":"personalNumber","value":"19121212-1212","description":"Required - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX.\nForeign personal numbers are also supported. The format needs to be YYYYMMDD-ZXXX, YYYYMMDD+ZXXX, YYYYMMDDZXXX or even in the reduced format of YYMMDD-ZXXX, YYMMDD+ZXXX and YYMMDDZXXX where Z is either M, K or X.","disabled":true},{"key":"date","value":"2021-01-01","description":"_Optional_ - Bookings date in the format of YYYY-MM-DD. Timezone: 'CET'.","disabled":true},{"key":"fromDate","value":"2020-01-01","description":"_Optional_ - Lower limit date in the format of YYYY-MM-DD. Timezone: 'CET'.","disabled":true},{"key":"toDate","value":"2021-02-01","description":"_Optional_ - Upper limit date in the format of YYYY-MM-DD. Timezone: 'CET'.","disabled":true},{"key":"arrived","value":"2","description":"_Optional_ - Filter bookings by arrived status.\n\\\n\\\n**Search values:**\n* 0 - Not arrived\n* 1 - Arrived, but not paid\n* 2 - Arrived and paid","disabled":true},{"key":"selfService","value":"true","description":"_Optional_ - Filter bookings by booking type with self service flag.\n\\\n**Default:** true","disabled":true},{"key":"bookingTypeId","value":"9","description":"_Optional_ - Filter bookings with the given booking type id.","disabled":true},{"key":"booked","value":"true","description":"_Optional_ - Booking state selector.\n\\\n\\\nThis is a ternary filter:\n* true - Select booked time slots.\n* false - Select available time slots.\n* <empty> - Leave empty to select all time slots - both booked and available.","disabled":true},{"key":"userId","value":"{{userId}}","description":"_Optional_ - Filter bookings by a caregiver based on a userId (UUID).","disabled":true},{"key":"limit","value":"10","description":"_Optional_ - Limit the number of bookings that's being returned","disabled":true},{"key":"offset","value":"0","description":"_Optional_ - Offset the bookings that's being returned","disabled":true},{"key":"reservedForOrganizationId","value":"50","description":"_Optional_ - Get bookings that are reserved to an organization","disabled":true},{"key":"reservedForDepartmentId","value":"65","description":"_Optional_ - Get bookings that are reserved to a department","disabled":true},{"key":"JSON_Schema","value":"true"}],"variable":[{"key":"clinicId","value":"{{clinicId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 02 Dec 2022 19:34:01 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.13"},{"key":"Set-Cookie","value":"PHPSESSID=6f7d707a5fc823f625a4ce2756c3547b; path=/"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"1867"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Bookings\",\n \"items\": {\n \"required\": [\n \"id\",\n \"clinicId\",\n \"date\",\n \"startTime\",\n \"endTime\",\n \"arrived\",\n \"actionCodes\",\n \"bookingDescription\",\n \"bookingType\",\n \"bookedPatientType\",\n \"injuryNumber\",\n \"payments\",\n \"caregiver\"\n ],\n \"additionalProperties\": true,\n \"properties\": {\n \"id\": {\n \"title\": \"Booking Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/items/properties/id\"\n },\n \"clinicId\": {\n \"title\": \"Clinic Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/items/properties/clinicId\"\n },\n \"date\": {\n \"title\": \"Booking date\",\n \"type\": \"string\",\n \"format\": \"date\",\n \"default\": \"\", \n \"examples\": [\n \"2037-01-12\"\n ],\n \"$id\": \"#/items/properties/date\"\n },\n \"startTime\": {\n \"title\": \"Booking start time\",\n \"$ref\": \"#/definitions/time\",\n \"$id\": \"#/items/properties/startTime\"\n },\n \"endTime\": {\n \"title\": \"Booking end time\",\n \"$ref\": \"#/definitions/time\",\n \"$id\": \"#/items/properties/endTime\"\n },\n \"arrived\": {\n \"title\": \"Has the patient arrived/arrived and paid\",\n \"description\": \"[Not arrived](0), [Arrived but hasn't paid yet](1), [Arrived and paid](2)\",\n \"default\": 0,\n \"examples\": [\n 0, \n 1,\n 2\n ],\n \"$id\": \"#/items/properties/arrived\",\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 2\n },\n \"actionCodes\": {\n \"title\": \"Action codes\",\n \"items\": {\n \"title\": \"Action code\",\n \"required\": [\n \"id\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Action code Id\",\n \"default\": 0,\n \"examples\": [\n 1, 4379\n ],\n \"$id\": \"#/items/properties/actionCodes/items/properties/id\",\n \"type\": \"integer\"\n }\n },\n \"$id\": \"#/items/properties/actionCodes/items\",\n \"type\": \"object\"\n },\n \"$id\": \"#/items/properties/actionCodes\",\n \"type\": \"array\"\n },\n \"bookingDescription\": {\n \"title\": \"Booking description\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"\"\n ],\n \"$id\": \"#/items/properties/bookingDescription\",\n \"type\": \"string\"\n },\n \"bookingType\": {\n \"title\": \"Booking type\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Lunch\", \"Online\", \"Privat\"\n ],\n \"$id\": \"#/items/properties/bookingType\",\n \"type\": \"string\"\n },\n \"bookedPatientType\": {\n \"title\": \"Booking set insurance\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"SLL Vårdval\"\n ],\n \"$id\": \"#/items/properties/bookedPatientType\",\n \"type\": \"string\"\n },\n \"injuryNumber\": {\n \"title\": \"Injury number\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"2345\", \"Knee 34\"\n ],\n \"$id\": \"#/items/properties/injuryNumber\",\n \"type\": \"string\"\n },\n \"payments\": {\n \"title\": \"Payments\",\n \"items\": {\n \"title\": \"Payments list\",\n \"required\": [\n \"price\",\n \"amount\", \n \"account\",\n \"VATPercentage\",\n \"VAT\",\n \"expiryDate\"\n ],\n \"additionalProperties\": true,\n \"properties\": {\n \"price\": {\n \"title\": \"Payment fees\",\n \"default\": 0,\n \"examples\": [\n 0, 100, 50.50\n ],\n \"$id\": \"#/items/properties/payments/items/properties/price\",\n \"type\": \"number\"\n },\n \"amount\": {\n \"title\": \"Amount\",\n \"default\": 0,\n \"examples\": [\n 1\n ],\n \"$id\": \"#/items/properties/payments/items/properties/amount\",\n \"type\": \"number\"\n },\n \"comment\": {\n \"title\": \"Payment comment\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Payment fees for John Doe for visiting to Clinic on 2020-06-16\"\n ],\n \"$id\": \"#/items/properties/payments/items/properties/comment\",\n \"type\": \"string\"\n },\n \"account\": {\n \"title\": \"Payment account\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"3010\"\n ],\n \"$id\": \"#/items/properties/payments/items/properties/account\",\n \"type\": \"string\"\n },\n \"VATPercentage\": {\n \"title\": \"VAT percentage\",\n \"default\": 0,\n \"examples\": [\n 0\n ],\n \"$id\": \"#/items/properties/payments/items/properties/VATPercentage\",\n \"type\": \"number\"\n },\n \"VAT\": {\n \"title\": \"VAT\",\n \"default\": 0,\n \"examples\": [\n 12.5, 0\n ],\n \"$id\": \"#/items/properties/payments/items/properties/VAT\",\n \"type\": \"number\"\n },\n \"expiryDate\": {\n \"title\": \"Expiry date\",\n \"type\": \"string\",\n \"format\": \"date\",\n \"default\": \"\", \n \"examples\": [\n \"2037-01-12\"\n ],\n \"$id\": \"#/items/properties/payments/items/properties/expiryDate\"\n },\n \"freeByFreeCard\": {\n \"title\": \"Is the visit free by the free card\",\n \"default\": false,\n \"examples\": [\n false, true\n ],\n \"$id\": \"#/items/properties/payments/items/properties/freeByFreeCard\",\n \"type\": \"boolean\"\n },\n \"reducedByFreeCard\": {\n \"title\": \"Is the visit discounted by the free card\",\n \"default\": false,\n \"examples\": [\n false, true\n ],\n \"$id\": \"#/items/properties/payments/items/properties/reducedByFreeCard\",\n \"type\": \"boolean\"\n }\n },\n \"$id\": \"#/items/properties/payments/items\",\n \"type\": \"object\"\n },\n \"$id\": \"#/items/properties/payments\",\n \"type\": \"array\"\n },\n \"patient\": { \n \"title\": \"The patient's info\",\n \"required\": [\n \"isListed\",\n \"personalNumber\",\n \"firstName\",\n \"lastName\",\n \"patientType\",\n \"address\",\n \"mobilePhone\",\n \"listing\"\n ],\n \"additionalProperties\": true,\n \"properties\": {\n \"isListed\": {\n \"title\": \"Is the patient registered in the clinic\",\n \"default\": false,\n \"examples\": [\n false, true, 1, 0\n ],\n \"$id\": \"#/items/properties/patient/properties/isListed\",\n \"type\": \"boolean\"\n },\n \"personalNumber\": {\n \"title\": \"Patient personal identifier\",\n \"$ref\": \"#/definitions/personalNumber\",\n \"$id\": \"#/items/properties/patient/properties/personalNumber\"\n },\n \"firstName\": {\n \"title\": \"First name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Tolvan\"\n ],\n \"$id\": \"#/items/properties/patient/properties/firstName\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"title\": \"Family name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Tolvansson\"\n ],\n \"$id\": \"#/items/properties/patient/properties/lastName\",\n \"type\": \"string\"\n },\n \"patientType\": {\n \"title\": \"Insurance\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"SLL Vårdval\"\n ],\n \"$id\": \"#/items/properties/patient/properties/patientType\",\n \"type\": \"string\"\n },\n \"address\": {\n \"title\": \"Address\",\n \"required\": [\n \"streetName\",\n \"city\",\n \"zipCode\"\n ],\n \"properties\": {\n \"streetName\": {\n \"title\": \"Address street name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Nellickevägen 20\"\n ],\n \"$id\": \"#/items/properties/patient/properties/address/properties/streetName\",\n \"type\": \"string\"\n },\n \"city\": {\n \"title\": \"Address cilty\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"GÖTEBORG\"\n ],\n \"$id\": \"#/items/properties/patient/properties/address/properties/city\",\n \"type\": \"string\"\n },\n \"zipCode\": {\n \"title\": \"Post code\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"41263\"\n ],\n \"$id\": \"#/items/properties/patient/properties/address/properties/zipCode\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/items/properties/patient/properties/address\",\n \"type\": \"object\"\n },\n \"mobilePhone\": {\n \"title\": \"Mobile phone\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"010 11111111\"\n ],\n \"type\": [\"string\", \"null\"],\n \"$id\": \"#/items/properties/patient/properties/mobilePhone\"\n \n },\n \"listing\": {\n \"title\": \"Clinic where the patient is listed\",\n \"required\": [\n \"hsaId\",\n \"countyName\"\n ],\n \"properties\": {\n \"hsaId\": {\n \"title\": \"Clinic HSA id\",\n \"$ref\": \"#/definitions/hsaId\",\n \"$id\": \"#/items/properties/patient/properties/listing/properties/hsaId\"\n },\n \"countyName\": {\n \"title\": \"Clinic county\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"1\"\n ],\n \"$id\": \"#/items/properties/patient/properties/listing/properties/countyName\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/items/properties/patient/properties/listing\",\n \"type\": [\"object\", \"null\"]\n },\n \"freeCard\": {\n \"title\": \"The patient's free card\",\n \"required\": [\n \"cardNumber\",\n \"validFrom\",\n \"validUntil\",\n \"amountToLimit\"\n ],\n \"properties\": {\n \"cardNumber\": {\n \"title\": \"Free card id\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"q1234567\"\n ],\n \"$id\": \"#/items/properties/patient/properties/freeCard/properties/cardNumber\",\n \"type\": [\"string\", \"null\"]\n },\n \"validFrom\": {\n \"title\": \"Patient's free card starting validity\",\n \"type\": \"string\",\n \"format\": \"date\",\n \"default\": \"\", \n \"examples\": [\n \"2037-01-12\"\n ],\n \"$id\": \"#/items/properties/patient/properties/freeCard/properties/validFrom\"\n },\n \"validUntil\": {\n \"title\": \"Patient's free card ending validity\",\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"date\"\n },\n {\n \"type\": \"null\"\n }\n ], \n \"default\": \"\", \n \"examples\": [\n \"2037-01-12\", null\n ],\n \"$id\": \"#/items/properties/patient/properties/freeCard/properties/validUntil\" \n },\n \"amountToLimit\": {\n \"title\": \"Amount left to free card activation\",\n \"default\": 0,\n \"examples\": [\n 1050, 0\n ],\n \"$id\": \"#/items/properties/patient/properties/freeCard/properties/amountToLimit\",\n \"type\": \"number\"\n }\n },\n \"$id\": \"#/items/properties/patient/properties/freeCard\"\n }\n },\n \"$id\": \"#/items/properties/patient\",\n \"type\": [\"object\", \"null\", \"array\"] \n },\n \"caregiver\": {\n \"title\": \"User schema\",\n \"required\": [\n \"id\",\n \"firstName\",\n \"lastName\",\n \"identifier\"\n ],\n \"additionalProperties\": true,\n \"properties\": {\n \"id\": {\n \"title\": \"Caregiver's uuid\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/items/caregiver/properties/id\" \n },\n \"title\": {\n \"title\": \"Caregiver's title\",\n \"default\": \"\",\n \"pattern\": \"^.*$\",\n \"examples\": [\n \"\"\n ],\n \"$id\": \"#/items/caregiver/properties/title\",\n \"type\": \"string\"\n },\n \"firstName\": {\n \"title\": \"Caregiver's first name\",\n \"$ref\": \"#/definitions/properName\",\n \"$id\": \"#/items/caregiver/properties/firstName\"\n },\n \"lastName\": {\n \"title\": \"Caregiver's last name\",\n \"$ref\": \"#/definitions/properName\",\n \"$id\": \"#/items/caregiver/properties/lastName\"\n },\n \"identifier\": {\n \"title\": \"Caregiver's personal identifier\",\n \"$ref\": \"#/definitions/personalNumber\",\n \"$id\": \"#/items/caregiver/properties/identifier\"\n }\n },\n \"$id\": \"#/items/caregiver/properties\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"#/items\",\n \"type\": \"object\"\n },\n \"definitions\": {\n \"uuid\": {\n \"$id\": \"#/definitions/uuid\",\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"default\": \"\",\n \"examples\": [\n \"ee4d906f-2eca-4345-9907-a4c6c2fcd931\"\n ]\n },\n \"personalNumber\": {\n \"$id\": \"#/definitions/personalNumber\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^([0-9]{6}|[0-9]{8})[-+]?[0-9]{4}$\",\n \"examples\": [\n \"19121212-1212\", \"121212-1212\",\n \"19121212+1212\", \"121212+1212\",\n \"191212121212\", \"1212121212\"\n ] \n },\n \"time\": {\n \"$id\": \"#/definitions/time\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^[01][0-9]|2[0-3]:[0-5][0-9]$\",\n \"examples\": [\n \"19:25\"\n ] \n },\n \"hsaId\": {\n \"$id\": \"#/definitions/hsaId\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^SE[0-9]{10}-[0-9A-Za-z]+$\",\n \"examples\": [\n \"SE2321000131-007643n\"\n ]\n },\n \"properName\": {\n \"$id\": \"#/definitions/properName\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^[A-Z][a-zA-Z \\\\-_.]+$\",\n \"examples\": [\n \"Joe\", \"Jean-Pierre\", \"Anna Maria\"\n ]\n }\n },\n \"$id\": \"http://webdoc.api/response/bookings/v1/get/clinic_bookings\",\n \"type\": \"array\",\n \"$schema\": \"http://json-schema.org/draft-07/schema\"\n}"}],"_postman_id":"005eb40c-3c7e-47ad-a5d4-a7a24254a428"},{"name":"Bookings","id":"3cf2e24e-19ba-4f21-8211-cdacbb73fb42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"grant_type":"","client_authentication":"","scope":"{{authScopes}}","clientSecret":"{{authClientSecret}}","clientId":"{{authClientId}}"},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/v1/bookings?isBooked=1&userId=71a5b2a7-2abc-4e86-9212-f3c5e748893d&clinicId=9ce597b0-8801-4709-9bae-d732c6a10094&bookingTypeId=7&fromDate=2021-01-01&toDate=2021-02-01&reservedForOrganizationId=5&reservedForDepartmentId=9&offset=0&personalNumber=19121212-1212&arrivalStatus=0","description":"

This endpoint enables the fetching of more bookings than the endpoint \"GET Clinic Bookings\". When working with larger sets of bookings, this endpoint should be used if possible.

\n

Note:

\n
    \n

  • The result set is limited to a maximum of 100 bookings!

    \n
    • \n

  • Bookings registered with a personal number that does not yet match any existing patient in Webdoc will only return the personal number value in patient objects (see reponse example via the selected example request named \"Bookings\").

    \n
    • \n
\n

Furthermore, optional parameters can be used to filter the bookings. Moreover, some fields accept both single and multiple values. If you want to use multiple values, send them as an http array. An http array looks like the following: queryParamName[]=value1&queryParamName[]=value2
You can mix the array with your other filter parameters as needed.\n

\n

Allowed with one of the following scopes:

\n
    \n

  • bookings:read

    \n
    • \n

  • bookings:write

    \n
    • \n
\n","urlObject":{"path":["v1","bookings"],"host":["{{url}}"],"query":[{"description":{"content":"

Optional - Can either be: '1' (booked), or '0' (unbooked).

\n","type":"text/plain"},"key":"isBooked","value":"1"},{"description":{"content":"

Optional - User ID in UUID format. (If you want to filter on multiple values, send an http array. See above for instructions)

\n","type":"text/plain"},"key":"userId","value":"71a5b2a7-2abc-4e86-9212-f3c5e748893d"},{"description":{"content":"

Optional - Clinic ID in UUID format. (If you want to filter on multiple values, send an http array. See above for instructions)

\n","type":"text/plain"},"key":"clinicId","value":"9ce597b0-8801-4709-9bae-d732c6a10094"},{"description":{"content":"

Optional (If you want to filter on multiple values, send an http array. See above for instructions)

\n","type":"text/plain"},"key":"bookingTypeId","value":"7"},{"description":{"content":"

Optional - Get bookings from a specific date (YYYY-MM-DD format).

\n","type":"text/plain"},"key":"fromDate","value":"2021-01-01"},{"description":{"content":"

Optional - Get bookings to a specific date (YYYY-MM-DD format).

\n","type":"text/plain"},"key":"toDate","value":"2021-02-01"},{"description":{"content":"

Optional - Get bookings that are reserved to an organization.

\n","type":"text/plain"},"key":"reservedForOrganizationId","value":"5"},{"description":{"content":"

Optional - Get bookings that are reserved to a department.

\n","type":"text/plain"},"key":"reservedForDepartmentId","value":"9"},{"description":{"content":"

Optional - Offset the bookings that are being returned.

\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"

Optional - The personal number of the patient in the format of \"YYYYMMDD-XXXX\", \"YYYYMMDD+XXXX\", or \"YYYYMMDDXXXX\". Currently, only Swedish personal numbers are allowed.

\n","type":"text/plain"},"key":"personalNumber","value":"19121212-1212"},{"description":{"content":"

Optional - Filter bookings by arrival status.\n

Search values:

\n
    \n
  • 0 - Not arrived.
    • \n
  • 1 - Arrived, but not paid.
    • \n
  • 2 - Arrived and paid.
    • \n
\n","type":"text/plain"},"key":"arrivalStatus","value":"0"}],"variable":[]}},"response":[{"id":"c87ee39d-f3ed-4c41-be4b-ca3d49343c8f","name":"Bookings","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/bookings?isBooked=1&userId=71a5b2a7-2abc-4e86-9212-f3c5e748893d&clinicId=9ce597b0-8801-4709-9bae-d732c6a10094&bookingTypeId=7&fromDate=2021-01-01&toDate=2021-02-01&reservedForOrganizationId=5&reservedForDepartmentId=9&offset=0&personalNumber=1912121212-1212","host":["{{url}}"],"path":["v1","bookings"],"query":[{"key":"isBooked","value":"1","description":"_Optional_ - Can either be: \n1: Booked\n2: Unbooked"},{"key":"userId","value":"71a5b2a7-2abc-4e86-9212-f3c5e748893d","description":"_Optional_ - User id in UUID format"},{"key":"clinicId","value":"9ce597b0-8801-4709-9bae-d732c6a10094","description":"_Optional_ - Clinic id in UUID format."},{"key":"bookingTypeId","value":"7","description":"_Optional_ - The booking type that the booking relates to."},{"key":"fromDate","value":"2021-01-01","description":"_Optional_ - Get bookings from a specific date (YYYY-MM-DD format)."},{"key":"toDate","value":"2021-02-01","description":"_Optional_ - Get bookings to a specific date (YYYY-MM-DD format)."},{"key":"reservedForOrganizationId","value":"5","description":"_Optional_ - Filter bookings on a specific organization ID."},{"key":"reservedForDepartmentId","value":"9","description":"_Optional_ - Filter bookings on a specific department ID."},{"key":"offset","value":"0","description":"_Optional_ - Offset the bookings that is being returned."},{"key":"personalNumber","value":"1912121212-1212","description":"_Optional_ - The personal number of the patient in the format of \"YYYYMMDD-XXXX\", \"YYYYMMDD+XXXX\", or \"YYYYMMDDXXXX\". Currently, only Swedish personal numbers are allowed."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"f17f40c0-e5be-44d3-9dfe-98527c5fa706\",\n \"date\": \"2021-03-20\",\n \"startTime\": \"11:30\",\n \"endTime\": \"11:50\",\n \"note\": \"Booking note\",\n \"injuryNumber\": \"123456-7890\",\n \"reservedForOrganizationId\": 5,\n \"reservedForDepartmentId\": 10,\n \"user\": {\n \"id\": \"614b370b-43bb-4b2b-82df-6b1958c11bdb\",\n \"personalNumber\": \"19121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"title\": \"Dr\"\n },\n \"bookingType\": {\n \"id\": 7,\n \"name\": \"Initial contact\"\n },\n \"clinic\": {\n \"id\": \"4e0d138c-b5e2-4b97-a340-6223f4215bec\"\n },\n \"patient\": {\n \"id\": \"68d4f18b-e9cb-4f82-853f-4cd365e9a852\",\n \"personalNumber\": \"20121212-1212\",\n \"firstName\": \"Jimmy\",\n \"lastName\": \"Smith\",\n \"phoneNumber\": \"+46123456789\",\n \"email\": \"jimmy@example.com\"\n },\n \"patientType\": {\n \"id\": 34\n },\n \"actionCodes\": [\n {\n \"id\": \"1\"\n },\n {\n \"id\": \"7\"\n }\n ]\n },\n {\n \"id\": \"2ebdb8c7-1792-4693-b90d-d304a06b4017\",\n \"date\": \"2021-03-21\",\n \"startTime\": \"12:10\",\n \"endTime\": \"12:40\",\n \"note\": \"\",\n \"injuryNumber\": \"\",\n \"reservedForOrganizationId\": 5,\n \"reservedForDepartmentId\": 10,\n \"user\": {\n \"id\": \"7fc1b1fb-e51a-4385-9d84-498a43d2f02d\",\n \"personalNumber\": \"19121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"title\": \"Dr\"\n },\n \"bookingType\": {\n \"id\": 7,\n \"name\": \"Initial contact\"\n },\n \"clinic\": {\n \"id\": \"92ee8461-828d-42c0-9966-d0f3a6807e2d\"\n },\n \"patient\": null,\n \"patientType\": null,\n \"actionCodes\": []\n },\n {\n \"id\": \"cbf9db31-6ad5-11ef-a38a-8edde2e78ced\",\n \"date\": \"2024-09-04\",\n \"startTime\": \"13:00\",\n \"endTime\": \"14:00\",\n \"note\": \"A booking note.\",\n \"injuryNumber\": \"\",\n \"reservedForOrganizationId\": null,\n \"reservedForDepartmentId\": null,\n \"user\": {\n \"id\": \"7fc1b1fb-e51a-4385-9d84-498a43d2f02d\",\n \"personalNumber\": \"19121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"title\": \"Dr\"\n },\n \"bookingType\": {\n \"id\": 7,\n \"name\": \"Initial contact\"\n },\n \"clinic\": {\n \"id\": \"92ee8461-828d-42c0-9966-d0f3a6807e2d\"\n },\n \"patient\": {\n \"id\": null,\n \"personalNumber\": \"20131313-1313\",\n \"firstName\": null,\n \"lastName\": null,\n \"phoneNumber\": \"\",\n \"email\": \"\"\n },\n \"patientType\": null,\n \"actionCodes\": []\n }\n]"},{"id":"1901d39b-cefd-4759-906d-4171dd2046c6","name":"Bookings filtered with multiple bookingType values","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/bookings?isBooked=1&bookingTypeId[]=7&bookingTypeId[]=10&fromDate=2019-04-03&toDate=2019-09-19&offset=0","host":["{{url}}"],"path":["v1","bookings"],"query":[{"key":"isBooked","value":"1","description":"_Optional_ - Can either be: '1' (booked), or '0' (unbooked)."},{"key":"userId","value":"71a5b2a7-2abc-4e86-9212-f3c5e748893d","disabled":true},{"key":"clinicId","value":"9ce597b0-8801-4709-9bae-d732c6a10094","disabled":true},{"key":"bookingTypeId[]","value":"7","description":"_Optional_ (If you want to filter on multiple values, send an http array. See above for instructions)"},{"key":"bookingTypeId[]","value":"10"},{"key":"fromDate","value":"2019-04-03","description":"_Optional_ - Get bookings from a specific date (YYYY-MM-DD format)."},{"key":"toDate","value":"2019-09-19","description":"_Optional_ - Get bookings to a specific date (YYYY-MM-DD format)."},{"key":"reservedForOrganizationId","value":"5","description":"_Optional_ - Get bookings that are reserved to an organization.","disabled":true},{"key":"reservedForDepartmentId","value":"9","description":"_Optional_ - Get bookings that are reserved to a department.","disabled":true},{"key":"offset","value":"0","description":"_Optional_ - Offset the bookings that are being returned."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 13 Oct 2022 08:47:21 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.13"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"4091"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"e27671b2-ae79-430f-8b53-2efbd594b392\",\n \"date\": \"2019-04-04\",\n \"startTime\": \"11:20\",\n \"endTime\": \"11:40\",\n \"note\": \"Booking note\",\n \"injuryNumber\": \"\",\n \"reservedForOrganizationId\": null,\n \"reservedForDepartmentId\": null,\n \"user\": null,\n \"bookingType\": {\n \"id\": 7,\n \"name\": \"Initial contact\"\n },\n \"clinic\": {\n \"id\": \"481c97c5-0bd7-4aff-aca2-71ce9003b613\"\n },\n \"patient\": {\n \"id\": \"975bc15b-8abb-4fa4-b80f-d27b20e7d210\",\n \"personalNumber\": \"20121212-1212\",\n \"firstName\": \"Jimmy\",\n \"lastName\": \"Smith\",\n \"phoneNumber\": \"+46123456789\",\n \"email\": \"jimmy@example.com\"\n },\n \"patientType\": {\n \"id\": 40\n },\n \"actionCodes\": [\n {\n \"id\": \"1\"\n },\n {\n \"id\": \"3\"\n }\n ]\n },\n {\n \"id\": \"5460081a-a30a-4b87-a920-1dc693b01585\",\n \"date\": \"2019-04-03\",\n \"startTime\": \"11:40\",\n \"endTime\": \"12:00\",\n \"note\": \"\",\n \"injuryNumber\": \"\",\n \"reservedForOrganizationId\": null,\n \"reservedForDepartmentId\": null,\n \"user\": null,\n \"bookingType\": {\n \"id\": 10,\n \"name\": \"Follow-up\"\n },\n \"clinic\": {\n \"id\": \"481c97c5-0bd7-4aff-aca2-71ce9003b613\"\n },\n \"patient\": {\n \"id\": \"975bc15b-8abb-4fa4-b80f-d27b20e7d234\",\n \"personalNumber\": \"20121212-1212\",\n \"firstName\": \"Jimmy\",\n \"lastName\": \"Smith\",\n \"phoneNumber\": \"+46123456789\",\n \"email\": \"jimmy@example.com\"\n },\n \"patientType\": {\n \"id\": 56\n },\n \"actionCodes\": []\n }\n]"},{"id":"049de5d7-b684-4e41-ad14-580541581f38","name":"JSON Schema","originalRequest":{"method":"GET","header":[{"key":"JSON_Schema","value":"true"}],"url":{"raw":"{{url}}/v1/bookings","host":["{{url}}"],"path":["v1","bookings"],"query":[{"key":"personalNumber","value":"19121212-1212","description":"_Optional_ - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX.\nForeign personal numbers are also supported. The format needs to be YYYYMMDD-ZXXX, YYYYMMDD+ZXXX, YYYYMMDDZXXX or even in the reduced format of YYMMDD-ZXXX, YYMMDD+ZXXX and YYMMDDZXXX where Z is either M, K or X.","disabled":true},{"key":"date","value":"2021-01-01","description":"_Optional_ - Bookings date in the format of YYYY-MM-DD. Timezone: 'CET'.","disabled":true},{"key":"fromDate","value":"2020-01-01","description":"_Optional_ - Lower limit date in the format of YYYY-MM-DD. Timezone: 'CET'.","disabled":true},{"key":"toDate","value":"2021-02-01","description":"_Optional_ - Upper limit date in the format of YYYY-MM-DD. Timezone: 'CET'.","disabled":true},{"key":"arrived","value":"2","description":"_Optional_ - Filter bookings by arrived status.\n\\\n\\\n**Search values:**\n* 0 - Not arrived\n* 1 - Arrived, but not paid\n* 2 - Arrived and paid","disabled":true},{"key":"selfService","value":"true","description":"_Optional_ - Filter bookings by booking type with self service flag.\n\\\n**Default:** true","disabled":true},{"key":"bookingTypeId","value":"9","description":"_Optional_ - Filter bookings with the given booking type id.","disabled":true},{"key":"booked","value":"true","description":"_Optional_ - Booking state selector.\n\\\n\\\nThis is a ternary filter:\n* true - Select booked time slots.\n* false - Select available time slots.\n* <empty> - Leave empty to select all time slots - both booked and available.","disabled":true},{"key":"userId","value":"{{userId}}","description":"_Optional_ - Filter bookings by a caregiver based on a userId (UUID).","disabled":true},{"key":"limit","value":"10","description":"_Optional_ - Limit the number of bookings that's being returned","disabled":true},{"key":"offset","value":"0","description":"_Optional_ - Offset the bookings that's being returned","disabled":true},{"key":"reservedForOrganizationId","value":"50","description":"_Optional_ - Get bookings that are reserved to an organization","disabled":true},{"key":"reservedForDepartmentId","value":"65","description":"_Optional_ - Get bookings that are reserved to a department","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 02 Dec 2022 19:34:01 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.13"},{"key":"Set-Cookie","value":"PHPSESSID=6f7d707a5fc823f625a4ce2756c3547b; path=/"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"1867"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Bookings\",\n \"items\": {\n \"title\": \"A booking\",\n \"required\": [\n \"id\",\n \"date\",\n \"startTime\",\n \"endTime\",\n \"note\",\n \"injuryNumber\",\n \"reservedForOrganizationId\",\n \"reservedForDepartmentId\",\n \"user\",\n \"bookingType\",\n \"clinic\",\n \"patient\",\n \"patientType\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Booking Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/items/properties/id\"\n },\n \"date\": {\n \"title\": \"Booking date\",\n \"default\": \"\",\n \"format\": \"date\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"2021-03-20\"\n ],\n \"$id\": \"#/items/properties/date\",\n \"type\": \"string\"\n },\n \"startTime\": {\n \"title\": \"Booking start time\",\n \"$ref\": \"#/definitions/time\",\n \"$id\": \"#/items/properties/startTime\"\n },\n \"endTime\": {\n \"title\": \"Booking end time\",\n \"$ref\": \"#/definitions/time\",\n \"$id\": \"#/items/properties/endTime\"\n },\n \"note\": {\n \"title\": \"Note\",\n \"default\": 0,\n \"examples\": [\n \"Some note\"\n ],\n \"$id\": \"#/items/properties/note\",\n \"type\": \"string\"\n },\n \"injuryNumber\": {\n \"title\": \"Injury number\",\n \"default\": null,\n \"examples\": [\n \"123456-7890\"\n ],\n \"$id\": \"#/items/properties/injuryNumber\",\n \"type\": \"string\"\n },\n \"reservedForOrganizationId\": {\n \"title\": \"Reserved for organization Id\",\n \"default\": 0,\n \"examples\": [\n 5, null\n ],\n \"$id\": \"#/items/properties/reservedForOrganizationId\",\n \"type\": [\"integer\", \"null\"]\n },\n \"reservedForDepartmentId\": {\n \"title\": \"Reserved for department Id\",\n \"default\": 0,\n \"examples\": [\n 10, null\n ],\n \"$id\": \"#/items/properties/reservedForDepartmentId\",\n \"type\": [\"integer\", \"null\"]\n },\n \"user\": {\n \"title\": \"User\",\n \"required\": [\n \"id\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"User's Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/items/properties/user/properties/id\"\n }\n },\n \"$id\": \"#/items/properties/user\",\n \"type\": \"object\"\n },\n \"bookingType\": {\n \"title\": \"Booking type\",\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Booking type Id\",\n \"default\": 0,\n \"examples\": [\n 7\n ],\n \"$id\": \"#/items/properties/bookingType/properties/id\",\n \"type\": \"integer\"\n },\n \"name\": {\n \"title\": \"name\",\n \"$id\": \"#/items/properties/bookingType/properties/name\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/items/properties/bookingType\",\n \"type\": \"object\"\n },\n \"clinic\": {\n \"title\": \"Clinic\",\n \"required\": [\n \"id\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Clinic Id\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"4e0d138c-b5e2-4b97-a340-6223f4215bec\"\n ],\n \"$id\": \"#/items/properties/clinic/properties/id\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/items/properties/clinic\",\n \"type\": \"object\"\n },\n \"patient\": {\n \"title\": \"Patient\",\n \"required\": [\n \"id\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Patient's Id\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"68d4f18b-e9cb-4f82-853f-4cd365e9a852\"\n ],\n \"$id\": \"#/items/properties/patient/properties/id\",\n \"type\": \"string\"\n },\n \"personalNumber\": {\n \"title\": \"Patient's personal identifier\",\n \"$ref\": \"#/definitions/personalNumber\",\n \"$id\": \"#/properties/personalNumber\"\n },\n \"firstName\": {\n \"title\": \"A string value\",\n \"$ref\": \"#/definitions/properName\",\n \"$id\": \"#/properties/firstName\"\n },\n \"lastName\": {\n \"title\": \"A string value\",\n \"$ref\": \"#/definitions/properName\",\n \"$id\": \"#/properties/lastName\"\n },\n \"phoneNumber\": {\n \"title\": \"A string value\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"+46123456789\"\n ],\n \"$id\": \"#/properties/phoneNumber\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/items/properties/patient\",\n \"type\": \"object\"\n },\n \"patientType\": {\n \"title\": \"Patient type\",\n \"required\": [\n \"id\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Patient type Id\",\n \"default\": 0,\n \"examples\": [\n 34\n ],\n \"$id\": \"#/items/properties/patientType/properties/id\",\n \"type\": \"integer\"\n }\n },\n \"$id\": \"#/items/properties/patientType\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"#/items\",\n \"type\": \"object\"\n },\n \"$id\": \"http://webdoc.api/response/bookings/v1/get/bookings\",\n \"type\": \"array\",\n \"definitions\": {\n \"uuid\": {\n \"$id\": \"#/definitions/uuid\",\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"default\": \"\",\n \"examples\": [\n \"ee4d906f-2eca-4345-9907-a4c6c2fcd931\"\n ]\n },\n \"personalNumber\": {\n \"$id\": \"#/definitions/personalNumber\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^([0-9]{6}|[0-9]{8})[-+]?[0-9]{4}$\",\n \"examples\": [\n \"19121212-1212\", \"121212-1212\",\n \"19121212+1212\", \"121212+1212\",\n \"191212121212\", \"1212121212\"\n ] \n },\n \"time\": {\n \"$id\": \"#/definitions/time\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^[01][0-9]|2[0-3]:[0-5][0-9]$\",\n \"examples\": [\n \"19:25\"\n ] \n },\n \"hsaId\": {\n \"$id\": \"#/definitions/hsaId\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^SE[0-9]{10}-[0-9A-Za-z]+$\",\n \"examples\": [\n \"SE2321000131-007643n\"\n ]\n },\n \"properName\": {\n \"$id\": \"#/definitions/properName\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^[A-ZÅÄÖ][a-zåäöA-ZÅÄÖ \\\\-_.]+$\",\n \"examples\": [\n \"Joe\", \"Jean-Pierre\"\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}"}],"_postman_id":"3cf2e24e-19ba-4f21-8211-cdacbb73fb42"},{"name":"Booking Types","event":[{"listen":"test","script":{"id":"198fad23-725b-48c5-bbb8-b423c237d35b","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"6509c7cc-772c-4766-8c63-2176c073acbe","exec":[""],"type":"text/javascript"}}],"id":"67acc158-8bc9-4bb3-bb6d-eedd8a27b6bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/v1/bookingTypes","description":"

Available as of Webdoc 6.21

\n

List all booking types used in booking.

\n

Allowed with one of the following scopes:

\n
    \n
  • self-service
    • \n
  • bookings:read
    • \n
  • bookings:write
    • \n
\n","urlObject":{"path":["v1","bookingTypes"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"82bc65bc-a8bf-441e-aa71-32251b7e02c3","name":"Booking Types","originalRequest":{"method":"GET","header":[],"url":"{{url}}/v1/bookingTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 04 Dec 2020 10:16:33 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.6"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"4148"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"1\",\n \"name\": \"Booking\",\n \"externallyVisibleName\": \"Booking\",\n \"backgroundColor\": \"#ffffff\",\n \"textColor\": \"#000000\",\n \"hasSelfService\": false,\n \"recordType\": {\n \"latestId\": 123,\n \"name\": \"Checkup Template\"\n },\n \"actionCode\": null,\n \"priceLevels\": []\n },\n {\n \"id\": \"2\",\n \"name\": \"Online\",\n \"externallyVisibleName\": \"Online Booking\",\n \"backgroundColor\": \"#ffffff\",\n \"textColor\": \"#000000\",\n \"hasSelfService\": true,\n \"recordType\": null,\n \"actionCode\": {\n \"id\": 234,\n \"name\": \"Checkup\"\n },\n \"priceLevels\": [\n {\n \"id\": 50,\n \"name\": \"Doctor\",\n \"priceListed\": 100.0,\n \"priceUnlisted\": 150.0,\n \"priceNormal\": 100.0,\n \"priceReduced\": 50.0\n }\n ]\n },\n {\n \"id\": 3,\n \"name\": \"Dropin\",\n \"externallyVisibleName\": \"Drop in\",\n \"backgroundColor\": \"#ffffff\",\n \"textColor\": \"#000000\",\n \"hasSelfService\": false,\n \"recordType\": {\n \"latestId\": 345,\n \"name\": \"Checkup Template\"\n },\n \"actionCode\": {\n \"id\": 4,\n \"name\": \"Checkup\"\n },\n \"priceLevels\": [\n {\n \"id\": 5,\n \"name\": \"Specialist\",\n \"priceListed\": 100.0,\n \"priceUnlisted\": 150.0,\n \"priceNormal\": 100.0,\n \"priceReduced\": 100.0\n },\n {\n \"id\": 6,\n \"name\": \"Nurse\",\n \"priceListed\": 50.0,\n \"priceUnlisted\": 10.0,\n \"priceNormal\": 0.0,\n \"priceReduced\": 0.0\n }\n ]\n }\n]"},{"id":"64d541b1-9cc5-4164-826d-ae205ccd424b","name":"JSON Schema","originalRequest":{"method":"GET","header":[{"key":"JSON_Schema","value":"true"}],"url":"{{url}}/v1/bookingTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 06 Dec 2022 18:23:45 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.13"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"4148"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Booking types\",\n \"items\": {\n \"title\": \"Booking type\",\n \"required\": [\n \"id\",\n \"name\",\n \"externallyVisibleName\",\n \"backgroundColor\",\n \"textColor\",\n \"hasSelfService\",\n \"recordType\",\n \"actionCode\",\n \"priceLevels\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Booking type Id\",\n \"default\": \"\",\n \"pattern\": \"^[0-9]+$\",\n \"examples\": [\n \"12\"\n ],\n \"$id\": \"#/properties/id\",\n \"type\": \"string\"\n },\n \"name\": {\n \"title\": \"Booking type name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Fest\"\n ],\n \"$id\": \"#/properties/name\",\n \"type\": \"string\"\n },\n \"externallyVisibleName\": {\n \"title\": \"Booking type display name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Fest\"\n ],\n \"$id\": \"#/properties/externallyVisibleName\",\n \"type\": \"string\"\n },\n \"backgroundColor\": {\n \"title\": \"Background color\",\n \"$ref\": \"#/definitions/color\",\n \"$id\": \"#/properties/backgroundColor\"\n },\n \"textColor\": {\n \"title\": \"Text color\",\n \"$ref\": \"#/definitions/color\",\n \"$id\": \"#/properties/textColor\"\n },\n \"hasSelfService\": {\n \"title\": \"Does booking type have self service activated\",\n \"default\": false,\n \"examples\": [\n true\n ],\n \"$id\": \"#/properties/hasSelfService\",\n \"type\": \"boolean\"\n },\n \"recordType\": {\n \"title\": \"Record type\",\n \"required\": [\n \"latestId\",\n \"name\"\n ],\n \"properties\": {\n \"latestId\": {\n \"title\": \"Record type Id\",\n \"default\": 0,\n \"examples\": [\n 128\n ],\n \"$id\": \"#/properties/recordType/properties/latestId\",\n \"type\": \"integer\"\n },\n \"name\": {\n \"title\": \"Record type name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Checkup visit\"\n ],\n \"$id\": \"#/properties/recordType/properties/name\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/properties/recordType\",\n \"type\": [\"object\", \"null\"]\n },\n \"actionCode\": {\n \"title\": \"Action code\",\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Action code Id\",\n \"default\": 0,\n \"examples\": [\n 1\n ],\n \"$id\": \"#/properties/actionCode/properties/id\",\n \"type\": \"integer\"\n },\n \"name\": {\n \"title\": \"Action code name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"New visit\"\n ],\n \"$id\": \"#/properties/actionCode/properties/name\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/properties/actionCode\",\n \"type\": [\"object\", \"null\"]\n },\n \"priceLevels\": {\n \"title\": \"Price levels\",\n \"items\": {\n \"title\": \"Price level\",\n \"required\": [\n \"id\",\n \"name\",\n \"priceListed\",\n \"priceUnlisted\",\n \"priceNormal\",\n \"priceReduced\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Price level Id\",\n \"default\": 0,\n \"examples\": [\n 1\n ],\n \"$id\": \"#/properties/priceLevels/items/properties/id\",\n \"type\": \"integer\"\n },\n \"name\": {\n \"title\": \"Price level name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Doctor\"\n ],\n \"$id\": \"#/properties/priceLevels/items/properties/name\",\n \"type\": \"string\"\n },\n \"priceListed\": {\n \"title\": \"Price for listed patients\",\n \"default\": 0,\n \"examples\": [\n 0\n ],\n \"$id\": \"#/properties/priceLevels/items/properties/priceListed\",\n \"type\": \"number\"\n },\n \"priceUnlisted\": {\n \"title\": \"Price for unlisted patients\",\n \"default\": 0,\n \"examples\": [\n 0\n ],\n \"$id\": \"#/properties/priceLevels/items/properties/priceUnlisted\",\n \"type\": \"number\"\n },\n \"priceNormal\": {\n \"title\": \"Normal price\",\n \"default\": 0,\n \"examples\": [\n 0\n ],\n \"$id\": \"#/properties/priceLevels/items/properties/priceNormal\",\n \"type\": \"number\"\n },\n \"priceReduced\": {\n \"title\": \"Reduced price\",\n \"default\": 0,\n \"examples\": [\n 0\n ],\n \"$id\": \"#/properties/priceLevels/items/properties/priceReduced\",\n \"type\": \"number\"\n }\n },\n \"$id\": \"#/properties/priceLevels/items\",\n \"type\": \"object\"\n },\n \"$id\": \"#/properties/priceLevels\",\n \"type\": \"array\"\n }\n },\n \"$id\": \"#/items\",\n \"type\": \"object\"\n },\n \"definitions\": {\n \"color\": {\n \"default\": \"\",\n \"pattern\": \"^#([0-9a-fA-F]{3})|([0-9a-fA-F]{6})$\",\n \"examples\": [\n \"#ffffff\", \"#adc\", \"123F0F\"\n ],\n \"$id\": \"#/definitions/color\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"http://webdoc.api/response/bookings/v1/get/booking_types\",\n \"type\": \"array\",\n \"$schema\": \"http://json-schema.org/draft-07/schema\"\n}"}],"_postman_id":"67acc158-8bc9-4bb3-bb6d-eedd8a27b6bb"},{"name":"Bookings","id":"113d7a3f-2d11-4fe3-ab82-5c7bb15290c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"5fa6b98d-b98a-4381-b691-14ba96a3aeb7\",\n \"clinicId\": \"481c97c5-0bd7-4aff-aca2-71ce9003b613\",\n \"patientId\": \"20ff56fb-08b1-4e0c-a8b0-3561da10b309\",\n \"bookingTypeId\": 123,\n \"patientTypeId\": 234,\n \"injuryNumber\": \"123456-7890\",\n \"date\": \"2024-11-06\",\n \"startTime\": \"13:10\",\n \"endTime\": \"14:10\",\n \"note\": \"Example booking note.\",\n \"fee\": 100,\n \"smsReminder\": true,\n \"smsConfirmation\": true,\n \"actionCodes\": [\n 1,\n 3\n ],\n \"allowOverlap\": false,\n \"reservedForOrganizationId\": 50,\n \"reservedForDepartmentId\": 65\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/bookings","description":"

Available as of Webdoc 6.22

\n

This endpoint can be called to create a booking - with or without a patient.

\n

Available post parameters (bold are required):

\n
  • userId
    (The user ID in UUID format of the caregiver that creates the booking.)
  • clinicId
    (The clinic ID for the clinic where the booking is applied.)
  • bookingTypeId
    (The bookingTypeId can refer to e.g. an online booking, revisit, self service, etc.)
  • date
    (Bookings date in the format of YYYY-MM-DD. Timezone: 'CET'.)
  • startTime
    (The start time of the booking in the format H:i.)
  • endTime
    (The end time of the booking in the format H:i.)
  • actionCodes
    (The action codes specify whether the booking concerns e.g. a new visit, a vaccination, a surgery, etc. Available action codes can be fetched via endpoint GET Action Codes.)
  • patientId
    (The user ID of the patient in UUID format.)
  • allowOverlap (true | false)
    (Control whether creating an overlapping bookings with an existing one is allowed. Default is true)
  • reservedForOrganizationId / reservedForDepartmentId
    (Can be used to reserve a booking to a specific organization or department, allowing only patients belonging to the reserved organization / department to be booked. When reserving a booking to a department, a reserved organization must already be present on the booking or supplied with the request.)
\n\n

The following request parameters are only processed if a patientId is set in the request:

\n
  • patientTypeId
    (The patientTypeId specifies whether the patient visit is linked to a care agreement, insurance company or if it is private. When using patientTypeId \"1\" which refers to \"Private\", the fee will be automatically calculated based on specified action codes. In other words, a fee cannot be manually set with patientTypeId \"Private\".)
  • note
    (The note attached to the booking.)
  • fee
    (A fee can only be specified in the request if a patientTypeId is linked to a care agreement or insurance company.)
  • smsConfirmation (true | false)
    (Given that patientId is also specified in the request corresponding to a patient having SMS consent, this enables to send a booking confirmation text message to the patient's mobile number if set to true. Default is false.)
  • smsReminder (true | false)
    (Given that patientId is also specified in the request corresponding to a patient having SMS consent, this enables to send a booking reminder text message to the patient's mobile number if set to true. Default is false.)
  • injuryNumber
    (The injury number refers to a specific injury issue for a patient, which can then be used to cover costs by an insurance company. Note! The injury number is only processed if the patient type of the booking is not related to a care agreement.)

\n\n

Allowed with the following scope:

\n
    \n
  • bookings:write
    • \n
\n","urlObject":{"path":["v1","bookings"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"903a9f8e-c29a-49d2-9da5-a1c80a416890","name":"Bookings","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"5fa6b98d-b98a-4381-b691-14ba96a3aeb7\",\n \"clinicId\": \"481c97c5-0bd7-4aff-aca2-71ce9003b613\",\n \"patientId\": \"d1ea387c-e0cf-494c-aef3-7f6ee14ffb7f\",\n \"bookingTypeId\": 7,\n \"patientTypeId\": 1,\n \"injuryNumber\": \"123456-7890\",\n \"date\": \"2024-11-06\",\n \"startTime\": \"11:20\",\n \"endTime\": \"11:50\",\n \"note\": \"Example note on booking\",\n \"fee\": 100,\n \"smsConfirmation\": true,\n \"actionCodes\": [\n 1,\n 3\n ],\n \"allowOverlap\": true,\n \"reservedForOrganizationId\": 50,\n \"reservedForDepartmentId\": 65\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/bookings"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 08 Feb 2022 17:05:04 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.10"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"797"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"873ab456-097c-12fd-aaab-98365cb3400f\",\n \"date\": \"2024-11-06\",\n \"startTime\": \"11:20\",\n \"endTime\": \"11:50\",\n \"reservedForOrganizationId\": 50,\n \"reservedForDepartmentId\": 65,\n \"note\": \"Example note on booking\",\n \"smsReminder\": false,\n \"injuryNumber\": \"123456-7890\",\n \"caregiver\": {\n \"id\": \"6222731b-acdc-4fa2-8500-3022fd0eeea3\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"hsaId\": \"SE1234567890-123n\"\n },\n \"actionCodes\": [\n {\n \"id\": \"1\",\n \"codeName\": \"New visit\"\n },\n {\n \"id\": \"3\",\n \"codeName\": \"Vaccination\"\n }\n ],\n \"bookingType\": {\n \"id\": \"5e12675f-c9a5-46bb-9500-2075b182d0ff\",\n \"name\": \"Booking\"\n },\n \"clinic\": {\n \"id\": \"873ab456-097c-12fd-aaab-98365cb34009\",\n \"name\": \"Clinic 1\",\n \"hsaId\": \"SE1234567890-123m\",\n \"invoiceInfo\": {\n \"companyName\": \"Test Company\"\n }\n },\n \"patient\": {\n \"id\": \"795b22ef-63de-4c5e-8021-5016f0851e9a\",\n \"firstName\": \"Joe\",\n \"lastName\": \"Doe\"\n },\n \"patientType\": {\n \"id\": \"1\",\n \"name\": \"Private\"\n }\n}"},{"id":"d0ccae62-7e59-4a8a-baf4-7fcd0e2288b2","name":"Bookings - Clinic not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"b6b3df5a-7363-44a0-8e33-0f91b5585de8\",\n \"patientId\": \"20ff56fb-08b1-4e0c-a8b0-3561da10b309\",\n \"bookingTypeId\": 123,\n \"patientTypeId\": 234,\n \"date\": \"2020-12-24\",\n \"startTime\": \"12:10\",\n \"endTime\": \"13:10\",\n \"note\": \"Example note on booking\",\n \"fee\": 100,\n \"smsConfirmation\": true,\n \"smsReminder\": true,\n \"actionCodes\": [\n 1,\n 3\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/bookings"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1005,\n \"message\": \"Clinic not found\"\n }\n}"},{"id":"a74badb3-117f-4c79-a328-3a4127ad1282","name":"JSON Schema","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":" Bearer ###########################3"},{"key":"Content-Type","value":" application/json"},{"key":"User-Agent","value":" PostmanRuntime/v.vv.v"},{"key":"Accept","value":" */*"},{"key":"Host","value":" -------.atlan.se"},{"key":"Accept-Encoding","value":" gzip, deflate, br"},{"key":"Connection","value":" keep-alive"},{"key":"Content-Length","value":" ####"},{"key":"Cookie","value":" "},{"key":"JSON_Schema","value":"true"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Booking request\",\n \"required\": [\n \"userId\",\n \"clinicId\",\n \"patientId\",\n \"bookingTypeId\",\n \"patientTypeId\",\n \"date\",\n \"startTime\",\n \"endTime\",\n \"note\",\n \"fee\",\n \"smsConfirmation\",\n \"smsReminder\",\n \"actionCodes\",\n \"allowOverlap\",\n \"reservedForOrganizationId\",\n \"reservedForDepartmentId\"\n ],\n \"properties\": {\n \"userId\": {\n \"title\": \"User Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/properties/userId\"\n },\n \"clinicId\": {\n \"title\": \"Clinic Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/properties/clinicId\"\n },\n \"patientId\": {\n \"title\": \"Patient Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/properties/patientId\"\n },\n \"bookingTypeId\": {\n \"title\": \"Booking type Id\",\n \"default\": 0,\n \"pattern\": \"^[0-9]*$\",\n \"examples\": [\n \"12\"\n ],\n \"$id\": \"#/properties/bookingTypeId\",\n \"type\": \"string\"\n },\n \"patientTypeId\": {\n \"title\": \"Patient type Id\",\n \"default\": 0,\n \"pattern\": \"^[0-9]*$\",\n \"examples\": [\n 2\n ],\n \"$id\": \"#/properties/patientTypeId\",\n \"type\": \"integer\"\n },\n \"date\": {\n \"title\": \"Booking date\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"2021-06-17\"\n ],\n \"$id\": \"#/properties/date\",\n \"type\": \"string\"\n },\n \"startTime\": {\n \"title\": \"Booking start time\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"12:10\"\n ],\n \"$id\": \"#/properties/startTime\",\n \"type\": \"string\"\n },\n \"endTime\": {\n \"title\": \"Booking end time\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"13:10\"\n ],\n \"$id\": \"#/properties/endTime\",\n \"type\": \"string\"\n },\n \"note\": {\n \"title\": \"Booking note\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Example note on booking\"\n ],\n \"$id\": \"#/properties/note\",\n \"type\": \"string\"\n },\n \"fee\": {\n \"title\": \"Fees\",\n \"default\": 0,\n \"examples\": [\n 0\n ],\n \"$id\": \"#/properties/fee\",\n \"type\": \"integer\"\n },\n \"smsConfirmation\": {\n \"title\": \"SMS confirmation\",\n \"default\": false,\n \"examples\": [\n false, true\n ],\n \"$id\": \"#/properties/smsConfirmation\",\n \"type\": \"boolean\"\n },\n \"smsReminder\": {\n \"title\": \"SMS reminder\",\n \"default\": false,\n \"examples\": [\n false, true\n ],\n \"$id\": \"#/properties/smsReminder\",\n \"type\": \"boolean\"\n },\n \"actionCodes\": {\n \"title\": \"Action codes\",\n \"items\": {\n \"title\": \"Action code Id\",\n \"default\": 0,\n \"examples\": [\n 1\n ],\n \"$id\": \"#/properties/actionCodes/items\",\n \"type\": \"integer\"\n },\n \"$id\": \"#/properties/actionCodes\",\n \"type\": \"array\"\n },\n \"allowOverlap\": {\n \"title\": \"Allow booking overlap\",\n \"default\": false,\n \"examples\": [\n true\n ],\n \"$id\": \"#/properties/allowOverlap\",\n \"type\": \"boolean\"\n },\n \"reservedForOrganizationId\": {\n \"title\": \"Reserved for organization id\",\n \"default\": 0,\n \"examples\": [\n 51\n ],\n \"$id\": \"#/properties/reservedForOrganizationId\",\n \"type\": \"integer\"\n },\n \"reservedForDepartmentId\": {\n \"title\": \"Reserved for department Id\",\n \"default\": 0,\n \"examples\": [\n 205\n ],\n \"$id\": \"#/properties/reservedForDepartmentId\",\n \"type\": \"integer\"\n },\n \"injuryNumber\": {\n \"title\": \"Injury number of a patient booking\",\n \"default\": null,\n \"examples\": [\n \"123456-7890\"\n ],\n \"$id\": \"#/properties/injuryNumber\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"http://webdoc.api/request/bookings/v1/post/bookings\",\n \"type\": \"object\",\n \"definitions\": {\n \"uuid\": {\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"default\": \"\",\n \"examples\": [\n \"ee4d906f-2eca-4345-9907-a4c6c2fcd931\"\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/bookings","host":["{{url}}"],"path":["v1","bookings"],"query":[{"key":"","value":"","disabled":true}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 08 Dec 2022 19:47:26 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.13"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"792"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Booking response\",\n \"required\": [\n \"id\",\n \"date\",\n \"startTime\",\n \"endTime\",\n \"reservedForOrganizationId\",\n \"reservedForDepartmentId\",\n \"note\",\n \"injuryNumber\",\n \"smsReminder\",\n \"caregiver\",\n \"actionCodes\",\n \"bookingType\",\n \"clinic\",\n \"patient\",\n \"patientType\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Booking Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/properties/id\"\n },\n \"startTime\": {\n \"title\": \"Booking start time; timestamp\",\n \"default\": 0,\n \"examples\": [\n 1623924600\n ],\n \"$id\": \"#/properties/startTime\",\n \"type\": \"integer\"\n },\n \"endTime\": {\n \"title\": \"Booking end time; timestamp\",\n \"default\": 0,\n \"examples\": [\n 1623928200\n ],\n \"$id\": \"#/properties/endTime\",\n \"type\": \"integer\"\n },\n \"reservedForOrganizationId\": {\n \"title\": \"Reserved for organization Id\",\n \"default\": \"\",\n \"pattern\": \"^[0-9]+$\",\n \"examples\": [\n \"51\"\n ],\n \"$id\": \"#/properties/reservedForOrganizationId\",\n \"type\": \"string\"\n },\n \"reservedForDepartmentId\": {\n \"title\": \"Reserved for department Id\",\n \"default\": \"\",\n \"pattern\": \"^[0-9]+$\",\n \"examples\": [\n \"205\"\n ],\n \"$id\": \"#/properties/reservedForDepartmentId\",\n \"type\": \"string\"\n },\n \"note\": {\n \"title\": \"Booking note\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Example note on booking\"\n ],\n \"$id\": \"#/properties/note\",\n \"type\": \"string\"\n },\n \"smsReminder\": {\n \"title\": \"Send an SMS to remind the patient\",\n \"default\": false,\n \"examples\": [\n false\n ],\n \"$id\": \"#/properties/smsReminder\",\n \"type\": \"boolean\"\n },\n \"injuryNumber\": {\n \"title\": \"Injury number of a patient booking\",\n \"default\": null,\n \"examples\": [\n \"123456-7890\"\n ],\n \"$id\": \"#/properties/injuryNumber\",\n \"type\": \"string\"\n },\n \"caregiver\": {\n \"title\": \"The caregiver\",\n \"required\": [\n \"id\",\n \"firstName\",\n \"lastName\",\n \"hsaId\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"The caregiver's Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/properties/caregiver/properties/id\"\n },\n \"firstName\": {\n \"title\": \"The caregiver's first name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Joe\"\n ],\n \"$id\": \"#/properties/caregiver/properties/firstName\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"title\": \"The caregiver's last name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Doe\"\n ],\n \"$id\": \"#/properties/caregiver/properties/lastName\",\n \"type\": \"string\"\n },\n \"hsaId\": {\n \"title\": \"The caregiver's HSA Id\",\n \"$ref\": \"#/definitions/hsaId\",\n \"$id\": \"#/properties/caregiver/properties/hsaId\"\n }\n },\n \"$id\": \"#/properties/caregiver\",\n \"type\": \"object\"\n },\n \"actionCodes\": {\n \"title\": \"Action codes\",\n \"items\": {\n \"title\": \"Action code\",\n \"required\": [\n \"id\",\n \"codeName\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Action code Id\",\n \"default\": \"\",\n \"pattern\": \"^[0-9]+$\",\n \"examples\": [\n \"1\"\n ],\n \"$id\": \"#/properties/actionCodes/items/properties/id\",\n \"type\": \"string\"\n },\n \"codeName\": {\n \"title\": \"Action code name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Nybesök\"\n ],\n \"$id\": \"#/properties/actionCodes/items/properties/codeName\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/properties/actionCodes/items\",\n \"type\": \"object\"\n },\n \"$id\": \"#/properties/actionCodes\",\n \"type\": \"array\"\n },\n \"bookingType\": {\n \"title\": \"Booking type\",\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Booking type Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/properties/bookingType/properties/id\"\n },\n \"name\": {\n \"title\": \"Booking type name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Fest\"\n ],\n \"$id\": \"#/properties/bookingType/properties/name\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/properties/bookingType\",\n \"type\": \"object\"\n },\n \"clinic\": {\n \"title\": \"Clinic\",\n \"required\": [\n \"id\",\n \"name\",\n \"hsaId\",\n \"invoiceInfo\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Clinic Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/properties/clinic/properties/id\"\n },\n \"name\": {\n \"title\": \"Clinic name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"WebDoc nr1\"\n ],\n \"$id\": \"#/properties/clinic/properties/name\",\n \"type\": \"string\"\n },\n \"hsaId\": {\n \"title\": \"Clinic HSA Id\",\n \"$ref\": \"#/definitions/hsaId\",\n \"$id\": \"#/properties/clinic/properties/hsaId\"\n },\n \"invoiceInfo\": {\n \"title\": \"Invoice info\",\n \"required\": [\n \"companyName\"\n ],\n \"properties\": {\n \"companyName\": {\n \"title\": \"Company name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"WebDoc Test \"\n ],\n \"$id\": \"#/properties/clinic/properties/invoiceInfo/properties/companyName\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/properties/clinic/properties/invoiceInfo\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"#/properties/clinic\",\n \"type\": \"object\"\n },\n \"patient\": {\n \"title\": \"Patient\",\n \"required\": [\n \"id\",\n \"firstName\",\n \"lastName\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Patient Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/properties/patient/properties/id\"\n },\n \"firstName\": {\n \"title\": \"Patient's first name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Tolvan\"\n ],\n \"$id\": \"#/properties/patient/properties/firstName\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"title\": \"Patient's last name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Tolvansson\"\n ],\n \"$id\": \"#/properties/patient/properties/lastName\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/properties/patient\",\n \"type\": \"object\"\n },\n \"patientType\": {\n \"title\": \"Patient type (insurance)\",\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Patient type Id\",\n \"default\": \"\",\n \"pattern\": \"^[0-9]+$\",\n \"examples\": [\n \"2\"\n ],\n \"$id\": \"#/properties/patientType/properties/id\",\n \"type\": \"string\"\n },\n \"name\": {\n \"title\": \"Patient type name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"AON\"\n ],\n \"$id\": \"#/properties/patientType/properties/name\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/properties/patientType\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"http://webdoc.api/response/bookings/v1/post/bookings\",\n \"type\": \"object\",\n \"definitions\": {\n \"uuid\": {\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"default\": \"\",\n \"examples\": [\n \"ee4d906f-2eca-4345-9907-a4c6c2fcd931\"\n ]\n },\n \"hsaId\": {\n \"$id\": \"#/definitions/hsaId\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^SE[0-9]{10}-[0-9A-Za-z]+$\",\n \"examples\": [\n \"SE2321000131-007643n\"\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema\"\n}"}],"_postman_id":"113d7a3f-2d11-4fe3-ab82-5c7bb15290c6"},{"name":"Bookings","id":"272cbb67-cd43-4d44-a7ae-98392a2e4817","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"requestedByUserId\": \"1a612f7f-9e14-46dd-8947-80964fc5ff52\",\n \"bookingTypeId\": 10,\n \"caregiver\": {\n \"id\": \"03d19b7d-23b0-4047-bf55-79ba8578da7f\"\n },\n \"reservedForOrganizationId\": 50,\n \"reservedForDepartmentId\": 65,\n \"patientId\": \"d0d27203-8b14-41fd-a332-12c7d6a742d1\",\n \"date\": \"2024-11-22\",\n \"startTime\": \"10:00\",\n \"endTime\": \"11:00\",\n \"note\": \"A booking note.\",\n \"injuryNumber\": \"123456-7890\",\n \"actionCodes\": [\n 1,\n 3\n ],\n \"fee\": 299\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/bookings/:bookingId","description":"

Available as of Webdoc 6.26

\n

This endpoint can be called to update a booking by booking/unbooking a patient to it, and/or updating its related booking type.

\n

N.B. Applicable to all bookings except for the ones with booking types \"BokaDoktorn\" (bookingTypeId: 2).

\n

Available body parameters (bold are required):

\n
  • requestedByUserId
    (The UUID of the user performing the operation. Available users can be fetched via endpoint     GET Users.)
  • patientId
    (The UUID of the patient to book in the booking. If patientId is null, the patient will be removed from the booking. Available patients can be fetched via endpoint GET /v2/Patients.)
  • smsConfirmation (true | false)
    (Given that patientId is also specified in the request corresponding to the same patient in the booking having SMS consent, this enables to send a booking confirmation text message to the patient's mobile number if set to true. Default is false.)
  • smsReminder (true | false)
    (Given that patientId is also specified in the request corresponding to the same patient in the booking having SMS consent, this enables to send a booking reminder text message to the patient's mobile number if set to true. Default is false.)
  • bookingTypeId
    (The booking type ID of the booking. Available booking types can be fetched via endpoint GET Booking Types.)
  • note
    (A text note in the booking.)
  • date
    (The date to reschedule to. It cannot be a past date.)
  • startTime
    (The start time to reschedule to.)
  • endTime
    (The end of the booking time to reschedule to.)

  • reasonToRescheduleId (required and valid in some cases *)
    This is used in our availability reporting to VGR and SLL:

    • * Required and valid only when both:

      1. The booking is connected to VGR primary and specialist care or SLL primary care.
        and
      2. The booking is rescheduled till beyond the health care guarantee.

    • Available values:

      • VGR primary and rehab care

        • 1 = Delay caused by patient (PvV)
        • 2 = Delay caused by medical reason (MoV)

      • VGR specialist care

        • 1 = Delay caused by patient (PvV)
        • 2 = Delay caused by medical reason (MoV)
        • 3 = Delay caused by special reason (SoV)

      • SLL primary care

        • 1 = Delay caused by patient (PvV)
        • 2 = Delay caused by medical reason (MoV)
        • 3 = Delay caused by special reason (SoV)
        • 4 = Delay caused by appointment at another care clinic
        • 5 = Delay caused by the clinic
  • allowOverlap (true | false)
    (Used in conjunction with booking rescheduling: Control whether the new booking time may overlap an existing one. Default is true.)
  • reservedForOrganizationId / reservedForDepartmentId
    (Can be used to reserve a booking to a specific organization or department, allowing only patients belonging to the reserved organization / department to be booked. When reserving a booking to a department, a reserved organization must already be present on the booking or supplied in the request.)

  • caregiver:

    • id
      (The UUID of the caregiver that the booking should be rescheduled to. The new caregiver needs permission for both patient type and clinic used in the booking. Any action code restricted for the new caregiver will be removed from the booking. Available users can be fetched via endpoint GET Users.)
  • injuryNumber:
    (The injury number refers to a specific injury issue for a patient, which can then be used to cover costs by an insurance company. Note! The injury number is only processed if the patient type of the booking is not related to a care agreement.)
  • actionCodes
    (The action codes specify whether the booking concerns e.g. a new visit, a vaccination, a surgery, etc. The action codes you use in the request will always override previously saved ones in the booking. Moreover, if the action codes is set to \"null\", all previously saved ones will be removed from the booking - see request examples. Note! Action codes can only be saved for patient bookings. Available action codes can be fetched via endpoint GET Action Codes.)
  • fee
    (Given that patientId is also specified in the request, and its patient type is linked to a care agreement or insurance company)
  • patientTypeId
    (The patientTypeId specifies whether the patient visit is linked to a care agreement, insurance company or if it is private. When using patientTypeId \"1\" which refers to \"Private\", the fee will be automatically calculated based on specified action codes. In other words, a fee cannot be manually set with patientTypeId \"Private\".)

\n\n

Allowed with one of the following scopes:

\n
  • bookings:write
  • self-service
","urlObject":{"path":["v1","bookings",":bookingId"],"host":["{{url}}"],"query":[],"variable":[{"id":"9657fdc7-5102-4c68-9126-2c8e014e1680","description":{"content":"

Mandatory - The booking identifier (UUID). Available booking UUIDs can be fetched via endpoint GET Bookings.

\n","type":"text/plain"},"type":"any","value":"0d884efc-5ca0-4842-b1dd-17aad054a6a1","key":"bookingId"}]}},"response":[{"id":"5e497234-d94e-4908-afcb-543718bddff0","name":"Booking - add patient with action codes","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"patientId\": \"20ff56fb-08b1-4e0c-a8b0-3561da10b309\",\n \"requestedByUserId\": \"1a612f7f-9e14-46dd-8947-80964fc5ff52\",\n \"actionCodes\": [\n 1,\n 3\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/bookings/:bookingId","host":["{{url}}"],"path":["v1","bookings",":bookingId"],"variable":[{"key":"bookingId","value":"0c6281bb-c454-4232-a41b-3879e88dfff0","description":"The booking identifier (UUID)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 23 Feb 2021 14:16:27 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.7"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"33"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"0c6281bb-c454-4232-a41b-3879e88dfff0\",\n \"clinicId\": \"be895cd3-bbf9-4ac9-83c4-9fa993034966\",\n \"date\": \"2020-06-05\",\n \"startTime\": \"10:00\",\n \"endTime\": \"10:20\",\n \"arrived\": 0,\n \"actionCodes\": [\n {\n \"id\": \"1\",\n \"codeName\": \"Visit\"\n },\n {\n \"id\": \"3\",\n \"codeName\": \"Vaccination\"\n }\n ],\n \"bookingDescription\": \"Test description\",\n \"bookingType\": \"Online\",\n \"bookedPatientType\": \"Private\",\n \"injuryNumber\": \"\",\n \"payments\": [\n {\n \"price\": 200,\n \"amount\": 1,\n \"comment\": \"Example comment\",\n \"account\": \"3010\",\n \"VATPercentage\": 25,\n \"VAT\": 50,\n \"expiryDate\": \"2020-08-05\",\n \"freeByFreeCard\": false,\n \"reducedByFreeCard\": false,\n \"articleName\": \"Action code name\"\n }\n ],\n \"patient\": {\n \"isListed\": false,\n \"personalNumber\": \"19121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Insurance Company\",\n \"address\": {\n \"streetName\": \"Test Street 123\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\"\n },\n \"mobilePhone\": \"+46701740635\",\n \"listing\": {\n \"hsaId\": \"SE1234567891-E000000001236\",\n \"countyName\": \"Test county\"\n },\n \"freeCard\": []\n },\n \"caregiver\": {\n \"id\": \"b6b3df5a-7363-44a0-8e33-0f91b5585de8\",\n \"title\": \"Doctor\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19121212-1212\"\n }\n}"},{"id":"b476b54e-3862-42d4-a8d7-ed3d99996038","name":"Booking - add patient with fee and patient type","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"patientId\": \"20ff56fb-08b1-4e0c-a8b0-3561da10b309\",\n \"requestedByUserId\": \"1a612f7f-9e14-46dd-8947-80964fc5ff52\",\n \"fee\": 123,\n \"patientTypeId\": 11,\n \"note\": \"Example where patient type 11 is a insurance company, i.e. fee can be added\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/bookings/:bookingId","host":["{{url}}"],"path":["v1","bookings",":bookingId"],"variable":[{"key":"bookingId","value":"0c6281bb-c454-4232-a41b-3879e88dfff0","description":"The booking identifier (UUID)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 23 Feb 2021 14:16:27 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.7"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"33"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"0c6281bb-c454-4232-a41b-3879e88dfff0\",\n \"clinicId\": \"be895cd3-bbf9-4ac9-83c4-9fa993034966\",\n \"date\": \"2020-06-05\",\n \"startTime\": \"10:00\",\n \"endTime\": \"10:20\",\n \"arrived\": 0,\n \"actionCodes\": [],\n \"bookingDescription\": \"Example where patient type 11 is a insurance company, i.e. fee can be added\",\n \"bookingType\": \"Online\",\n \"bookedPatientType\": \"Insurance Company\",\n \"injuryNumber\": \"\",\n \"payments\": [\n {\n \"price\": \"123\",\n \"amount\": 1,\n \"comment\": \"\",\n \"account\": \"3010\",\n \"VATPercentage\": 0,\n \"VAT\": 0,\n \"expiryDate\": \"2025-06-13\",\n \"articleName\": \"Självrisk\"\n }\n ],\n \"patient\": {\n \"isListed\": false,\n \"personalNumber\": \"19121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Private\",\n \"address\": {\n \"streetName\": \"Test Street 123\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\"\n },\n \"mobilePhone\": \"+46701740635\",\n \"listing\": {\n \"hsaId\": \"SE1234567891-E000000001236\",\n \"countyName\": \"Test county\"\n },\n \"freeCard\": []\n },\n \"caregiver\": {\n \"id\": \"1a612f7f-9e14-46dd-8947-80964fc5ff52\",\n \"title\": \"Doctor\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19121212-1212\"\n }\n}"},{"id":"552d7893-6aba-4866-9d4a-d4f49794b320","name":"Booking - remove patient","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"patientId\": null,\n \"requestedByUserId\": \"1a612f7f-9e14-46dd-8947-80964fc5ff52\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/bookings/:bookingId","host":["{{url}}"],"path":["v1","bookings",":bookingId"],"variable":[{"key":"bookingId","value":"0c6281bb-c454-4232-a41b-3879e88dfff0","description":"The booking identifier (UUID)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 23 Feb 2021 14:17:47 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.7"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"27"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"0c6281bb-c454-4232-a41b-3879e88dfff0\",\n \"clinicId\": \"be895cd3-bbf9-4ac9-83c4-9fa993034966\",\n \"date\": \"2020-06-05\",\n \"startTime\": \"10:00\",\n \"endTime\": \"10:20\",\n \"arrived\": 0,\n \"actionCodes\": [],\n \"bookingDescription\": \"\",\n \"bookingType\": \"Online\",\n \"bookedPatientType\": \"\",\n \"injuryNumber\": \"\",\n \"payments\": [],\n \"patient\": null,\n \"caregiver\": {\n \"id\": \"b6b3df5a-7363-44a0-8e33-0f91b5585de8\",\n \"title\": \"Doctor\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19121212-1212\"\n }\n}"},{"id":"a77e9c1d-eb35-4090-b90c-ffcb18ee71f3","name":"Booking - update booking type without patient","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"requestedByUserId\": \"1a612f7f-9e14-46dd-8947-80964fc5ff52\",\n \"bookingTypeId\": 11\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/bookings/:bookingId","host":["{{url}}"],"path":["v1","bookings",":bookingId"],"variable":[{"key":"bookingId","value":"0c6281bb-c454-4232-a41b-3879e88dfff0","description":"The booking identifier (UUID)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 17 May 2021 06:45:52 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.7"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"60"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"0c6281bb-c454-4232-a41b-3879e88dfff0\",\n \"clinicId\": \"be895cd3-bbf9-4ac9-83c4-9fa993034966\",\n \"date\": \"2021-05-12\",\n \"startTime\": \"10:00\",\n \"endTime\": \"11:00\",\n \"arrived\": 0,\n \"actionCodes\": [],\n \"bookingDescription\": \"\",\n \"bookingType\": \"Revisit\",\n \"bookedPatientType\": \"\",\n \"injuryNumber\": \"\",\n \"payments\": [],\n \"patient\": null,\n \"caregiver\": {\n \"id\": \"b6b3df5a-7363-44a0-8e33-0f91b5585de8\",\n \"title\": \"Doctor\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19121212-1212\"\n }\n}"},{"id":"5b4aa3b8-5713-4b72-a00a-835a307f9520","name":"Booking - update booking type with patient","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"patientId\": \"20ff56fb-08b1-4e0c-a8b0-3561da10b309\",\n \"requestedByUserId\": \"1a612f7f-9e14-46dd-8947-80964fc5ff52\",\n \"bookingTypeId\": 11,\n \"smsReminder\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/bookings/:bookingId","host":["{{url}}"],"path":["v1","bookings",":bookingId"],"variable":[{"key":"bookingId","value":"0c6281bb-c454-4232-a41b-3879e88dfff0","description":"The booking identifier (UUID)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 23 Feb 2021 14:16:27 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.7"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"33"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"0c6281bb-c454-4232-a41b-3879e88dfff0\",\n \"clinicId\": \"be895cd3-bbf9-4ac9-83c4-9fa993034966\",\n \"date\": \"2021-05-12\",\n \"startTime\": \"10:00\",\n \"endTime\": \"11:00\",\n \"arrived\": 0,\n \"actionCodes\": [\n {\n \"id\": \"2\",\n \"codeName\": \"Revisit\"\n },\n {\n \"id\": \"5\",\n \"codeName\": \"Surgery\"\n }\n ],\n \"bookingDescription\": \"Test description\",\n \"bookingType\": \"Revisit\",\n \"bookedPatientType\": \"Private\",\n \"injuryNumber\": \"\",\n \"payments\": [\n {\n \"price\": 200,\n \"amount\": 1,\n \"comment\": \"Example comment\",\n \"account\": \"3010\",\n \"VATPercentage\": 25,\n \"VAT\": 50,\n \"expiryDate\": \"2020-08-05\",\n \"freeByFreeCard\": false,\n \"reducedByFreeCard\": false,\n \"articleName\": \"Action code name\"\n }\n ],\n \"patient\": {\n \"isListed\": false,\n \"personalNumber\": \"19121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Insurance Company\",\n \"address\": {\n \"streetName\": \"Test Street 123\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\"\n },\n \"mobilePhone\": \"+46701740695\",\n \"listing\": {\n \"hsaId\": \"SE1234567891-E000000001236\",\n \"countyName\": \"Test county\"\n },\n \"freeCard\": []\n },\n \"caregiver\": {\n \"id\": \"b6b3df5a-7363-44a0-8e33-0f91b5585de8\",\n \"title\": \"Doctor\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19121212-1212\"\n }\n}"},{"id":"177b2f26-ff70-4931-b678-ef3b8acf7fcf","name":"Booking - reschedule a booking without a patient","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"date\": \"2121-05-18\",\n \"startTime\": \"13:00\",\n \"endTime\": \"13:55\",\n \"requestedByUserId\": \"1a612f7f-9e14-46dd-8947-80964fc5ff52\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/bookings/:bookingId","host":["{{url}}"],"path":["v1","bookings",":bookingId"],"variable":[{"key":"bookingId","value":"0c6281bb-c454-4232-a41b-3879e88dfff0","description":"Mandatory - The booking identifier (UUID). Available booking UUIDs can be fetched via endpoint GET CLinic Bookings.\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 17 May 2021 06:45:52 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.7"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"60"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"0c6281bb-c454-4232-a41b-3879e88dfff0\",\n \"clinicId\": \"be895cd3-bbf9-4ac9-83c4-9fa993034966\",\n \"date\": \"2121-05-18\",\n \"startTime\": \"13:00\",\n \"endTime\": \"13:55\",\n \"arrived\": 0,\n \"actionCodes\": [],\n \"bookingDescription\": \"\",\n \"bookingType\": \"Revisit\",\n \"bookedPatientType\": \"\",\n \"injuryNumber\": \"\",\n \"payments\": [],\n \"patient\": null,\n \"caregiver\": {\n \"id\": \"b6b3df5a-7363-44a0-8e33-0f91b5585de8\",\n \"title\": \"Doctor\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19121212-1212\"\n }\n}"},{"id":"8d2664f3-589e-4552-a623-009473eee5b1","name":"Booking - reschedule with a patient (No delay reason code required)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"date\": \"2121-05-18\",\n \"startTime\": \"12:00\",\n \"endTime\": \"12:15\",\n \"requestedByUserId\": \"1a612f7f-9e14-46dd-8947-80964fc5ff52\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/bookings/:bookingId","host":["{{url}}"],"path":["v1","bookings",":bookingId"],"variable":[{"key":"bookingId","value":"0c6281bb-c454-4232-a41b-3879e88dfff0","description":"Mandatory - The booking identifier (UUID). Available booking UUIDs can be fetched via endpoint GET CLinic Bookings.\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 17 May 2021 06:45:52 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.7"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"60"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"0c6281bb-c454-4232-a41b-3879e88dfff0\",\n \"clinicId\": \"be895cd3-bbf9-4ac9-83c4-9fa993034966\",\n \"date\": \"2121-05-18\",\n \"startTime\": \"12:00\",\n \"endTime\": \"12:15\",\n \"arrived\": 0,\n \"actionCodes\": [],\n \"bookingDescription\": \"Test description\",\n \"bookingType\": \"Revisit\",\n \"bookedPatientType\": \"Private\",\n \"injuryNumber\": \"\",\n \"payments\": [\n {\n \"price\": 200,\n \"amount\": 1,\n \"comment\": \"Example comment\",\n \"account\": \"3010\",\n \"VATPercentage\": 25,\n \"VAT\": 50,\n \"expiryDate\": \"2020-08-05\",\n \"freeByFreeCard\": false,\n \"reducedByFreeCard\": false,\n \"articleName\": \"Action code name\"\n }\n ],\n \"patient\": {\n \"isListed\": false,\n \"personalNumber\": \"19121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Insurance Company\",\n \"address\": {\n \"streetName\": \"Test Street 123\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\"\n },\n \"mobilePhone\": \"+46701740695\",\n \"listing\": {\n \"hsaId\": \"SE1234567891-E000000001236\",\n \"countyName\": \"Test county\"\n },\n \"freeCard\": []\n },\n \"caregiver\": {\n \"id\": \"b6b3df5a-7363-44a0-8e33-0f91b5585de8\",\n \"title\": \"Doctor\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19121212-1212\"\n }\n}"},{"id":"1168aca0-3a57-48a2-bc8f-d1f327a6bf9b","name":"Booking - reschedule with a patient (Delay reason code required)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"date\": \"2121-05-18\",\n \"startTime\": \"12:00\",\n \"endTime\": \"12:15\",\n \"reasonToRescheduleId\": \"3\",\n \"requestedByUserId\": \"1a612f7f-9e14-46dd-8947-80964fc5ff52\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/bookings/:bookingId","host":["{{url}}"],"path":["v1","bookings",":bookingId"],"variable":[{"key":"bookingId","value":"0c6281bb-c454-4232-a41b-3879e88dfff0","description":"Mandatory - The booking identifier (UUID). Available booking UUIDs can be fetched via endpoint GET CLinic Bookings.\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 17 May 2021 06:45:52 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.7"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"60"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"0c6281bb-c454-4232-a41b-3879e88dfff0\",\n \"clinicId\": \"be895cd3-bbf9-4ac9-83c4-9fa993034966\",\n \"date\": \"2121-05-18\",\n \"startTime\": \"12:00\",\n \"endTime\": \"12:15\",\n \"arrived\": 0,\n \"actionCodes\": [],\n \"bookingDescription\": \"Test description\",\n \"bookingType\": \"Revisit\",\n \"bookedPatientType\": \"Private\",\n \"injuryNumber\": \"\",\n \"payments\": [\n {\n \"price\": 200,\n \"amount\": 1,\n \"comment\": \"Example comment\",\n \"account\": \"3010\",\n \"VATPercentage\": 25,\n \"VAT\": 50,\n \"expiryDate\": \"2020-08-05\",\n \"freeByFreeCard\": false,\n \"reducedByFreeCard\": false,\n \"articleName\": \"Action code name\"\n }\n ],\n \"patient\": {\n \"isListed\": false,\n \"personalNumber\": \"19121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Insurance Company\",\n \"address\": {\n \"streetName\": \"Test Street 123\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\"\n },\n \"mobilePhone\": \"+46701740695\",\n \"listing\": {\n \"hsaId\": \"SE1234567891-E000000001236\",\n \"countyName\": \"Test county\"\n },\n \"freeCard\": []\n },\n \"caregiver\": {\n \"id\": \"b6b3df5a-7363-44a0-8e33-0f91b5585de8\",\n \"title\": \"Doctor\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19121212-1212\"\n }\n}"},{"id":"3a50bbc5-f633-421f-b451-a50ec7c7c317","name":"Booking - reschedule with a patient (Overlap not allowed)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"date\": \"2121-05-18\",\n \"startTime\": \"12:00\",\n \"endTime\": \"12:15\",\n \"allowOverlap\": false,\n \"reasonToRescheduleId\": \"3\",\n \"requestedByUserId\": \"1a612f7f-9e14-46dd-8947-80964fc5ff52\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/bookings/:bookingId","host":["{{url}}"],"path":["v1","bookings",":bookingId"],"variable":[{"key":"bookingId","value":"0c6281bb-c454-4232-a41b-3879e88dfff0","description":"Mandatory - The booking identifier (UUID). Available booking UUIDs can be fetched via endpoint GET CLinic Bookings.\n"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 17 May 2021 06:45:52 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.7"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"72"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 6200,\n \"message\": \"Overlapping bookings are not allowed\"\n }\n}"},{"id":"8334f547-0799-46ec-8ddb-024a2ca5c1c9","name":"Booking - failed rescheduled booking (Caregiver lacks permission for clinic)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"requestedByUserId\": \"1a612f7f-9e14-46dd-8947-80964fc5ff52\",\n \"caregiver\":{\n \"id\":\"03d19b7d-23b0-4047-bf55-79ba8578da7f\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/bookings/:bookingId","host":["{{url}}"],"path":["v1","bookings",":bookingId"],"variable":[{"key":"bookingId","value":"0d884efc-5ca0-4842-b1dd-17aad054a6a1","description":"Mandatory - The booking identifier (UUID). Available booking UUIDs can be fetched via endpoint GET Clinic Bookings.\n"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1006,\n \"message\": \"The caregiver has no permission for the clinic: WebDoc nr1\"\n }\n}"},{"id":"5207643f-5629-43ed-a460-03c3bcbb7f54","name":"Booking - reschedule a booking to new caregiver without given patient type","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"requestedByUserId\": \"1a612f7f-9e14-46dd-8947-80964fc5ff52\",\n \"caregiver\":{\n \"id\":\"03d19b7d-23b0-4047-bf55-79ba8578da7f\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/bookings/:bookingId","host":["{{url}}"],"path":["v1","bookings",":bookingId"],"variable":[{"key":"bookingId","value":"0d884efc-5ca0-4842-b1dd-17aad054a6a1","description":"Mandatory - The booking identifier (UUID). Available booking UUIDs can be fetched via endpoint GET Clinic Bookings.\n"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1006,\n \"message\": \"The caregiver has no permission for the patient type: Folksam\"\n }\n}"},{"id":"6fcd7d03-50d9-46c2-9d0c-56be3e89f4ea","name":"Booking - remove action codes","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"requestedByUserId\": \"1a612f7f-9e14-46dd-8947-80964fc5ff52\",\n \"actionCodes\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/bookings/:bookingId","host":["{{url}}"],"path":["v1","bookings",":bookingId"],"variable":[{"key":"bookingId","value":"0c6281bb-c454-4232-a41b-3879e88dfff0","description":"The booking identifier (UUID)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 23 Feb 2021 14:17:47 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.7"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"27"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"0c6281bb-c454-4232-a41b-3879e88dfff0\",\n \"clinicId\": \"be895cd3-bbf9-4ac9-83c4-9fa993034966\",\n \"date\": \"2025-03-20\",\n \"startTime\": \"10:00\",\n \"endTime\": \"11:00\",\n \"arrived\": 0,\n \"actionCodes\": [],\n \"bookingDescription\": \"\",\n \"bookingType\": \"Online\",\n \"bookedPatientType\": \"\",\n \"injuryNumber\": \"\",\n \"payments\": [],\n \"patient\": {\n \"isListed\": false,\n \"personalNumber\": \"19121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Insurance Company\",\n \"address\": {\n \"streetName\": \"Test Street 123\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\"\n },\n \"mobilePhone\": \"+46701740635\",\n \"listing\": {\n \"hsaId\": \"SE1234567891-E000000001236\",\n \"countyName\": \"Test county\"\n },\n \"freeCard\": []\n },\n \"caregiver\": {\n \"id\": \"b6b3df5a-7363-44a0-8e33-0f91b5585de8\",\n \"title\": \"Doctor\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19131313-1313\"\n }\n}"},{"id":"32ca42aa-bd7b-4f1a-b6cd-14a5c446b63e","name":"Booking - restricted action codes","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"requestedByUserId\": \"1a612f7f-9e14-46dd-8947-80964fc5ff52\",\n \"actionCodes\": [\n 1,\n 6\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/bookings/:bookingId","host":["{{url}}"],"path":["v1","bookings",":bookingId"],"variable":[{"key":"bookingId","value":"0d884efc-5ca0-4842-b1dd-17aad054a6a1","description":"Mandatory - The booking identifier (UUID). Available booking UUIDs can be fetched via endpoint GET Clinic Bookings.\n"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 8000,\n \"message\": \"Could not create a booking with restricted action code(s).\"\n }\n}"},{"id":"a7272f86-dfbe-4345-bc44-6f6c19d91f84","name":"Booking - incorrect fee format","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"patientId\": \"20ff56fb-08b1-4e0c-a8b0-3561da10b309\",\n \"requestedByUserId\": \"1a612f7f-9e14-46dd-8947-80964fc5ff52\",\n \"fee\": \"not-a-number\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/bookings/:bookingId","host":["{{url}}"],"path":["v1","bookings",":bookingId"],"variable":[{"key":"bookingId","value":"0d884efc-5ca0-4842-b1dd-17aad054a6a1","description":"Mandatory - The booking identifier (UUID). Available booking UUIDs can be fetched via endpoint GET Clinic Bookings.\n"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 8000,\n \"message\": \"Invalid fee, must be a number equal or larger than 0\"\n }\n}"},{"id":"33f8b2ee-811e-4631-9d05-bfd5c35c0dde","name":"Booking - wrong patient type for fee","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"patientId\": \"30gg56fb-08b1-4e0c-a8b0-3561da10b567\",\n \"requestedByUserId\": \"1a612f7f-9e14-46dd-8947-80964fc5ff52\",\n \"patientTypeId\": 1,\n \"fee\": 123,\n \"note\": \"Example where patient type is Private, i.e. not compatible with fee\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/bookings/:bookingId","host":["{{url}}"],"path":["v1","bookings",":bookingId"],"variable":[{"key":"bookingId","value":"0d884efc-5ca0-4842-b1dd-17aad054a6a1","description":"Mandatory - The booking identifier (UUID). Available booking UUIDs can be fetched via endpoint GET Clinic Bookings.\n"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 8000,\n \"message\": \"Incompatible patient type settings for fee\"\n }\n}"},{"id":"e5c6a23c-e397-4679-adb5-fc2f4fac3724","name":"JSON Schema","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":" Bearer ###########################3"},{"key":"Content-Type","value":" application/json"},{"key":"User-Agent","value":" PostmanRuntime/v.vv.v"},{"key":"Accept","value":" */*"},{"key":"Host","value":" -------.atlan.se"},{"key":"Accept-Encoding","value":" gzip, deflate, br"},{"key":"Connection","value":" keep-alive"},{"key":"Content-Length","value":" ####"},{"key":"Cookie","value":" "},{"key":"JSON_Schema","value":"true"}],"body":{"mode":"raw","raw":"{\n \"title\": \"PATCH Booking request\",\n \"required\": [\n \"requestedByUserId\"\n ],\n \"properties\": {\n \"patientId\": {\n \"title\": \"Patient's ID\",\n \"oneOf\": [\n {\n \"description\": \"Scheduling a patient\",\n \"$ref\": \"#/definitions/uuid\"\n },\n {\n \"description\": \"Removing a patient\",\n \"type\": \"null\"\n }\n ],\n \"$id\": \"#/properties/patientId\"\n },\n \"bookingTypeId\": {\n \"title\": \"Booking type ID\",\n \"description\": \"Used to change the booking type\",\n \"default\": 0,\n \"examples\": [\n 11\n ],\n \"$id\": \"#/properties/bookingTypeId\",\n \"type\": \"integer\"\n },\n \"date\": {\n \"title\": \"Rescheduled date\",\n \"format\": \"date\",\n \"examples\": [\n \"2121-05-18\"\n ],\n \"$id\": \"#/properties/date\",\n \"type\": \"string\"\n },\n \"startTime\": {\n \"title\": \"Rescheduled start time\",\n \"$ref\": \"#/definitions/time\",\n \"$id\": \"#/properties/startTime\"\n },\n \"endTime\": {\n \"title\": \"Rescheduled end time\",\n \"$ref\": \"#/definitions/time\",\n \"$id\": \"#/properties/endTime\"\n },\n \"reasonToRescheduleId\": {\n \"title\": \"Reason to reschedule\",\n \"description\": \"Compulsory when rescheduling beyound the healthcare guarantee\",\n \"default\": \"0\",\n \"pattern\": \"^[0-9]+$\",\n \"examples\": [\n \"3\"\n ],\n \"$id\": \"#/properties/reasonToRescheduleId\",\n \"type\": \"string\"\n },\n \"allowOverlap\": {\n \"title\": \"Is overlaping booking allowed\",\n \"default\": false,\n \"examples\": [\n false, true\n ],\n \"$id\": \"#/properties/allowOverlap\",\n \"type\": \"boolean\"\n },\n \"caregiver\": {\n \"title\": \"Caregiver\",\n \"required\": [\n \"id\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"caregiver ID\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/properties/caregiver/properties/id\"\n }\n },\n \"$id\": \"#/properties/caregiver\",\n \"type\": \"object\"\n },\n \"requestedByUserId\": {\n \"title\": \"User ID\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/properties/requestedByUserId\"\n },\n \"smsReminder\": {\n \"title\": \"SMS reminder\",\n \"examples\": [\n false, true\n ],\n \"$id\": \"#/properties/smsReminder\",\n \"type\": \"boolean\"\n },\n \"fee\": {\n \"title\": \"Fee\",\n \"default\": 0,\n \"examples\": [\n 300\n ],\n \"$id\": \"#/properties/fee\",\n \"type\": \"integer\"\n },\n \"patientTypeId\": {\n \"title\": \"Patient type Id\",\n \"default\": 0,\n \"pattern\": \"^[0-9]*$\",\n \"examples\": [\n 2\n ],\n \"$id\": \"#/properties/patientTypeId\",\n \"type\": \"integer\"\n }\n },\n \"$id\": \"http://webdoc.api/request/bookings/v1/patch/bookings\",\n \"type\": \"object\",\n \"definitions\": {\n \"uuid\": {\n \"$id\": \"#/definitions/uuid\",\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"default\": \"\",\n \"examples\": [\n \"ee4d906f-2eca-4345-9907-a4c6c2fcd931\"\n ]\n },\n \"time\": {\n \"$id\": \"#/definitions/time\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^[01][0-9]|2[0-3]:[0-5][0-9]$\",\n \"examples\": [\n \"19:25\"\n ] \n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://docker-api.atlan.se/v1/v1/bookings","protocol":"https","host":["docker-api","atlan","se"],"path":["v1","v1","bookings"],"query":[{"key":"","value":"","disabled":true}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 08 Dec 2022 19:47:26 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.13"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"792"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"PATCH Booking response\",\n \"required\": [\n \"id\",\n \"clinicId\",\n \"date\",\n \"startTime\",\n \"endTime\",\n \"arrived\",\n \"actionCodes\",\n \"bookingDescription\",\n \"bookingType\",\n \"bookedPatientType\",\n \"injuryNumber\",\n \"payments\",\n \"patient\",\n \"caregiver\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Booking ID\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/properties/id\"\n },\n \"clinicId\": {\n \"title\": \"Clinic ID\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/properties/clinicId\"\n },\n \"date\": {\n \"title\": \"Booking date\",\n \"default\": \"\",\n \"format\": \"date\",\n \"examples\": [\n \"2023-06-18\"\n ],\n \"$id\": \"#/properties/date\",\n \"type\": \"string\"\n },\n \"startTime\": {\n \"title\": \"Booking start time\",\n \"$ref\": \"#/definitions/time\",\n \"$id\": \"#/properties/startTime\"\n },\n \"endTime\": {\n \"title\": \"Booking end time\",\n \"$ref\": \"#/definitions/time\",\n \"$id\": \"#/properties/endTime\"\n },\n \"arrived\": {\n \"title\": \"Arrived\",\n \"default\": 0,\n \"examples\": [\n 0\n ],\n \"$id\": \"#/properties/arrived\",\n \"type\": \"integer\"\n },\n \"actionCodes\": {\n \"title\": \"Action codes\",\n \"$id\": \"#/properties/actionCodes\",\n \"type\": \"array\"\n },\n \"bookingDescription\": {\n \"title\": \"Description\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"\"\n ],\n \"$id\": \"#/properties/bookingDescription\",\n \"type\": \"string\"\n },\n \"bookingType\": {\n \"title\": \"Booking type\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Bokning\"\n ],\n \"$id\": \"#/properties/bookingType\",\n \"type\": \"string\"\n },\n \"bookedPatientType\": {\n \"title\": \"Booking patient type\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"VGR Primärvård\"\n ],\n \"$id\": \"#/properties/bookedPatientType\",\n \"type\": \"string\"\n },\n \"injuryNumber\": {\n \"title\": \"Injury number\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"\"\n ],\n \"$id\": \"#/properties/injuryNumber\",\n \"type\": \"string\"\n },\n \"payments\": {\n \"title\": \"Payments\",\n \"items\": {\n \"title\": \"Payment\",\n \"required\": [\n \"price\",\n \"amount\",\n \"comment\",\n \"account\",\n \"VATPercentage\",\n \"VAT\",\n \"expiryDate\",\n \"freeByFreeCard\",\n \"reducedByFreeCard\",\n \"articleName\"\n ],\n \"properties\": {\n \"price\": {\n \"title\": \"Price\",\n \"default\": 0,\n \"examples\": [\n 0\n ],\n \"$id\": \"#/properties/payments/items/properties/price\",\n \"type\": \"integer\"\n },\n \"amount\": {\n \"title\": \"Amount\",\n \"default\": 0,\n \"examples\": [\n 1\n ],\n \"$id\": \"#/properties/payments/items/properties/amount\",\n \"type\": \"integer\"\n },\n \"comment\": {\n \"title\": \"Comment\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Patientavgift avseende besök på WebDoc nr1 den 2023-06-18\"\n ],\n \"$id\": \"#/properties/payments/items/properties/comment\",\n \"type\": \"string\"\n },\n \"account\": {\n \"title\": \"Account\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"3010\"\n ],\n \"$id\": \"#/properties/payments/items/properties/account\",\n \"type\": \"string\"\n },\n \"VATPercentage\": {\n \"title\": \"VAT Percentage\",\n \"default\": 0,\n \"examples\": [\n 0\n ],\n \"$id\": \"#/properties/payments/items/properties/VATPercentage\",\n \"type\": \"integer\"\n },\n \"VAT\": {\n \"title\": \"VAT\",\n \"default\": 0,\n \"examples\": [\n 0\n ],\n \"$id\": \"#/properties/payments/items/properties/VAT\",\n \"type\": \"integer\"\n },\n \"expiryDate\": {\n \"title\": \"Expiry date\",\n \"default\": \"\",\n \"format\": \"date\",\n \"examples\": [\n \"2023-03-16\"\n ],\n \"$id\": \"#/properties/payments/items/properties/expiryDate\",\n \"type\": \"string\"\n },\n \"freeByFreeCard\": {\n \"title\": \"Free by Free Card\",\n \"description\": \"Is the booking free of charge because of the free card\",\n \"default\": false,\n \"examples\": [\n false, true\n ],\n \"$id\": \"#/properties/payments/items/properties/freeByFreeCard\",\n \"type\": \"boolean\"\n },\n \"reducedByFreeCard\": {\n \"title\": \"Reduced by Free Card\",\n \"description\": \"Is the booking reduced by the free card\",\n \"default\": false,\n \"examples\": [\n false, true\n ],\n \"$id\": \"#/properties/payments/items/properties/reducedByFreeCard\",\n \"type\": \"boolean\"\n },\n \"articleName\": {\n \"title\": \"Article name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Patientavgift\"\n ],\n \"$id\": \"#/properties/payments/items/properties/articleName\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/properties/payments/items\",\n \"type\": \"object\"\n },\n \"$id\": \"#/properties/payments\",\n \"type\": \"array\"\n },\n \"patient\": {\n \"title\": \"Patient\",\n \"required\": [\n \"isListed\",\n \"personalNumber\",\n \"firstName\",\n \"lastName\",\n \"patientType\",\n \"address\",\n \"mobilePhone\",\n \"listing\",\n \"freeCard\"\n ],\n \"properties\": {\n \"isListed\": {\n \"title\": \"Is the patient listed in the clinic\",\n \"descriotion\": \"Is the patient listed in the clinic\",\n \"default\": false,\n \"examples\": [\n false, true\n ],\n \"$id\": \"#/properties/patient/properties/isListed\",\n \"type\": \"boolean\"\n },\n \"personalNumber\": {\n \"title\": \"Patient's personal identifier\",\n \"$ref\": \"#/definitions/personalNumber\",\n \"$id\": \"#/properties/patient/properties/personalNumber\"\n },\n \"firstName\": {\n \"title\": \"Patient's first name\",\n \"$ref\": \"#/definitions/properName\",\n \"$id\": \"#/properties/patient/properties/firstName\"\n },\n \"lastName\": {\n \"title\": \"Patient's last name\",\n \"$ref\": \"#/definitions/properName\",\n \"$id\": \"#/properties/patient/properties/lastName\"\n },\n \"patientType\": {\n \"title\": \"Patient's patient type\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"VGR Primärvård\"\n ],\n \"$id\": \"#/properties/patient/properties/patientType\",\n \"type\": \"string\"\n },\n \"address\": {\n \"title\": \"Patient's address\",\n \"required\": [\n \"streetName\",\n \"city\",\n \"zipCode\"\n ],\n \"properties\": {\n \"streetName\": {\n \"title\": \"Street name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Brottningsvägen\"\n ],\n \"$id\": \"#/properties/patient/properties/address/properties/streetName\",\n \"type\": \"string\"\n },\n \"city\": {\n \"title\": \"City\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Brottkärr\"\n ],\n \"$id\": \"#/properties/patient/properties/address/properties/city\",\n \"type\": \"string\"\n },\n \"zipCode\": {\n \"title\": \"Zip code\",\n \"description\": \"Zip code / Post address\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"42211\"\n ],\n \"$id\": \"#/properties/patient/properties/address/properties/zipCode\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/properties/patient/properties/address\",\n \"type\": \"object\"\n },\n \"mobilePhone\": {\n \"title\": \"Mobile number\",\n \"default\": null,\n \"examples\": [\n null, \"090-01010101\"\n ],\n \"$id\": \"#/properties/patient/properties/mobilePhone\",\n \"type\": [\"string\", \"null\"]\n },\n \"listing\": {\n \"title\": \"Patient's listing\",\n \"required\": [\n \"hsaId\",\n \"countyName\"\n ],\n \"properties\": {\n \"hsaId\": {\n \"title\": \"Listing clinic HSA id\",\n \"$ref\": \"#/definitions/hsaId\",\n \"$id\": \"#/properties/patient/properties/listing/properties/hsaId\"\n },\n \"countyName\": {\n \"title\": \"Listing clinic county name\",\n \"default\": null,\n \"examples\": [\n null\n ],\n \"$id\": \"#/properties/patient/properties/listing/properties/countyName\",\n \"type\": \"null\"\n }\n },\n \"$id\": \"#/properties/patient/properties/listing\",\n \"type\": \"object\"\n },\n \"freeCard\": {\n \"title\": \"Free card\",\n \"$id\": \"#/properties/patient/properties/freeCard\",\n \"type\": \"array\"\n }\n },\n \"$id\": \"#/properties/patient\",\n \"type\": \"object\"\n },\n \"caregiver\": {\n \"title\": \"Caregiver\",\n \"required\": [\n \"id\",\n \"title\",\n \"firstName\",\n \"lastName\",\n \"identifier\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Caregiver Id\",\n \"ref\": \"#/deinitions/uuid\",\n \"$id\": \"#/properties/caregiver/properties/id\"\n },\n \"title\": {\n \"title\": \"Caregiver's title\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Läkare\"\n ],\n \"$id\": \"#/properties/caregiver/properties/title\",\n \"type\": \"string\"\n },\n \"firstName\": {\n \"title\": \"Caregiver's first name\",\n \"$ref\": \"#/definitions/properName\",\n \"$id\": \"#/properties/caregiver/properties/firstName\"\n },\n \"lastName\": {\n \"title\": \"Caregiver's last name\",\n \"$ref\": \"#/definitions/properName\",\n \"$id\": \"#/properties/caregiver/properties/lastName\"\n },\n \"identifier\": {\n \"title\": \"Caregiver's SSN\",\n \"$ref\": \"#/definitions/personalNumber\",\n \"$id\": \"#/properties/caregiver/properties/identifier\"\n }\n },\n \"$id\": \"#/properties/caregiver\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"http://webdoc.api/response/bookings/v1/patch/bookings\",\n \"type\": \"object\",\n \"definitions\": {\n \"uuid\": {\n \"$id\": \"#/definitions/uuid\",\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"default\": \"\",\n \"examples\": [\n \"ee4d906f-2eca-4345-9907-a4c6c2fcd931\"\n ]\n },\n \"time\": {\n \"$id\": \"#/definitions/time\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^[01][0-9]|2[0-3]:[0-5][0-9]$\",\n \"examples\": [\n \"19:25\"\n ] \n },\n \"hsaId\": {\n \"$id\": \"#/definitions/hsaId\",\n \"type\": \"string\",\n \"default\": \"\",\n \"oneOf\": [\n {\"pattern\": \"^SE[0-9]{10}-[0-9A-Za-z]+$\"},\n {\"pattern\": \"^$\"}\n ],\n \"examples\": [\n \"SE2321000131-007643n\"\n ]\n },\n \"properName\": {\n \"$id\": \"#/definitions/properName\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^[A-Z][a-zA-Z \\\\-_.]+|$\",\n \"examples\": [\n \"Joe\", \"Jean-Pierre\"\n ]\n },\n \"personalNumber\": {\n \"$id\": \"#/definitions/personalNumber\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^([0-9]{6}|[0-9]{8})[-+]?[0-9]{4}$\",\n \"examples\": [\n \"19121212-1212\", \"121212-1212\",\n \"19121212+1212\", \"121212+1212\",\n \"191212121212\", \"1212121212\"\n ] \n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}"}],"_postman_id":"272cbb67-cd43-4d44-a7ae-98392a2e4817"},{"name":"Bookings","id":"0819d103-d13e-4968-a4f8-41cb1679895e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"136186d5-073a-47af-924a-5d6f3624de07\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/bookings/:bookingId","description":"

Available as of Webdoc 6.24

\n

This endpoint can be used to delete a booking; this will also unbook the patient connected to the booking if applicable.

\n

Required post parameters:

\n
    \n
  • userId
    (The user ID in UUID format of the caregiver that created the booking.)
    • \n
\n

Allowed with the following scope:

\n
    \n
  • bookings:write
    • \n
\n","urlObject":{"path":["v1","bookings",":bookingId"],"host":["{{url}}"],"query":[],"variable":[{"description":{"content":"

Required - Booking identifier (UUID).

\n","type":"text/plain"},"type":"any","value":"94a0e2b1-4532-428f-afff-f863fa086fad","key":"bookingId"}]}},"response":[{"id":"d994214b-6a0a-4533-a606-65cbb046b289","name":"Bookings","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"136186d5-073a-47af-924a-5d6f3624de07\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/bookings/:bookingId","host":["{{url}}"],"path":["v1","bookings",":bookingId"],"variable":[{"key":"bookingId","value":"94a0e2b1-4532-428f-afff-f863fa086fad","description":"_Required_ - Booking identifier (UUID)."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"78ee0fc1-9d35-45da-8f9d-94c145ec8747","name":"JSON Schema","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"JSON_Schema","value":"true"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Id of the user deleting the booking\",\n \"required\": [\n \"userId\"\n ],\n \"properties\": {\n \"userId\": {\n \"title\": \"User Id\",\n \"format\": \"uuid\",\n \"default\": \"\",\n \"examples\": [\n \"ee4d906f-2eca-4345-9907-a4c6c2fcd931\"\n ],\n \"$id\": \"#/properties/userId\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"http://webdoc.api/response/bookings/v1/del/bookings\",\n \"type\": \"object\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/bookingTypes"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 06 Dec 2022 18:23:45 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.13"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"4148"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0819d103-d13e-4968-a4f8-41cb1679895e"}],"id":"190ed754-5251-450d-87d9-f0a036dcc361","_postman_id":"190ed754-5251-450d-87d9-f0a036dcc361","description":""}],"id":"077bd3dd-aa97-455a-af1f-8af7b86caf08","description":"

Overlapping of bookings - through rescheduling of a booking or when creating a new one - can be controlled with the body parameter \"allowOverlap\".

\n

Moreover, overlapping of bookings is allowed when \"allowOverlap\" is set to \"true\", or when this parameter is not included at all. However, when \"allowOverlap\" is set to \"false\", overlapping of bookings is prohibited.

\n

Furthermore, changes made via API calls to DEL Bookings, PATCH Bookings or POST Bookings are shown automatically in the corresponding Webdoc calendar views.

\n","_postman_id":"077bd3dd-aa97-455a-af1f-8af7b86caf08"},{"name":"Clinics","item":[{"name":"v1","item":[{"name":"Clinics","id":"27c4810e-24ab-4f72-8a17-e537ea6f4147","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/v1/clinics?hsaId=SE123-4567890&companyHsaId=SE1234567890-123n&organisationNumber=162793-123","description":"

Get the basic information of all clinics by using different filters (query parameters).

\n

Allowed with one of the following scopes:

\n
    \n
  • clinics:read
    • \n
  • clinics:write
    • \n
\n","urlObject":{"path":["v1","clinics"],"host":["{{url}}"],"query":[{"description":{"content":"

Optional - Filter clinics based on hsaId.

\n","type":"text/plain"},"key":"hsaId","value":"SE123-4567890"},{"description":{"content":"

Optional - Filter clinics based on companyHsaId.

\n","type":"text/plain"},"key":"companyHsaId","value":"SE1234567890-123n"},{"description":{"content":"

Optional - Filter clinics based on organisationNumber.

\n","type":"text/plain"},"key":"organisationNumber","value":"162793-123"}],"variable":[]}},"response":[{"id":"ecbd1b5d-8edf-41c1-a8d3-e6c9a2008bcd","name":"Clinics","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/clinics?companyHsaId=SE1234567890-123n&organisationNumber=162793-123","host":["{{url}}"],"path":["v1","clinics"],"query":[{"key":"hsaId","value":"SE123-4567890","description":"_Optional_ - Filter clinics based on hsaId.","disabled":true},{"key":"companyHsaId","value":"SE1234567890-123n","description":"_Optional_ - Filter clinics based on companyHsaId."},{"key":"organisationNumber","value":"162793-123","description":"_Optional_ - Filter clinics based on organisationNumber."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"873ab456-097c-12fd-aaab-98365cb34009\",\n \"name\": \"Clinic 1\",\n \"hsaId\": \"SE1234567890-639n\",\n \"companyHsaId\": \"SE1234567891-E000000001234\",\n \"organisationNumber\": \"123456-7890\",\n \"address\": \"Test street 23C\",\n \"postNumber\": \"12345\",\n \"postAddress\": \"Gothenburg\",\n \"invoiceInfo\": {\n \"companyName\": \"Test Company\",\n \"organisationNumber\": \"123456-7890\",\n \"companyTelephone\": \"031-3900604\",\n \"companyAddress\": \"Test street 25\",\n \"companyPost\": \"12345\",\n \"companyPostArea\": \"Gothenburg\",\n \"bankGiro\": \"1234-5678\",\n \"postGiro\": \"11 23 45-0\"\n }\n },\n {\n \"id\": \"cd4509bf-230d-a09d-4a23-ef34009f12ad\",\n \"name\": \"Clinic 2\",\n \"hsaId\": \"SE1234567890-638n\",\n \"companyHsaId\": \"SE1234567890-123n\",\n \"organisationNumber\": \"123456-7890\",\n \"address\": \"Test street 23A\",\n \"postNumber\": \"12345\",\n \"postAddress\": \"Gothenburg\",\n \"invoiceInfo\": {\n \"companyName\": \"Test Company\",\n \"organisationNumber\": \"123456-7890\",\n \"companyTelephone\": \"031-3900604\",\n \"companyAddress\": \"Test street 25\",\n \"companyPost\": \"12345\",\n \"companyPostArea\": \"Gothenburg\",\n \"bankGiro\": \"1234-5678\",\n \"postGiro\": \"11 23 45-0\"\n }\n },\n {\n \"id\": \"def60545-12fd-86cb-12dc-9834cb00961a\",\n \"name\": \"Clinic 3\",\n \"hsaId\": \"SE1234567890-637n\",\n \"companyHsaId\": \"SE1234567890-123n\",\n \"organisationNumber\": \"123456-7890\",\n \"address\": \"Teddy street 23B\",\n \"postNumber\": \"12345\",\n \"postAddress\": \"Gothenburg\",\n \"invoiceInfo\": {\n \"companyName\": \"Test Company\",\n \"organisationNumber\": \"123456-7890\",\n \"companyTelephone\": \"031-3900604\",\n \"companyAddress\": \"Test street 25\",\n \"companyPost\": \"12345\",\n \"companyPostArea\": \"Gothenburg\",\n \"bankGiro\": \"1234-5678\",\n \"postGiro\": \"11 23 45-0\"\n }\n }\n]"}],"_postman_id":"27c4810e-24ab-4f72-8a17-e537ea6f4147"}],"id":"974b4d63-a68e-421d-87ca-a075c6cf611a","_postman_id":"974b4d63-a68e-421d-87ca-a075c6cf611a","description":""}],"id":"c808dbe8-4bf7-4df1-a84b-83678a86729f","_postman_id":"c808dbe8-4bf7-4df1-a84b-83678a86729f","description":""},{"name":"Documents","item":[{"name":"Document Types","id":"17d1f8d7-cd60-4e7b-ad7f-08a082d8aff2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v1/documentTypes","description":"

This endpoint can be called to fetch information about document types to be used to upload different files from external systems to Webdoc. External file uploads can then be done via the endpoint POST Documents.

\n

Allowed with the following scope:

\n
    \n
  • document-types:read
    • \n
\n","urlObject":{"path":["v1","documentTypes"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"fabb0a7e-01af-4db4-9fd8-fa685c1b1871","name":"Document Types","originalRequest":{"method":"GET","header":[],"url":"https://api.atlan.se/v1/documentTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Document\",\n \"inreferral\": false,\n \"active\": true,\n \"signRequired\": true\n },\n {\n \"id\": 2,\n \"name\": \"Inreferral\",\n \"inreferral\": true,\n \"active\": true,\n \"signRequired\": true\n },\n {\n \"id\": 3,\n \"name\": \"Spirometry\",\n \"inreferral\": false,\n \"active\": false,\n \"signRequired\": false\n }\n]"}],"_postman_id":"17d1f8d7-cd60-4e7b-ad7f-08a082d8aff2"},{"name":"Documents","id":"da26004a-ad35-4432-b712-a55e447d9ce6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/annice.stromberg/Documents/TestUploadFiles/File.zip"],"description":"

Required - The file to be uploaded. See more info in description for supported formats.

\n","src":"postman-cloud:///1eee8317-54a9-4e10-bc24-b3e6f020ed5a"},{"key":"documentTypeId","value":"1","type":"text","description":"

Required - The document type of the file.

\n"},{"key":"personalNumber","value":"19121212-1212","type":"text","description":"

Optional - The personal number of the patient. Supported Swedish personal number formats are \"YYYYMMDD-XXXX\" or \"YYYYMMDDXXXX\".\nForeign personal number formats can be in \"YYYYMMDD-ZXXX\", \"YYYYMMDD+ZXXX\", \"YYYYMMDDZXXX\" or even in reduced formats like \"YYMMDD-ZXXX, YYMMDD+ZXXX and YYMMDDZXXX - where Z is either M, K or X.

\n"},{"key":"userId","value":"5fa6b98d-b98a-4381-b691-14ba96a3aeb7","type":"text","description":"

Optional - The user ID in UUID format corresponding to the caregiver in which the file shall refer to.

\n"},{"key":"createdAt","value":"2026-01-29 11:37:25.123","description":"

Optional - The time you want the uploaded file to be registered as created in Webdoc. Valid time formats are: \"YYYY-MM-DD HH:mm:ss\" or \"YYYY-MM-DD HH:mm:ss.SSS\".

\n","type":"text","uuid":"59654768-985c-40d5-a4ba-14045c6a73e5"}]},"url":"{{url}}/v1/clinics/:clinicId/documents","description":"

Available as of Webdoc 6.69

\n

This endpoint can be used to upload a file with meta data to Webdoc using multipart/form-data content.

\n\n

If a personal number is specified in the request, the file will be related to a patient in which the personal number refers to. Morever, an uploaded file refering to a patient will be accessible in Webdoc through the patient shortcuts via the \"Dokument\" icon.

\n

However, if no personal number is specified in the request, the file will be uploaded and accessible in Webdoc via the top menu option \"Dokument > Scannade filer\".

\n

Currently, the following file formats are supported: pdf, jpg, jpeg, png, gif, tga, tif, tiff, bmp, or xcf.

\n

Furthermore, the maximum allowed file size is currently 20 MB (20 971 520 bytes according to the IEC standard - International Electrotechnical Commission).

\n

Available post parameters (bold are required):

\n
  • file
    (The file to be uploaded. See supported formats and max size in above description.)
  • documentTypeId
    (The document type or category that the file shall refer to, such as \"Dokument\" or \"Träningsprogram\", or whatever suits your needs. Available document type IDs for your environment can be fetched via     GET Document Types.)
  • personalNumber
    (A personal identity number corresponding to the patient that the file shall refer to. Currently, Swedish and foreign personal numbers are supported, such as: \"19121212-1212\", “19121212-M123”, “121212-KLL1” or \"2019807276\", etc. Moreover, if a Swedish patient does not yet exist in Webdoc, this patient will be automatically created during file upload. However, foreign patients have to exist in Webdoc before file uploads. Furthermore, existing patients in Webdoc can be fetched via the endpoint GET /v2/patients, and foreign patients can be created via POST Patients Without Social Security Number.)
  • userId
    (The user ID in UUID format corresponding to the caregiver in which the file shall refer to. UUID values for existing Webdoc users can be fetched via the endpoint GET Users.)
  • createdAt
    (The time you want the uploaded file to be registered as created in Webdoc. This will also affect the time order of these files when displayed via Webdoc GUI under \"Dokument > Skannade filer\". If not specified, the created time will default to current time. Currently, the following formats are supported: \"YYYY-MM-DD HH:mm:ss\" or \"YYYY-MM-DD HH:mm:ss.SSS\", e.g. \"2026-01-29 11:37:15\" or with milliseconds \"2026-01-29 11:37:15.123\".)

\n\n

Allowed with the following scope:

\n
    \n
  • documents:write
    • \n
\n","urlObject":{"path":["v1","clinics",":clinicId","documents"],"host":["{{url}}"],"query":[],"variable":[{"description":{"content":"

Required - The clinic identifier (UUID) that the file shall refer to.

\n","type":"text/plain"},"type":"any","value":"873ab456-097c-12fd-aaab-98365cb34009","key":"clinicId"}]}},"response":[{"id":"6cf2d18e-7996-4bbd-a81e-6924bd5fd6ba","name":"Documents - OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/annice.stromberg/Documents/TestUploadFiles/File.pdf"],"src":"postman-cloud:///1eee8315-a57f-4760-b8ee-c29b5625ed9f"},{"key":"documentTypeId","value":"1","type":"text"},{"key":"personalNumber","value":"19121212-1212","type":"text"},{"key":"userId","value":"5fa6b98d-b98a-4381-b691-14ba96a3aeb7","type":"text"}],"options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/clinics/:clinicId/documents","host":["{{url}}"],"path":["v1","clinics",":clinicId","documents"],"variable":[{"key":"clinicId","value":"def60545-12fd-86cb-12dc-9834cb00961a"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 08 Feb 2022 17:05:04 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.10"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"797"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"bacdbf5d-8a12-4098-b872-e3c041b519fb","name":"Documents - Invalid file format","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/annice.stromberg/Documents/TestUploadFiles/File.zip"],"src":"/Users/annice.stromberg/Documents/TestUploadFiles/File.zip"},{"key":"documentTypeId","value":"1","type":"text"}],"options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/clinics/:clinicId/documents","host":["{{url}}"],"path":["v1","clinics",":clinicId","documents"],"variable":[{"key":"clinicId","value":"def60545-12fd-86cb-12dc-9834cb00961a"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1008,\n \"message\": \"Invalid file format!\"\n }\n}"},{"id":"3edb887a-9a26-4004-a29d-1fae912618ab","name":"Documents - Foreign patient not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/annice.stromberg/Documents/TestUploadFiles/File.zip"],"src":"postman-cloud:///1eee8315-a57f-4760-b8ee-c29b5625ed9f"},{"key":"documentTypeId","value":"1","type":"text"},{"key":"personalNumber","value":"19121212-M123","type":"text","uuid":"eb66cb4d-bd58-4f5b-9940-a8216dca8d7e"}],"options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/clinics/:clinicId/documents","host":["{{url}}"],"path":["v1","clinics",":clinicId","documents"],"variable":[{"key":"clinicId","value":"def60545-12fd-86cb-12dc-9834cb00961a"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1005,\n \"message\": \"No patient was found for the given 'personalNumber'. Foreign patients must exist in Webdoc before file upload!\"\n }\n}"},{"id":"f29bcf1a-f634-4037-99e2-7eee8baa1bfc","name":"Documents - Invalid user ID","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"postman-cloud:///1eee8315-a57f-4760-b8ee-c29b5625ed9f"},{"key":"documentTypeId","value":"1","type":"text"},{"key":"userId","value":"73afd724-eb79-11ee-9ec5-0242ac120004","type":"text"}],"options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/clinics/:clinicId/documents","host":["{{url}}"],"path":["v1","clinics",":clinicId","documents"],"variable":[{"key":"clinicId","value":"def60545-12fd-86cb-12dc-9834cb00961a"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1005,\n \"message\": \"No user was found for the given 'userId'!\"\n }\n}"},{"id":"1c0fbecf-13f2-48f0-aba6-f31a4f607311","name":"Documents - Invalid created at format","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"postman-cloud:///1eee8315-a57f-4760-b8ee-c29b5625ed9f"},{"key":"documentTypeId","value":"1","type":"text"},{"key":"userId","value":"73afd724-eb79-11ee-9ec5-0242ac120004","type":"text"},{"key":"createdAt","value":"2026-01-29","type":"text","uuid":"8e55db8c-d505-48fa-9ef3-bb90a292f8ed"}],"options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/clinics/:clinicId/documents","host":["{{url}}"],"path":["v1","clinics",":clinicId","documents"],"variable":[{"key":"clinicId","value":"def60545-12fd-86cb-12dc-9834cb00961a"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1008,\n \"message\": \"Invalid format for 'createdAt'! Valid formats are: 'Y-m-d H:i:s' or 'Y-m-d H:i:s.v'.\"\n }\n}"}],"_postman_id":"da26004a-ad35-4432-b712-a55e447d9ce6"}],"id":"23dba3fa-a2c7-4c03-96e6-7cfde3938c3b","_postman_id":"23dba3fa-a2c7-4c03-96e6-7cfde3938c3b","description":""},{"name":"Invoices","item":[{"name":"v1","item":[{"name":"Credit Invoices","id":"d779d07c-b4f5-4322-abc3-b115b466a0c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/v1/clinics/:clinicId/creditInvoices?personalNumber=19121212-1212&date=2020-12-24&fromDate=2020-12-23&toDate=2020-12-25&isExported=1","description":"

Fetch credit invoices from a specified clinic based on filters (query parameters).

\n

Examples of use cases:

\n
    \n
  • Get invoices for a specific patient.
    • \n
  • Get invoices for a specific period of time.
    • \n
\n

Allowed with the following scope:

\n
    \n
  • self-service
    • \n
\n","urlObject":{"path":["v1","clinics",":clinicId","creditInvoices"],"host":["{{url}}"],"query":[{"description":{"content":"

Optional - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX and YYMMDDXXXX. Foreign personal numbers are also supported. The format needs to be YYYYMMDD-ZXXX, YYYYMMDDZXXX or even in the reduced format of YYMMDD-ZXXX and YYMMDDZXXX where Z is either M, K or X.

\n","type":"text/plain"},"key":"personalNumber","value":"19121212-1212"},{"description":{"content":"

Optional - Credit invoices date in the format of YYYY-MM-DD. Timezone: 'CET'.

\n","type":"text/plain"},"key":"date","value":"2020-12-24"},{"description":{"content":"

Optional - Lower limit date in the format of YYYY-MM-DD. Timezone: 'CET'.

\n","type":"text/plain"},"key":"fromDate","value":"2020-12-23"},{"description":{"content":"

Optional - Upper limit date in the format of YYYY-MM-DD. Timezone: 'CET'.

\n","type":"text/plain"},"key":"toDate","value":"2020-12-25"},{"description":{"content":"

Optional - This flag filters the invoices which have been handled or not. When 1 is provided, the API returns only handled invoices whereas 0 is provided, it returns all unhandled invoices.

\n","type":"text/plain"},"key":"isExported","value":"1"}],"variable":[{"description":{"content":"

Required - Clinic identifier (UUID).

\n","type":"text/plain"},"type":"any","value":"873ab456-097c-12fd-aaab-98365cb34009","key":"clinicId"}]}},"response":[{"id":"274566b5-9984-4222-a4c9-222d0df357e7","name":"Credit Invoices","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/clinics/:clinicId/creditInvoices?personalNumber=19121212-1212&date=2020-12-24&fromDate=2020-12-23&toDate=2020-12-25&isExported=1","host":["{{url}}"],"path":["v1","clinics",":clinicId","creditInvoices"],"query":[{"key":"personalNumber","value":"19121212-1212","description":"_Optional_ - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX"},{"key":"date","value":"2020-12-24","description":"_Optional_ - A specific date for the credit invoices in the format of YYYY-MM-DD. Timezone: 'CET'"},{"key":"fromDate","value":"2020-12-23","description":"_Optional_ - The date should be given in the format of YYYY-MM-DD. Timezone: 'CET'"},{"key":"toDate","value":"2020-12-25","description":"_Optional_ - The date should be given in the format of YYYY-MM-DD. Timezone: 'CET'"},{"key":"isExported","value":"1","description":"_Optional_ - This flag filters the invoices which have been handled or not. When 1 is provided, API returns only handled invoices whereas 0 is provided, it returns all unhandled invoices"}],"variable":[{"key":"clinicId","value":"873ab456-097c-12fd-aaab-98365cb34009","description":"Clinic identifier (UUID)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"invoiceId\": \"1234567891011\",\n \"VAT\": \"-55\",\n \"VATPercentage\": 25,\n \"netAmount\": \"-220\",\n \"totalAmount\": \"-275\",\n \"currency\": \"kr\",\n \"invoiceStatus\": \"0\",\n \"clinicName\": \"Clinic 2\",\n \"paidDate\": null,\n \"expiryDate\": \"2021-01-24\",\n \"createdAt\": \"2020-12-24\",\n \"invoiceNumber\": \"12345678\",\n \"payments\": [\n {\n \"price\": \"-160\",\n \"amount\": \"1\",\n \"comment\": \"Crediting of patient fee for visit at 2020-12-24\",\n \"VATPercentage\": \"25\",\n \"VAT\": \"-40\",\n \"articleName\": \"Crediting\"\n },\n {\n \"price\": \"-60\",\n \"amount\": \"1\",\n \"comment\": \"Crediting of patient fee for visit at 2020-12-24\",\n \"VATPercentage\": \"25\",\n \"VAT\": \"-15\",\n \"articleName\": \"Crediting\"\n }\n ],\n \"caregiver\": {\n \"title\": \"Dr\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19961209-6642\"\n },\n \"patient\": {\n \"personalNumber\": \"129121212-1212\",\n \"firstName\": \"Jimmy\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Private\",\n \"address\": {\n \"streetName\": \"West Street 123\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"55555\"\n },\n \"mobilePhone\": \"070-1740605\"\n }\n}"}],"_postman_id":"d779d07c-b4f5-4322-abc3-b115b466a0c2"},{"name":"Invoices","id":"01bcca01-1c8e-4b3b-8bd6-bf1c14ff201f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/v1/clinics/:clinicId/invoices?personalNumber=19121212-1212&date=2020-12-24&fromDate=2020-12-23&toDate=2020-12-25&isExported=1&status=0","description":"

This endpoint can be used to fetch invoices from a specified clinic based on filters (request params).

\n

Examples of use cases:

\n
    \n
  • Get invoices for a specific patient.
    • \n
  • Get invoices for a specific period of time.
    • \n
  • Get only unpaid invoices.
    • \n
\n

Allowed with the following scope:

\n
    \n
  • self-service
    • \n
\n","urlObject":{"path":["v1","clinics",":clinicId","invoices"],"host":["{{url}}"],"query":[{"description":{"content":"

Optional - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX and YYMMDDXXXX. Foreign personal numbers are also supported. The format needs to be YYYYMMDD-ZXXX, YYYYMMDDZXXX or even in the reduced format of YYMMDD-ZXXX and YYMMDDZXXX where Z is either M, K or X.

\n","type":"text/plain"},"key":"personalNumber","value":"19121212-1212"},{"description":{"content":"

Optional - A specific date for the credit invoices in the format of YYYY-MM-DD. Timezone: 'CET'.

\n","type":"text/plain"},"key":"date","value":"2020-12-24"},{"description":{"content":"

Optional - The date should be given in the format of YYYY-MM-DD. Timezone: 'CET'.

\n","type":"text/plain"},"key":"fromDate","value":"2020-12-23"},{"description":{"content":"

Optional - The date should be given in the format of YYYY-MM-DD. Timezone: 'CET'.

\n","type":"text/plain"},"key":"toDate","value":"2020-12-25"},{"description":{"content":"

Optional - This flag filters the invoices which have been handled or not.

\n
    \n
  • 1 = Return only the handled invoices.
    • \n
  • 0 = Return all unhandles invoices.
    • \n
\n","type":"text/plain"},"key":"isExported","value":"1"},{"description":{"content":"

Optional - The payment status of the invoices.

\n
    \n
  • 0 = Not paid.
    • \n
  • 1 = Partly paid.
    • \n
  • 2 = Fully paid.
    • \n
  • 3 = Overpaid.
    • \n
\n","type":"text/plain"},"key":"status","value":"0"}],"variable":[{"description":{"content":"

Required - Clinic identifier (UUID).

\n","type":"text/plain"},"type":"any","value":"481c97c5-0bd7-4aff-aca2-71ce9003b613","key":"clinicId"}]}},"response":[{"id":"4768c3b4-ef15-45d8-a62c-a34f39772934","name":"Invoices","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/clinics/:clinicId/invoices?personalNumber=19121212-1212&date=2020-12-24&fromDate=2020-12-23&toDate=2020-12-25&isExported=1&status=0","host":["{{url}}"],"path":["v1","clinics",":clinicId","invoices"],"query":[{"key":"personalNumber","value":"19121212-1212","description":"_Optional_ - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX"},{"key":"date","value":"2020-12-24","description":"_Optional_ - A specific date for the credit invoices in the format of YYYY-MM-DD. Timezone: 'CET'"},{"key":"fromDate","value":"2020-12-23","description":"_Optional_ - The date should be given in the format of YYYY-MM-DD. Timezone: 'CET'"},{"key":"toDate","value":"2020-12-25","description":"_Optional_ - The date should be given in the format of YYYY-MM-DD. Timezone: 'CET'"},{"key":"isExported","value":"1","description":"_Optional_ - This flag filters the invoices which have been handled or not. When 1 is provided, API returns only handled invoices whereas 0 is provided, it returns all unhandled invoices"},{"key":"status","value":"0","description":"_Optional_ - The payment status of the invoices. Should be given as [0 = not paid, 1 = partly paid, 2 = paid, 3 = overpaid]"}],"variable":[{"key":"clinicId","value":"873ab456-097c-12fd-aaab-98365cb34009","description":"Clinic identifier (UUID)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"invoiceId\": \"1234567891011\",\n \"VAT\": \"55\",\n \"VATPercentage\": 25,\n \"netAmount\": \"220\",\n \"totalAmount\": \"275\",\n \"currency\": \"kr\",\n \"invoiceStatus\": \"0\",\n \"clinicName\": \"Clinic 2\",\n \"paidDate\": null,\n \"expiryDate\": \"2021-01-24\",\n \"createdAt\": \"2020-12-24\",\n \"invoiceNumber\": \"12345678\",\n \"payments\": [\n {\n \"price\": \"160\",\n \"amount\": \"1\",\n \"comment\": \"Patient fee for visit at 2020-12-24\",\n \"VATPercentage\": \"25\",\n \"VAT\": \"40\",\n \"articleName\": \"Patient fee\"\n },\n {\n \"price\": \"60\",\n \"amount\": \"1\",\n \"comment\": \"Service fees\",\n \"VATPercentage\": \"25\",\n \"VAT\": \"15\",\n \"articleName\": \"Service fees\"\n }\n ],\n \"caregiver\": {\n \"title\": \"Dr\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19961209-6642\"\n },\n \"patient\": {\n \"personalNumber\": \"129121212-1212\",\n \"firstName\": \"Jimmy\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Private\",\n \"address\": {\n \"streetName\": \"West Street 123\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"55555\"\n },\n \"mobilePhone\": \"070-1740605\"\n },\n \"recipient\": {\n \"type\": \"patient\",\n \"firstName\": \"Jeremy\",\n \"lastName\": \"Doe\",\n \"billingAddress\": \"Exempelgatan 112\",\n \"billingZipCode\": \"55555\",\n \"billingCity\": \"Gothenburg\"\n }\n}"}],"_postman_id":"01bcca01-1c8e-4b3b-8bd6-bf1c14ff201f"},{"name":"Invoices","id":"b5caa80a-2ae7-46da-8626-378369a9f708","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"visitId\": \"135b8b8f-c7cd-4328-9ff3-863fd4f7208f\",\n \"totalPayment\": \"123\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/clinics/:clinicId/invoices","description":"

This endpoint can be used to create a new invoice from a provided visit and payment information.

\n

(Also, this endpoint can be used in the context of a patient arrival registration at a clinic. You can read a more detailed tutorial about the self-service flow on the Integrator Portal: https://integratorportal.carasent.net/faq/wd-arrival-registration-docs)

\n

Available post parameters (bold are required):

\n
    \n

  • visitId
    (Visit identifier in UUID format.)

    \n
    • \n

  • totalPayment

    \n
    • \n
\n

Allowed with the following scope:

\n
    \n
  • self-service
    • \n
\n","urlObject":{"path":["v1","clinics",":clinicId","invoices"],"host":["{{url}}"],"query":[],"variable":[{"description":{"content":"

Required - Clinic identifier (UUID).

\n","type":"text/plain"},"type":"any","value":"873ab456-097c-12fd-aaab-98365cb34009","key":"clinicId"}]}},"response":[{"id":"cca86ba1-34a2-444f-9f22-5e9029b73741","name":"Invoice","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"visitId\": \"135b8b8f-c7cd-4328-9ff3-863fd4f7208f\",\n \"totalPayment\": \"770\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.atlan.se/v1/clinics/:clinicId/invoices","protocol":"https","host":["api","atlan","se"],"path":["v1","clinics",":clinicId","invoices"],"variable":[{"key":"clinicId","value":"873ab456-097c-12fd-aaab-98365cb34009","description":"Clinic identifier (UUID)"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"invoiceId\": \"1234567891011\",\n \"VAT\": \"92.4\",\n \"VATPercentage\": 12,\n \"netAmount\": \"770\",\n \"totalAmount\": \"862\",\n \"currency\": \"kr\",\n \"invoiceStatus\": \"0\",\n \"clinicName\": \"Alpha Maternity AB\",\n \"paidDate\": null,\n \"expiryDate\": \"2021-01-24\",\n \"createdAt\": \"2020-12-24 12:34:36\",\n \"invoiceNumber\": \"12345678\",\n \"payments\": [\n {\n \"price\": \"777\",\n \"amount\": \"1\",\n \"comment\": \"Patient fee for visit at 2020-12-24\",\n \"VATPercentage\": \"12\",\n \"VAT\": 12,\n \"articleName\": \"Patient fee\"\n },\n {\n \"price\": \"-7\",\n \"amount\": \"1\",\n \"comment\": \"Discount\",\n \"VATPercentage\": \"12\",\n \"articleName\": \"Discount\"\n }\n ],\n \"caregiver\": {\n \"title\": \"Dr\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19961209-6642\"\n },\n \"patient\": {\n \"personalNumber\": \"19121212-1212\",\n \"firstName\": \"Jimmy\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Private\",\n \"address\": {\n \"streetName\": \"West Street 123\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"55555\"\n },\n \"mobilePhone\": \"070-1740605\"\n }\n }\n]"}],"_postman_id":"b5caa80a-2ae7-46da-8626-378369a9f708"},{"name":"Invoices","id":"513c51d9-463c-48e1-975c-d988b7c014c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"totalPayment\": \"123\",\n \"paymentMethod\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/clinics/:clinicId/invoices/:invoiceId","description":"

This endpoint can be called to update the information of an existing invoice in Webdoc.

\n

(See available body parameters that can be used in the \"Body\" section below.)

\n

Payment methods

\n
    \n
  • 1 = Card
    • \n
  • 2 = Cash
    • \n
  • 3 = Exported invoice
    • \n
  • 4 = Paid invoice
    • \n
\n

Allowed with the following scope:

\n
    \n
  • self-service
    • \n
\n","urlObject":{"path":["v1","clinics",":clinicId","invoices",":invoiceId"],"host":["{{url}}"],"query":[],"variable":[{"description":{"content":"

Required - Clinic identifier (UUID).

\n","type":"text/plain"},"type":"any","value":"873ab456-097c-12fd-aaab-98365cb34009","key":"clinicId"},{"description":{"content":"

Required - Invoice identifier.

\n","type":"text/plain"},"type":"any","value":"1234567891011","key":"invoiceId"}]}},"response":[{"id":"80ae9777-5113-421d-9be2-b3f0b559efe7","name":"Invoice","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"totalPayment\": \"123\",\n \"paymentMethod\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/clinics/:clinicId/invoices/:invoiceId","host":["{{url}}"],"path":["v1","clinics",":clinicId","invoices",":invoiceId"],"variable":[{"key":"clinicId","value":"873ab456-097c-12fd-aaab-98365cb34009","description":"Clinic identifier (UUID)."},{"key":"invoiceId","value":"1234567891011","description":"Invoice identifier."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"invoiceId\": \"1234567891011\",\n \"VAT\": \"92.4\",\n \"VATPercentage\": 12,\n \"netAmount\": \"770\",\n \"totalAmount\": \"862\",\n \"currency\": \"kr\",\n \"invoiceStatus\": \"0\",\n \"clinicName\": \"Alpha Maternity AB\",\n \"paidDate\": null,\n \"expiryDate\": \"2018-10-28\",\n \"createdAt\": \"2018-10-08\",\n \"invoiceNumber\": \"12345678\",\n \"payments\": [\n {\n \"price\": \"777\",\n \"amount\": \"1\",\n \"comment\": \"Patient fee for visit at 2020-12-24\",\n \"VATPercentage\": \"12\",\n \"articleName\": \"Patient fee\"\n },\n {\n \"price\": \"-7\",\n \"amount\": \"1\",\n \"comment\": \"Discount\",\n \"VATPercentage\": \"12\",\n \"articleName\": \"Discount\"\n }\n ],\n \"caregiver\": {\n \"title\": \"Dr\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"identifier\": \"19961209-6642\"\n },\n \"patient\": {\n \"personalNumber\": \"19121212-1212\",\n \"firstName\": \"Jimmy\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Private\",\n \"address\": {\n \"streetName\": \"West Street 123\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"55555\"\n },\n \"mobilePhone\": \"070-1740605\"\n }\n}"}],"_postman_id":"513c51d9-463c-48e1-975c-d988b7c014c1"}],"id":"d9b7b2d4-8787-4090-adac-1e8ea6165a5f","_postman_id":"d9b7b2d4-8787-4090-adac-1e8ea6165a5f","description":""}],"id":"9e7dfff8-0baf-4680-821f-a8f6ff1c130a","_postman_id":"9e7dfff8-0baf-4680-821f-a8f6ff1c130a","description":""},{"name":"Notes","item":[{"name":"v1","item":[{"name":"Notes","id":"1a8470b6-06b6-42c3-ab11-8e0258f45ddb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"patientId\": \"4165f4fa-f41f-434d-a420-578fd99e6beb\",\n \"clinicId\": \"873ab456-097c-12fd-aaab-98365cb34009\",\n \"patientTypeId\": 5,\n \"userId\": \"6222731b-acdc-4fa2-8500-3022fd0eeea3\",\n \"recordTemplateId\": 10,\n \"createdAt\": \"2021-01-01 10:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/notes","description":"

Available as of Webdoc 6.25

\n

This endpoint can be used to create a new note post for a patient. To append content to the note, you then have to call the endpoint PATCH Records.

\n

(You can read a more detailed tutorial about the necessary chain of API calls to post a note record and append it with content from the Integrator Portal: https://integratorportal.carasent.net/faq/wd-external-note-population-docs.)

\n

Available post parameters (bold are required):

\n
  • patientId
    (The user ID of the patient in UUID format.)
  • clinicId
    (The clinic ID for the clinic where the note is created.)
  • patientTypeId
    (The patientTypeId specifies whether the patient note is linked to a care agreement, insurance company or if it is private.)
  • userId
    (The user ID in UUID format of the caregiver that creates the note.)
  • recordTemplateId
    (The recordTemplateId specifies what record template the patient note should be based on. The recordTemplate has to be of templateType \"7\" which is the constant for notes.)
  • createdAt
    (The specific date of the note in format YYYY-MM-DD HH:MM:SS.) If not supplied, the current date and time will be set.

\n\n

Allowed with the following scope:

\n
    \n
  • patient:write
    • \n
\n","urlObject":{"path":["v1","notes"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"612e50d8-f094-4fa0-b8c4-0bfb8e08f97f","name":"Notes","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"patientId\": \"4165f4fa-f41f-434d-a420-578fd99e6beb\",\n \"clinicId\": \"873ab456-097c-12fd-aaab-98365cb34009\",\n \"patientTypeId\": 5,\n \"userId\": \"6222731b-acdc-4fa2-8500-3022fd0eeea3\",\n \"recordTemplateId\": 10,\n \"createdAt\": \"2021-01-01 10:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/notes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"117033f5-85a2-11eb-af73-0242ac120006\",\n \"patientId\": \"4165f4fa-f41f-434d-a420-578fd99e6beb\",\n \"clinicId\": \"873ab456-097c-12fd-aaab-98365cb34009\",\n \"patientTypeId\": 5,\n \"userId\": \"6222731b-acdc-4fa2-8500-3022fd0eeea3\",\n \"recordTemplateId\": 10,\n \"createdAt\": \"2021-01-01 10:00:00\"\n}"}],"_postman_id":"1a8470b6-06b6-42c3-ab11-8e0258f45ddb"}],"id":"8ae7c6b0-79f5-4033-92f5-1c6591f31018","description":"
","_postman_id":"8ae7c6b0-79f5-4033-92f5-1c6591f31018"}],"id":"7aafdbf9-e754-4be5-b9d9-8140748959bb","_postman_id":"7aafdbf9-e754-4be5-b9d9-8140748959bb","description":""},{"name":"Organizations","item":[{"name":"v1","item":[{"name":"Organizations","id":"1da7d871-4e2a-4c85-a852-f924f12c8a81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/organizations","description":"

Get all organizations with their departments.

\n

Allowed with the following scope:

\n
    \n
  • organization:read
    • \n
\n","urlObject":{"path":["v1","organizations"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"53056b9c-b519-44ee-b790-e70c32794faf","name":"Organizations","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/organizations/"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"7a112c49-524a-462a-a174-250f716e54f6\",\n \"name\": \"Evimeria EMR AB\",\n \"active\": 1,\n \"departments\": [\n {\n \"id\": \"382e4381-c7be-11ec-94d1-0242ac120003\",\n \"name\": \"Evimeria EMR AB Utveckling Team' FHV\",\n \"parent\": \"7a112c49-524a-462a-a174-250f716e54f6\"\n },\n {\n \"id\": \"382e424c-c7be-11ec-94d1-0242ac120003\",\n \"name\": \"HR as\",\n \"parent\": \"7a112c49-524a-462a-a174-250f716e54f6\"\n },\n {\n \"id\": \"382e628b-c7be-11ec-94d1-0242ac120003\",\n \"name\": \"Supportavdelningen\",\n \"parent\": \"7a112c49-524a-462a-a174-250f716e54f6\"\n },\n {\n \"id\": \"382e4988-c7be-11ec-94d1-0242ac120003\",\n \"name\": \"Team AAA\",\n \"parent\": \"382e5233-c7be-11ec-94d1-0242ac120003\"\n },\n {\n \"id\": \"382e5233-c7be-11ec-94d1-0242ac120003\",\n \"name\": \"Test avdelning\",\n \"parent\": \"7a112c49-524a-462a-a174-250f716e54f6\"\n }\n ]\n },\n {\n \"id\": \"7032149e-edb5-4235-bb0f-3b2b36d01ebb\",\n \"name\": \"ABC test AB\",\n \"active\": 1,\n \"departments\": []\n }\n]"},{"id":"58838410-50cc-4f53-90b8-612fed265d6c","name":"JSON Schema","originalRequest":{"method":"GET","header":[{"key":"JSON_Schema","value":"true"}],"url":{"raw":"{{url}}/v1/organizations/","host":["{{url}}"],"path":["v1","organizations",""],"query":[{"key":"personalNumber","value":"19121212-1212","description":"_Optional_ - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX.\nForeign personal numbers are also supported. The format needs to be YYYYMMDD-ZXXX, YYYYMMDD+ZXXX, YYYYMMDDZXXX or even in the reduced format of YYMMDD-ZXXX, YYMMDD+ZXXX and YYMMDDZXXX where Z is either M, K or X.","disabled":true},{"key":"date","value":"2021-01-01","description":"_Optional_ - Bookings date in the format of YYYY-MM-DD. Timezone: 'CET'.","disabled":true},{"key":"fromDate","value":"2020-01-01","description":"_Optional_ - Lower limit date in the format of YYYY-MM-DD. Timezone: 'CET'.","disabled":true},{"key":"toDate","value":"2021-02-01","description":"_Optional_ - Upper limit date in the format of YYYY-MM-DD. Timezone: 'CET'.","disabled":true},{"key":"arrived","value":"2","description":"_Optional_ - Filter bookings by arrived status.\n\\\n\\\n**Search values:**\n* 0 - Not arrived\n* 1 - Arrived, but not paid\n* 2 - Arrived and paid","disabled":true},{"key":"selfService","value":"true","description":"_Optional_ - Filter bookings by booking type with self service flag.\n\\\n**Default:** true","disabled":true},{"key":"bookingTypeId","value":"9","description":"_Optional_ - Filter bookings with the given booking type id.","disabled":true},{"key":"booked","value":"true","description":"_Optional_ - Booking state selector.\n\\\n\\\nThis is a ternary filter:\n* true - Select booked time slots.\n* false - Select available time slots.\n* <empty> - Leave empty to select all time slots - both booked and available.","disabled":true},{"key":"userId","value":"{{userId}}","description":"_Optional_ - Filter bookings by a caregiver based on a userId (UUID).","disabled":true},{"key":"limit","value":"10","description":"_Optional_ - Limit the number of bookings that's being returned","disabled":true},{"key":"offset","value":"0","description":"_Optional_ - Offset the bookings that's being returned","disabled":true},{"key":"reservedForOrganizationId","value":"50","description":"_Optional_ - Get bookings that are reserved to an organization","disabled":true},{"key":"reservedForDepartmentId","value":"65","description":"_Optional_ - Get bookings that are reserved to a department","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 02 Dec 2022 19:34:01 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.13"},{"key":"Set-Cookie","value":"PHPSESSID=6f7d707a5fc823f625a4ce2756c3547b; path=/"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"1867"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Organizations\",\n \"items\": {\n \"title\": \"Organization\",\n \"required\": [\n \"id\",\n \"name\",\n \"active\",\n \"departments\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Organization Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/items/properties/id\"\n },\n \"name\": {\n \"title\": \"Organization name\",\n \"$ref\": \"#/definitions/companyName\",\n \"$id\": \"#/items/properties/name\"\n },\n \"active\": {\n \"title\": \"Is active?\",\n \"default\": 0,\n \"examples\": [\n 1\n ],\n \"$id\": \"#/items/properties/active\",\n \"type\": \"integer\"\n },\n \"departments\": {\n \"title\": \"Departments\",\n \"items\": {\n \"title\": \"Department\",\n \"required\": [\n \"id\",\n \"name\",\n \"parent\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Department Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/items/properties/departments/items/properties/id\"\n },\n \"name\": {\n \"title\": \"Department name\",\n \"$ref\": \"#/definitions/companyName\",\n \"$id\": \"#/items/properties/departments/items/properties/name\"\n },\n \"parent\": {\n \"title\": \"Parent organization Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/items/properties/departments/items/properties/parent\"\n }\n },\n \"$id\": \"#/items/properties/departments/items\",\n \"type\": \"object\"\n },\n \"$id\": \"#/items/properties/departments\",\n \"type\": \"array\"\n }\n },\n \"$id\": \"#/items\",\n \"type\": \"object\"\n },\n \"definitions\": {\n \"uuid\": {\n \"$id\": \"#/definitions/uuid\",\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"default\": \"\",\n \"examples\": [\n \"ee4d906f-2eca-4345-9907-a4c6c2fcd931\"\n ]\n },\n \"companyName\": {\n \"$id\": \"#/definitions/companyName\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^[0-9a-öA-Ö \\\\-_.`'\\\"]+$\",\n \"examples\": [\n \"Evimeria EMR AB\",\n \"Evimeria EMR AB Utveckling Team' FHV\"\n ]\n }\n },\n \"$id\": \"http://webdoc.api/response/v1/get/organizations\",\n \"type\": \"array\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}"}],"_postman_id":"1da7d871-4e2a-4c85-a852-f924f12c8a81"},{"name":"Organizations","id":"5266ad39-bf82-4e3a-8842-adeb289d66c2","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"rows\": [\n {\n \"city\": \"Göteborg\",\n \"companyText\": \"Detta är companyText\",\n \"email\": \"user@evimeria.com\",\n \"invoiceCity\": \"Göteborg\",\n \"invoiceEmail\": \"user@evimeria.com\",\n \"invoiceStreetAddress\": \"Box 123\",\n \"invoiceZipCode\": \"123 45\",\n \"level_1\": \"Företag AB\",\n \"level_2\": null,\n \"level_3\": null,\n \"level_4\": null,\n \"level_5\": null,\n \"level_6\": null,\n \"level_7\": null,\n \"organizationNumber\": \"556896-8001\",\n \"streetAddress\": \"Gatan 1\",\n \"zipCode\": \"123 45\"\n },\n {\n \"city\": \"Göteborg\",\n \"companyText\": \"Detta är companyText\",\n \"email\": \"user@evimeria.com\",\n \"invoiceCity\": \"Göteborg\",\n \"invoiceEmail\": \"user@evimeria.com\",\n \"invoiceStreetAddress\": \"Box 123\",\n \"invoiceZipCode\": \"123 45\",\n \"level_1\": \"Företag AB\",\n \"level_2\": \"Underavdelning\",\n \"level_3\": null,\n \"level_4\": null,\n \"level_5\": null,\n \"level_6\": null,\n \"level_7\": null,\n \"organizationNumber\": \"556896-8001\",\n \"streetAddress\": \"Gatan 1\",\n \"zipCode\": \"123 45\"\n },\n {\n \"city\": \"Göteborg\",\n \"companyText\": \"Detta är companyText\",\n \"email\": \"user@evimeria.com\",\n \"invoiceCity\": \"Göteborg\",\n \"invoiceEmail\": \"user@evimeria.com\",\n \"invoiceStreetAddress\": \"Box 123\",\n \"invoiceZipCode\": \"123 45\",\n \"level_1\": \"Företag AB\",\n \"level_2\": \"Underavdelning\",\n \"level_3\": \"UnderUnderAvdelning1\",\n \"level_4\": null,\n \"level_5\": null,\n \"level_6\": null,\n \"level_7\": null,\n \"organizationNumber\": \"556896-8001\",\n \"streetAddress\": \"Gatan 1\",\n \"zipCode\": \"123 45\"\n },\n {\n \"city\": \"Göteborg\",\n \"companyText\": \"Detta är companyText\",\n \"email\": \"user@evimeria.com\",\n \"invoiceCity\": \"Göteborg\",\n \"invoiceEmail\": \"user@evimeria.com\",\n \"invoiceStreetAddress\": \"Box 123\",\n \"invoiceZipCode\": \"123 45\",\n \"level_1\": \"Företag AB\",\n \"level_2\": \"Underavdelning\",\n \"level_3\": \"UnderUnderAvdelning2\",\n \"level_4\": null,\n \"level_5\": null,\n \"level_6\": null,\n \"level_7\": null,\n \"organizationNumber\": \"556896-8001\",\n \"streetAddress\": \"Gatan 1\",\n \"zipCode\": \"123 45\"\n },\n {\n \"city\": \"Göteborg\",\n \"companyText\": \"Detta är companyText\",\n \"email\": \"user@evimeria.com\",\n \"invoiceCity\": \"Göteborg\",\n \"invoiceEmail\": \"user@evimeria.com\",\n \"invoiceStreetAddress\": \"Box 123\",\n \"invoiceZipCode\": \"123 45\",\n \"level_1\": \"Företag AB\",\n \"level_2\": \"Underavdelning\",\n \"level_3\": \"UnderUnderAvdelning1\",\n \"level_4\": \"UnderUnderUnderAvdelning1\",\n \"level_5\": null,\n \"level_6\": null,\n \"level_7\": null,\n \"organizationNumber\": \"556896-8001\",\n \"streetAddress\": \"Gatan 1\",\n \"zipCode\": \"123 45\"\n }\n ]\n}"},"url":"{{url}}/v1/organization/organizations","description":"

This endpoint can be used to create organization.

\n

Available parameters (bold are required):

\n
    \n

  • invoiceStreetAddress
    (The address of the invoice address)

    \n
    • \n

  • invoiceCity
    (The city of the invoice address)

    \n
    • \n

  • invoiceZipCode
    (The zip code of the invoice address, max 10 characters)_

    \n
    • \n

  • organizationNumber
    (A valid organization number)

    \n
    • \n

  • level_1
    (The name of the organization)

    \n
    • \n

  • level_2...7
    (The name of the department)

    \n
    • \n

  • invoiceEmail
    (The email of the invoice address)

    \n
    • \n

  • companyText
    (Note for the organization)

    \n
    • \n

  • email
    (The email of the organization)

    \n
    • \n

  • streetAddress
    (The address of the organization)

    \n
    • \n

  • zipCode
    (The zip code of the organization, max 10 characters)

    \n
    • \n

  • city
    (The city of the organization)

    \n
    • \n
\n

Allowed with the following scopes:

\n
    \n

  • patient:write

    \n
    • \n

  • organization:write

    \n
    • \n
\n","urlObject":{"path":["v1","organization","organizations"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d5ead3ff-2985-4691-be3b-e8cdd9105e68","name":"Organization created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"rows\": [\n {\n \"city\": \"Göteborg\",\n \"companyText\": \"Detta är companyText\",\n \"email\": \"user@evimeria.com\",\n \"invoiceCity\": \"Göteborg\",\n \"invoiceEmail\": \"user@evimeria.com\",\n \"invoiceStreetAddress\": \"FE-5625-01112 Scancloud\",\n \"invoiceZipCode\": \"123 45\",\n \"level_1\": \"Företag AB\",\n \"level_2\": null,\n \"level_3\": null,\n \"level_4\": null,\n \"level_5\": null,\n \"level_6\": null,\n \"level_7\": null,\n \"organizationNumber\": \"556896-8001\",\n \"streetAddress\": \"Gatan 1\",\n \"zipCode\": \"123 45\"\n },\n {\n \"city\": \"Göteborg\",\n \"companyText\": \"Detta är companyText\",\n \"email\": \"user@evimeria.com\",\n \"invoiceCity\": \"Göteborg\",\n \"invoiceEmail\": \"user@evimeria.com\",\n \"invoiceStreetAddress\": \"FE-5625-01112 Scancloud\",\n \"invoiceZipCode\": \"123 45\",\n \"level_1\": \"Företag AB\",\n \"level_2\": \"Underavdelning\",\n \"level_3\": null,\n \"level_4\": null,\n \"level_5\": null,\n \"level_6\": null,\n \"level_7\": null,\n \"organizationNumber\": \"556896-8001\",\n \"streetAddress\": \"Gatan 1\",\n \"zipCode\": \"123 45\"\n },\n {\n \"city\": \"Göteborg\",\n \"companyText\": \"Detta är companyText\",\n \"email\": \"user@evimeria.com\",\n \"invoiceCity\": \"Göteborg\",\n \"invoiceEmail\": \"user@evimeria.com\",\n \"invoiceStreetAddress\": \"FE-5625-01112 Scancloud\",\n \"invoiceZipCode\": \"123 45\",\n \"level_1\": \"Företag AB\",\n \"level_2\": \"Underavdelning\",\n \"level_3\": \"UnderUnderAvdelning1\",\n \"level_4\": null,\n \"level_5\": null,\n \"level_6\": null,\n \"level_7\": null,\n \"organizationNumber\": \"556896-8001\",\n \"streetAddress\": \"Gatan 1\",\n \"zipCode\": \"123 45\"\n },\n {\n \"city\": \"Göteborg\",\n \"companyText\": \"Detta är companyText\",\n \"email\": \"user@evimeria.com\",\n \"invoiceCity\": \"Göteborg\",\n \"invoiceEmail\": \"user@evimeria.com\",\n \"invoiceStreetAddress\": \"FE-5625-01112 Scancloud\",\n \"invoiceZipCode\": \"123 45\",\n \"level_1\": \"Företag AB\",\n \"level_2\": \"Underavdelning\",\n \"level_3\": \"UnderUnderAvdelning2\",\n \"level_4\": null,\n \"level_5\": null,\n \"level_6\": null,\n \"level_7\": null,\n \"organizationNumber\": \"556896-8001\",\n \"streetAddress\": Gatan 1\",\n \"zipCode\": \"123 45\"\n },\n {\n \"city\": \"Göteborg\",\n \"companyText\": \"Detta är companyText\",\n \"email\": \"user@evimeria.com\",\n \"invoiceCity\": \"Göteborg\",\n \"invoiceEmail\": \"user@evimeria.com\",\n \"invoiceStreetAddress\": \"FE-5625-01112 Scancloud\",\n \"invoiceZipCode\": \"123 45\",\n \"level_1\": \"Företag AB\",\n \"level_2\": \"Underavdelning\",\n \"level_3\": \"UnderUnderAvdelning1\",\n \"level_4\": \"UnderUnderUnderAvdelning1\",\n \"level_5\": null,\n \"level_6\": null,\n \"level_7\": null,\n \"organizationNumber\": \"556896-8001\",\n \"streetAddress\": \"Gatan 1\",\n \"zipCode\": \"123 45\"\n }\n ]\n}"},"url":"{{url}}/v1/organization/organizations"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"7a112c49-524a-462a-a174-250f716e54f6\"\n}"},{"id":"56205ef5-40a7-438d-8ff1-0ad36a8eb37f","name":"JSON Schema","originalRequest":{"method":"GET","header":[{"key":"JSON_Schema","value":"true"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"POST Organizations request\",\n \"required\": [\n \"rows\"\n ],\n \"properties\": {\n \"rows\": {\n \"title\": \"Organizations\",\n \"items\": {\n \"title\": \"Organization\",\n \"required\": [\n \"city\",\n \"companyText\",\n \"email\",\n \"invoiceCity\",\n \"invoiceEmail\",\n \"invoiceStreetAddress\",\n \"invoiceZipCode\",\n \"level_1\",\n \"level_2\",\n \"level_3\",\n \"level_4\",\n \"level_5\",\n \"level_6\",\n \"level_7\",\n \"organizationNumber\",\n \"streetAddress\",\n \"zipCode\"\n ],\n \"properties\": {\n \"city\": {\n \"title\": \"Organization city\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Göteborg\"\n ],\n \"$id\": \"#/properties/rows/items/properties/city\",\n \"type\": \"string\"\n },\n \"companyText\": {\n \"title\": \"Organization text\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Detta är companyText\"\n ],\n \"$id\": \"#/properties/rows/items/properties/companyText\",\n \"type\": \"string\"\n },\n \"email\": {\n \"title\": \"Organization email\",\n \"default\": \"\",\n \"format\": \"email\",\n \"examples\": [\n \"user@evimeria.com\"\n ],\n \"$id\": \"#/properties/rows/items/properties/email\",\n \"type\": \"string\"\n },\n \"invoiceCity\": {\n \"title\": \"Invoice city\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Göteborg\"\n ],\n \"$id\": \"#/properties/rows/items/properties/invoiceCity\",\n \"type\": \"string\"\n },\n \"invoiceEmail\": {\n \"title\": \"Invoice email\",\n \"default\": \"\",\n \"format\": \"email\",\n \"examples\": [\n \"user@evimeria.com\"\n ],\n \"$id\": \"#/properties/rows/items/properties/invoiceEmail\",\n \"type\": \"string\"\n },\n \"invoiceStreetAddress\": {\n \"title\": \"Invoice street address\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Box 123\"\n ],\n \"$id\": \"#/properties/rows/items/properties/invoiceStreetAddress\",\n \"type\": \"string\"\n },\n \"invoiceZipCode\": {\n \"title\": \"Invoice Zip code\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"123 45\"\n ],\n \"$id\": \"#/properties/rows/items/properties/invoiceZipCode\",\n \"type\": \"string\"\n },\n \"level_1\": {\n \"title\": \"Level 1\",\n \"$ref\": \"#/definitiobs/level\", \n \"$id\": \"#/properties/rows/items/properties/level_1\"\n },\n \"level_2\": {\n \"title\": \"Level 2\",\n \"$ref\": \"#/definitiobs/level\", \n \"$id\": \"#/properties/rows/items/properties/level_2\"\n },\n \"level_3\": {\n \"title\": \"Level 3\",\n \"$ref\": \"#/definitiobs/level\", \n \"$id\": \"#/properties/rows/items/properties/level_3\"\n },\n \"level_4\": {\n \"title\": \"Level 4\",\n \"$ref\": \"#/definitiobs/level\", \n \"$id\": \"#/properties/rows/items/properties/level_4\"\n },\n \"level_5\": {\n \"title\": \"Level 5\",\n \"$ref\": \"#/definitiobs/level\", \n \"$id\": \"#/properties/rows/items/properties/level_5\"\n },\n \"level_6\": {\n \"title\": \"Level 6\",\n \"$ref\": \"#/definitiobs/level\", \n \"$id\": \"#/properties/rows/items/properties/level_6\"\n },\n \"level_7\": {\n \"title\": \"null value\",\n \"$ref\": \"#/definitiobs/level\", \n \"$id\": \"#/properties/rows/items/properties/level_7\"\n },\n \"organizationNumber\": {\n \"title\": \"Organization number\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"380107-6377\"\n ],\n \"$id\": \"#/properties/rows/items/properties/organizationNumber\",\n \"type\": \"string\"\n },\n \"streetAddress\": {\n \"title\": \"Street address\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Gatan 1\"\n ],\n \"$id\": \"#/properties/rows/items/properties/streetAddress\",\n \"type\": \"string\"\n },\n \"zipCode\": {\n \"title\": \"Zip code\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"123 45\"\n ],\n \"$id\": \"#/properties/rows/items/properties/zipCode\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/properties/rows/items\",\n \"type\": \"object\"\n },\n \"$id\": \"#/properties/rows\",\n \"type\": \"array\"\n }\n },\n \"definitions\": {\n \"level\": {\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Företag AB\", null\n ],\n \"$id\": \"#/definitiobs/level\",\n \"oneOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"$id\": \"http://webdoc.api/request/v1/post/organization\",\n \"type\": \"object\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/organization/organizations","host":["{{url}}"],"path":["v1","organization","organizations"],"query":[{"key":"personalNumber","value":"19121212-1212","description":"_Optional_ - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX.\nForeign personal numbers are also supported. The format needs to be YYYYMMDD-ZXXX, YYYYMMDD+ZXXX, YYYYMMDDZXXX or even in the reduced format of YYMMDD-ZXXX, YYMMDD+ZXXX and YYMMDDZXXX where Z is either M, K or X.","disabled":true},{"key":"date","value":"2021-01-01","description":"_Optional_ - Bookings date in the format of YYYY-MM-DD. Timezone: 'CET'.","disabled":true},{"key":"fromDate","value":"2020-01-01","description":"_Optional_ - Lower limit date in the format of YYYY-MM-DD. Timezone: 'CET'.","disabled":true},{"key":"toDate","value":"2021-02-01","description":"_Optional_ - Upper limit date in the format of YYYY-MM-DD. Timezone: 'CET'.","disabled":true},{"key":"arrived","value":"2","description":"_Optional_ - Filter bookings by arrived status.\n\\\n\\\n**Search values:**\n* 0 - Not arrived\n* 1 - Arrived, but not paid\n* 2 - Arrived and paid","disabled":true},{"key":"selfService","value":"true","description":"_Optional_ - Filter bookings by booking type with self service flag.\n\\\n**Default:** true","disabled":true},{"key":"bookingTypeId","value":"9","description":"_Optional_ - Filter bookings with the given booking type id.","disabled":true},{"key":"booked","value":"true","description":"_Optional_ - Booking state selector.\n\\\n\\\nThis is a ternary filter:\n* true - Select booked time slots.\n* false - Select available time slots.\n* <empty> - Leave empty to select all time slots - both booked and available.","disabled":true},{"key":"userId","value":"{{userId}}","description":"_Optional_ - Filter bookings by a caregiver based on a userId (UUID).","disabled":true},{"key":"limit","value":"10","description":"_Optional_ - Limit the number of bookings that's being returned","disabled":true},{"key":"offset","value":"0","description":"_Optional_ - Offset the bookings that's being returned","disabled":true},{"key":"reservedForOrganizationId","value":"50","description":"_Optional_ - Get bookings that are reserved to an organization","disabled":true},{"key":"reservedForDepartmentId","value":"65","description":"_Optional_ - Get bookings that are reserved to a department","disabled":true}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 02 Dec 2022 19:34:01 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.13"},{"key":"Set-Cookie","value":"PHPSESSID=6f7d707a5fc823f625a4ce2756c3547b; path=/"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"1867"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"POST Organizations response\",\n \"required\": [\n \"uuid\" \n ],\n \"properties\": {\n \"uuid\": {\n \"title\": \"Organazation Id\",\n \"default\": \"\",\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"examples\": [\n \"afdbe47a-abe4-4be2-8975-bf80ea0966f3\"\n ],\n \"$id\": \"#/properties/uuid\"\n }\n },\n \"$id\": \"http://webdoc.api/response/v1/post/organization\",\n \"type\": \"object\",\n \"definitions\": {},\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}"}],"_postman_id":"5266ad39-bf82-4e3a-8842-adeb289d66c2"},{"name":"Patients To Organizations","id":"fb205f33-13db-4ef6-a9c5-a9901074e298","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"grant_type":"","client_authentication":"","scope":"{{authScopes}}","clientSecret":"{{authClientSecret}}","clientId":"{{authClientId}}"},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"patientId\": \"4165f4fa-f41f-434d-a420-578fd99e6beb\",\n \"departmentId\": \"78fd99e6beb-f41f-434d-a420-f41f434d\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/organizations/:organizationId/patient","description":"

This endpoint can be called to add a patient to an organization. If the patient already has a relation to an organization this will be replaced.

\n

Available parameters (bold are required):

\n
    \n

  • patientId
    (The ID of the patient in UUID format.)

    \n
    • \n

  • departmentId
    (The ID of the department in UUID format.)

    \n
    • \n
\n

Allowed with the following scopes:

\n
    \n

  • patient:write

    \n
    • \n

  • organization:write

    \n
    • \n
\n","urlObject":{"path":["v1","organizations",":organizationId","patient"],"host":["{{url}}"],"query":[],"variable":[{"description":{"content":"

Mandatory - The organization uuid

\n","type":"text/plain"},"type":"any","value":"12345678-1234-1234-1234-123456789ABC","key":"organizationId"}]}},"response":[{"id":"54f26753-fe3c-4ad4-9b31-0129940bdfd9","name":"Created","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"patientId\": \"4165f4fa-f41f-434d-a420-578fd99e6beb\",\n \"departmentId\": \"78fd99e6beb-f41f-434d-a420-f41f434d\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/organizations/{$organizationId}/patient"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"7fe7936e-8153-4d2c-9986-784d0ab4ecc7","name":"Patient not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"patientId\": \"non-existing-patient\",\"departmentId\":\"78fd99e6beb-f41f-434d-a420-f41f434d\"}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/organizations/{$organizationId}/patient"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1008,\n \"message\": \"Invalid API Request (Patient not found)\"\n }\n}"},{"id":"86d4ae99-4f67-4555-80d1-5475074747bd","name":"Organization not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"patientId\": \"4165f4fa-f41f-434d-a420-578fd99e6beb\",\"departmentId\":\"non-existing-department\"}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/organizations/{$organizationId}/patient"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1008,\n \"message\": \"Invalid API Request (Organisazion not found)\"\n }\n}"},{"id":"c2b66384-1b90-470f-ad95-cfbbcdf8a134","name":"JSON Schema","originalRequest":{"method":"GET","header":[{"key":"JSON_Schema","value":"true"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"PUT Add Patient to Organazation request\",\n \"required\": [\n \"patientId\",\n \"departmentId\"\n ],\n \"properties\": {\n \"patientId\": {\n \"title\": \"Patient's Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/properties/patientId\"\n },\n \"departmentId\": {\n \"title\": \"Department Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/properties/departmentId\"\n }\n },\n \"$id\": \"http://webdoc.api/request/v1/put/organizations\",\n \"type\": \"object\",\n \"definitions\": {\n \"uuid\": {\n \"$id\": \"#/definitions/uuid\",\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"default\": \"\",\n \"examples\": [\n \"ee4d906f-2eca-4345-9907-a4c6c2fcd931\"\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/organizations/:organizationId/patient","host":["{{url}}"],"path":["v1","organizations",":organizationId","patient"],"variable":[{"key":"organizationId","value":"organaization-uuid"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 02 Dec 2022 19:34:01 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.13"},{"key":"Set-Cookie","value":"PHPSESSID=6f7d707a5fc823f625a4ce2756c3547b; path=/"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"1867"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"PUT Add Patient to Organazation response\",\n \"required\": [],\n \"properties\": {},\n \"$id\": \"http://webdoc.api/response/v1/put/organizations\",\n \"type\": \"object\",\n \"definitions\": {},\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}"}],"_postman_id":"fb205f33-13db-4ef6-a9c5-a9901074e298"}],"id":"5441ce72-0e73-461c-919b-3fba4cd0306f","_postman_id":"5441ce72-0e73-461c-919b-3fba4cd0306f","description":""}],"id":"47ffbf0f-8c6f-410d-af0b-1f273b3e91f2","_postman_id":"47ffbf0f-8c6f-410d-af0b-1f273b3e91f2","description":""},{"name":"Patients","item":[{"name":"v1","item":[{"name":"Patients (deprecated)","id":"3cce14c2-56f3-4a64-b41c-070628eec53f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[{"description":"

Required - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX.

\n","key":"personalNumber","type":"text","value":"19121212-1212"}],"url":"{{url}}/v1/patients","description":"

Note! This endpoint is deprecated, please use GET /v2/patients instead!

\n

Fetch information for a specific patient in Webdoc. If the patient is not found in Webdoc then an error code is returned.

\n

Allowed with one of the following scopes:

\n
    \n

  • self-service

    \n
    • \n

  • patient:read

    \n
    • \n

  • patient:write

    \n
    • \n
\n","urlObject":{"path":["v1","patients"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"63b3e055-9ee2-480b-8910-ee9ceef2a93e","name":"Patients","originalRequest":{"method":"GET","header":[{"key":"personalNumber","value":"19121212-1212","description":"Mandatory - The social security number of a patient."}],"url":"{{url}}/v1/patients"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":" {\n \"id\": \"80b3c7b9-f7cb-4e65-9ce5-cca18befcbea\",\n \"personalNumber\": \"19121212-1212\",\n \"birthDate\": \"1912-12-12\",\n \"gender\": \"M\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address\": {\n \"streetName\": \"Test Address 123\",\n \"coAddress\": \"Jane Doe\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\"\n },\n \"nationality\": \"Sweden\",\n \"email\": \"doe@example.com\",\n \"mobilePhoneNumber\": \"+46701740605\",\n \"workPhoneNumber\": \"\",\n \"homePhoneNumber\": \"031-3900613\",\n \"listedClinic\": {\n \"hsaId\": \"SE1234567890-1231\"\n },\n \"interpreterNeeded\": false,\n \"interpreterLanguage\": \"\",\n \"patientType\": {\n \"id\": \"1\",\n \"name\": \"Private\"\n }\n }"}],"_postman_id":"3cce14c2-56f3-4a64-b41c-070628eec53f"},{"name":"Current Patient","id":"0e42c0af-fc86-44b4-b991-547a89a01f7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"personalNumber\": \"19121212-1212\",\n \"showWarning\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/currentUser/currentPatient","description":"

Switch patient for the user assigned to the token. If the token is not assigned to a user the function will fail. In other words, this endpoint requires grant_type \"authorization_code\" to get an access token based on a userId.

\n

(You can read a more detailed tutorial about the Webdoc SSO flow with \"PUT Current Patient\" on the Integrator Portal: https://integratorportal.carasent.net/faq/wd-sso-put-current-patient-docs)

\n

Allowed with the following scope:

\n
    \n
  • patient:write
    • \n
\n","urlObject":{"path":["v1","currentUser","currentPatient"],"host":["{{url}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"da9ae9bf-c88c-4631-b804-3581fc775079","name":"Current Patient","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"personalNumber\": \"19121212-1212\",\n \"showWarning\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/currentUser/currentPatient"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0e42c0af-fc86-44b4-b991-547a89a01f7e"},{"name":"National Registry","id":"ce70e270-6bdb-4cf4-b8fd-d97ac6b1bae1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/v1/nationalRegistry/:personalNumber","description":"

Fetch information from the national registry for a requested person.

\n

Note! This endpoint requires SPAR configuration in the production environment for each Webdoc system.

\n

Allowed with one of the following scopes:

\n
    \n
  • self-service
    • \n
  • patient:read
    • \n
  • patient:write
    • \n
\n","urlObject":{"path":["v1","nationalRegistry",":personalNumber"],"host":["{{url}}"],"query":[],"variable":[{"description":{"content":"

Required - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX.

\n","type":"text/plain"},"type":"any","value":"19121212-1212","key":"personalNumber"}]}},"response":[{"id":"9fc7e3a6-d90f-495a-8a34-3d4f00dfc02a","name":"National Registry","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/nationalRegistry/:personalNumber","host":["{{url}}"],"path":["v1","nationalRegistry",":personalNumber"],"variable":[{"key":"personalNumber","value":"19121212-1212","description":"_Required_ - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"unRegisterCauseCode\": null,\n \"firstName\": \"Jimmy\",\n \"lastName\": \"Doe\",\n \"spokenName\": \"Jimmy\",\n \"maritialStatus\": \"\",\n \"coAddress\": \"John Doe\",\n \"address\": \"West Street 123\",\n \"zipCode\": \"55555\",\n \"city\": \"Gothenburg\",\n \"stateCode\": \"se\",\n \"countyCode\": \"46\",\n \"parish\": \"\",\n \"deceased\": \"0\"\n}"},{"id":"6e4674e1-d496-4ec2-a777-ec10a241bdf6","name":"JSON Schema","originalRequest":{"method":"GET","header":[{"key":"personalNumber","value":"121212-1212","description":"_Optional_ - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX.","disabled":true},{"key":"JSON_Schema","value":"true"}],"url":{"raw":"{{url}}/v1/nationalRegistry/:personalNumber","host":["{{url}}"],"path":["v1","nationalRegistry",":personalNumber"],"variable":[{"key":"personalNumber","value":"19121212-1212"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"National registry\",\n \"required\": [\n \"unRegisterCauseCode\",\n \"firstName\",\n \"lastName\",\n \"spokenName\",\n \"maritialStatus\",\n \"coAddress\",\n \"address\",\n \"zipCode\",\n \"city\",\n \"stateCode\",\n \"countyCode\",\n \"parish\",\n \"deceased\"\n ],\n \"properties\": {\n \"unRegisterCauseCode\": {\n \"title\": \"Unregister cause code\",\n \"default\": null,\n \"examples\": [\n null\n ],\n \"$id\": \"#/properties/unRegisterCauseCode\",\n \"type\": \"null\"\n },\n \"firstName\": {\n \"title\": \"First name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Jimmy\"\n ],\n \"$id\": \"#/properties/firstName\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"title\": \"Last name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Doe\"\n ],\n \"$id\": \"#/properties/lastName\",\n \"type\": \"string\"\n },\n \"spokenName\": {\n \"title\": \"Given name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Jimmy\"\n ],\n \"$id\": \"#/properties/spokenName\",\n \"type\": \"string\"\n },\n \"maritialStatus\": {\n \"title\": \"Maritial status\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"\"\n ],\n \"$id\": \"#/properties/maritialStatus\",\n \"type\": \"string\"\n },\n \"coAddress\": {\n \"title\": \"C/O Address\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"John Doe\"\n ],\n \"$id\": \"#/properties/coAddress\",\n \"type\": \"string\"\n },\n \"address\": {\n \"title\": \"Address\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"West Street 123\"\n ],\n \"$id\": \"#/properties/address\",\n \"type\": \"string\"\n },\n \"zipCode\": {\n \"title\": \"Post code / Zip code\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"55555\"\n ],\n \"$id\": \"#/properties/zipCode\",\n \"type\": \"string\"\n },\n \"city\": {\n \"title\": \"City\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Gothenburg\"\n ],\n \"$id\": \"#/properties/city\",\n \"type\": \"string\"\n },\n \"stateCode\": {\n \"title\": \"State code\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"se\"\n ],\n \"$id\": \"#/properties/stateCode\",\n \"type\": \"string\"\n },\n \"countyCode\": {\n \"title\": \"County code\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"46\"\n ],\n \"$id\": \"#/properties/countyCode\",\n \"type\": \"string\"\n },\n \"parish\": {\n \"title\": \"Parish\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"\"\n ],\n \"$id\": \"#/properties/parish\",\n \"type\": \"string\"\n },\n \"deceased\": {\n \"title\": \"Is the person deceased\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"0\"\n ],\n \"$id\": \"#/properties/deceased\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"http://webdoc.api/response/patients/v1/get/national_registry\",\n \"type\": \"object\",\n \"definitions\": {},\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}"}],"_postman_id":"ce70e270-6bdb-4cf4-b8fd-d97ac6b1bae1"},{"name":"Patients","id":"45a3c652-8aeb-47be-baf1-42531922a6a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"personalNumber\": \"19121212-1212\",\n \"listInfo\": {\n \"name\": \"Test clinic\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Test County\"\n },\n \"patientType\": \"Private\",\n \"email\": \"test.mail@example.com\",\n \"mobileNumber\": \"+46701740605\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/patients","description":"

This endpoint can be used to create a new patient in Webdoc.

\n

(You can read a more detailed tutorial about the patient flows via API on the Integrator Portal: https://integratorportal.carasent.net/faq/wd-external-cru-requests-of-patients-docs)

\n

NOTE! This endpoint requires SPAR configuration in the production environment for each Webdoc system.

\n

Available post parameters (bold parameters are required):

\n
    \n
  • personalNumber
    (The personal number of the patient in the format of \"YYYYMMDD-XXXX\" or \"YYYYMMDDXXXX\".)
    • \n
  • patientType
    (The name of the patient type. The patient type has to exist in Webdoc and match the exact spelling of the name to be valid. See the list of available patient types by using the \"GET Patient Types\" endpoint.)
    • \n
  • listInfo
    • \n
  • email
    • \n
  • mobileNumber
    (Example of valid phone number formats: \"0701740606\", \"070-174 06 06\",
    \"+46701740606\", \"(+46)070-174 06 06\".)
    • \n
\n

Allowed with the following scope:

\n
    \n
  • patient:write
    • \n
\n","urlObject":{"path":["v1","patients"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ff05fcd1-4462-4944-a3ad-0d321e10fa4e","name":"Patients","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"personalNumber\": \"19121212-1212\",\n \"listInfo\": {\n \"name\": \"The clinic\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Rohan\"\n },\n \"patientType\": \"Private\", // Should match the patient type name in Webdoc\n \"email\": \"jimmy@example.com\",\n \"mobileNumber\": \"070-1740677\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/patients"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"12345678-1234-1234-1234-123456789ABC\",\n \"personalNumber\": \"19121212-1212\",\n \"firstName\": \"Jimmy\",\n \"lastName\": \"Doe\",\n \"birthDate\": \"1912-12-12\",\n \"gender\": \"M\",\n \"contact\": {\n \"streetName\": \"Test Street 123\",\n \"zipCode\": \"55555\",\n \"coAddress\": \"Co Address 123\",\n \"city\": \"Gothenburg\",\n \"homePhone\": \"070-1740606\",\n \"workPhone\": \"070-1740607\",\n \"mobile\": \"+46701740605\",\n \"email\": \"jimmy@example.com\",\n \"tempAddress\": {\n \"tempStreetName\": \"West Street 345\",\n \"tempZipCode\": \"55551\",\n \"tempCoAddress\": \"John Doe\",\n \"tempCity\": \"Stockholm\",\n \"tempValidUntil\": \"2022-11-21\"\n }\n },\n \"listInfo\": {\n \"name\": \"The clinic\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Rohan\"\n },\n \"patientType\": \"Private\",\n \"nationality\": \"Sweede\",\n \"interpreterNeed\": \"false\",\n \"interpreterLanguage\": \"\",\n \"registerAsOf\": \"2019-11-07 16:00:26\"\n }\n]"},{"id":"23acaa65-af9f-45f1-a7d2-fc14e41ab905","name":"Mobile number has invalid characters","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"personalNumber\": \"19121212-1212\",\n \"listInfo\": {\n \"name\": \"The clinic\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Rohan\"\n },\n \"patientType\": \"Private\",\n \"email\": \"jimmy@example.com\",\n \"mobileNumber\": \"a070-1740635\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/patients"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1008,\n \"message\": \"Ogiltigt API anrop (Patient mobile number:'a070-1740635' has invalid characters)\"\n }\n}"},{"id":"ceeff8dd-7a17-4198-9a1e-6c1e4b957cf5","name":"Mobile number too long","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"personalNumber\": \"19121212-1212\",\n \"listInfo\": {\n \"name\": \"The clinic\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Rohan\"\n },\n \"patientType\": \"Private\",\n \"email\": \"jimmy@example.com\",\n \"mobileNumber\": \"070-1740635123456\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/patients"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1008,\n \"message\": \"Ogiltigt API anrop (Patient mobile number:'070-1740635123456' is too long)\"\n }\n}"},{"id":"598de992-c98f-4d40-aa81-1aad343e9705","name":"Mobile number is invalid","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"personalNumber\": \"19121212-1212\",\n \"listInfo\": {\n \"name\": \"The clinic\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Rohan\"\n },\n \"patientType\": \"Private\",\n \"email\": \"jimmy@example.com\",\n \"mobileNumber\": \"0028701740635\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/patients"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1008,\n \"message\": \"Ogiltigt API anrop (Patient mobile number:'0028701740635' is invalid)\"\n }\n}"},{"id":"44eab609-fb79-4f8f-9071-05fbece2d940","name":"Mobile number too short","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"personalNumber\": \"19121212-1212\",\n \"listInfo\": {\n \"name\": \"The clinic\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Rohan\"\n },\n \"patientType\": \"Private\",\n \"email\": \"jimmy@example.com\",\n \"mobileNumber\": \"031\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/patients"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1008,\n \"message\": \"Ogiltigt API anrop (Patient mobile number:'031' is too short)\"\n }\n}"}],"_postman_id":"45a3c652-8aeb-47be-baf1-42531922a6a2"},{"name":"Patients","id":"173b00a0-4f51-4c79-9cb3-43c7516ff136","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"listInfo\":{\n \"name\": \"Jimmy\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Rohan\"\n },\n \"patientType\": \"Private\",\n \"email\": \"tol@example.com\",\n \"mobileNumber\": \"+46701740615\",\n \"firstName\": \"Jimmy\",\n \"lastName\": \"Doe\",\n \"spokenName\": \"Jimmy\",\n \"address\": \"Street address 1\",\n \"coAddress\": \"The neighbours\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"55550\",\n \"stateCode\": \"14\",\n \"countyCode\": \"80\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/patients/:personalNumber","description":"

This endpoint can be used to update the information of an existing patient in Webdoc such as: list info, email, mobile number.

\n

Moreover, the patient must exist in Webdoc, otherwise an error code will be returned.

\n

(You can read a more detailed tutorial about the patient flows via API on the Integrator Portal: https://integratorportal.carasent.net/faq/wd-external-cru-requests-of-patients-docs)

\n

Allowed with the following scope:

\n
    \n
  • patient:write
    • \n
\n","urlObject":{"path":["v1","patients",":personalNumber"],"host":["{{url}}"],"query":[],"variable":[{"description":{"content":"

Required - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX.\nForeign personal numbers are also supported. The format needs to be YYYYMMDD-ZXXX, YYYYMMDD+ZXXX, YYYYMMDDZXXX or even in the reduced format of YYMMDD-ZXXX, YYMMDD+ZXXX and YYMMDDZXXX where Z is either M, K or X.

\n","type":"text/plain"},"type":"any","value":"19121212-1212","key":"personalNumber"}]}},"response":[{"id":"e0b84177-ad85-4561-9f2e-f5289b20e9aa","name":"Patients","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"listInfo\":{\n \"name\": \"The clinic\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Rohan\"\n },\n \"patientType\": \"Private\",\n \"email\": \"tol@example.com\",\n \"mobileNumber\": \"+46701740632\",\n \"firstName\": \"Tolvan\",\n \"lastName\": \"Tolvansson\",\n \"spokenName\": \"Tolvan\",\n \"address\": \"Street address 1\",\n \"coAddress\": \"The neighbour\",\n \"city\": \"GÖTEBORG\",\n \"zipCode\": \"41263\",\n \"stateCode\": \"14\",\n \"countyCode\": \"80\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/patients/:personalNumber","host":["{{url}}"],"path":["v1","patients",":personalNumber"],"variable":[{"key":"personalNumber","value":"19121212-1212"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"196c7556-48e7-4a0f-b934-2018582d5c87","name":"Mobile number has invalid characters","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"listInfo\":{\n \"name\": \"Tolvan\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Rohan\"\n },\n \"patientType\": \"Privat\",\n \"email\": \"tol@example.com\",\n \"mobileNumber\": \"a070-1740635\",\n \"firstName\": \"Tolvan\",\n \"lastName\": \"Tolvansson\",\n \"spokenName\": \"Tolvan\",\n \"address\": \"Street address 1\",\n \"coAddress\": \"The neighbour\",\n \"city\": \"GÖTEBORG\",\n \"zipCode\": \"41263\",\n \"stateCode\": \"14\",\n \"countyCode\": \"80\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/patients/:personalNumber","host":["{{url}}"],"path":["v1","patients",":personalNumber"],"variable":[{"key":"personalNumber","value":"19121212-1212","description":"_Mandatory_ - The social security number of the patient in the format of YYYYMMDD-XXXX, or YYYYMMDD+XXXX."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 18 Mar 2022 14:16:50 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.10"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"124"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1008,\n \"message\": \"Ogiltigt API anrop (Patient mobile number:'a070-1740635' has invalid characters)\"\n }\n}"},{"id":"63094c98-0d84-4840-88f2-2f0feb7e5f2e","name":"Mobile number too long","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"listInfo\":{\n \"name\": \"Tolvan\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Rohan\"\n },\n \"patientType\": \"Privat\",\n \"email\": \"tol@example.com\",\n \"mobileNumber\": \"070-1740635123456\",\n \"firstName\": \"Tolvan\",\n \"lastName\": \"Tolvansson\",\n \"spokenName\": \"Tolvan\",\n \"address\": \"Street address 1\",\n \"coAddress\": \"The neighbour\",\n \"city\": \"GÖTEBORG\",\n \"zipCode\": \"41263\",\n \"stateCode\": \"14\",\n \"countyCode\": \"80\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/patients/:personalNumber","host":["{{url}}"],"path":["v1","patients",":personalNumber"],"variable":[{"key":"personalNumber","value":"19121212-1212","description":"_Mandatory_ - The social security number of the patient in the format of YYYYMMDD-XXXX, or YYYYMMDD+XXXX."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 18 Mar 2022 14:16:00 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.10"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"120"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1008,\n \"message\": \"Ogiltigt API anrop (Patient mobile number:'070-1740635123456' is too long)\"\n }\n}"},{"id":"459d9a97-07c6-4c4f-ba72-24a7f97c1e47","name":"Mobile number is invalid","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"listInfo\":{\n \"name\": \"Tolvan\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Rohan\"\n },\n \"patientType\": \"Privat\",\n \"email\": \"tol@example.com\",\n \"mobileNumber\": \"0028701740635\",\n \"firstName\": \"Tolvan\",\n \"lastName\": \"Tolvansson\",\n \"spokenName\": \"Tolvan\",\n \"address\": \"Street address 1\",\n \"coAddress\": \"The neighbour\",\n \"city\": \"GÖTEBORG\",\n \"zipCode\": \"41263\",\n \"stateCode\": \"14\",\n \"countyCode\": \"80\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/patients/:personalNumber","host":["{{url}}"],"path":["v1","patients",":personalNumber"],"variable":[{"key":"personalNumber","value":"19121212-1212","description":"_Mandatory_ - The social security number of the patient in the format of YYYYMMDD-XXXX, or YYYYMMDD+XXXX."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 18 Mar 2022 14:18:22 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.10"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"114"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1008,\n \"message\": \"Ogiltigt API anrop (Patient mobile number:'0028701740635' is invalid)\"\n }\n}"},{"id":"f810f5ad-2020-4e4a-9555-801503689faa","name":"Mobile number too short","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"listInfo\":{\n \"name\": \"Tolvan\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Rohan\"\n },\n \"patientType\": \"Privat\",\n \"email\": \"tol@example.com\",\n \"mobileNumber\": \"031\",\n \"firstName\": \"Tolvan\",\n \"lastName\": \"Tolvansson\",\n \"spokenName\": \"Tolvan\",\n \"address\": \"Street address 1\",\n \"coAddress\": \"The neighbour\",\n \"city\": \"GÖTEBORG\",\n \"zipCode\": \"41263\",\n \"stateCode\": \"14\",\n \"countyCode\": \"80\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/patients/:personalNumber","host":["{{url}}"],"path":["v1","patients",":personalNumber"],"variable":[{"key":"personalNumber","value":"19121212-1212","description":"_Mandatory_ - The social security number of the patient in the format of YYYYMMDD-XXXX, or YYYYMMDD+XXXX."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 18 Mar 2022 14:14:28 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.2.24-0ubuntu0.18.04.10"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"108"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1008,\n \"message\": \"Ogiltigt API anrop (Patient mobile number:'031' is too short)\"\n }\n}"}],"_postman_id":"173b00a0-4f51-4c79-9cb3-43c7516ff136"},{"name":"Patients Without Social Security Number","id":"e0f7248a-cad5-4b3f-a843-717d39920229","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\n \"identificationNumber\": \"19121212-M345\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"birthDate\": \"1912-12-12\",\n \"contact\": {\n \"streetName\": \"Test gatan 1\",\n \"zipCode\": \"12345\",\n \"city\": \"Göteborg\",\n \"coAddress\": \"Co Address 1\",\n \"mobile\": \"0705646788\",\n \"email\": \"tolvan@hotmail.com\",\n \"workPhone\": \"03156788\",\n \"homePhone\": \"3233333\"\n },\n \"listInfo\": {\n \"name\": \"The clinic\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Rohan\"\n },\n \"patientTypeId\": 1,\n \"gender\": \"M\"\n }","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/patient/withoutSocialSecurityNumber","description":"

Create a new patient without social security number. For example a patient with reserve number (reservnummer/samordningsnummer) or a foreign patient. The identification number must consist of 6-8 digits followed by 4 digits or letters, there is no need for a divider character but a dash sign can be used (-).

\n

Available post parameters (bold parameters are required):

\n

* identificationNumber
The identification of the patient for example 19121212-M123, 121212-KLL1 or 2019807276.
* firstName
The first name of the patient.
* lastName
The last name of the patient.
* birthDate
The birth date of the patient.
* patientTypeId
The patient type has to exist in Webdoc to be valid. See the list of available patient types by using the GET Patient Types endpoint
* streetName
The street name of the address.
* zipCode
The zip code of the address. Maximum of 5 characters.
* city
The city of the address.
* coAddress
The co address of the address.
* mobile
The mobile of the patient.
* email
The email of the patient.
* workPhone
The work phone of the patient.
* homePhone
The home phone of the patient.
* name
The name of the clinic.
* hsaId
The hsa id of the clinic.
* countyName
The county name of the clinic.
* gender
The gender of the patient.

\n

Allowed with the following scope:

\n

* patient:write

\n","urlObject":{"path":["v1","patient","withoutSocialSecurityNumber"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"54545031-0735-4757-993f-e6615984ce07","name":"Foreign Patient","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\n \"identificationNumber\": \"19121212-M345\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"birthDate\": \"1912-12-12\",\n \"contact\": {\n \"streetName\": \"Test gatan 1\",\n \"zipCode\": \"12345\",\n \"city\": \"Göteborg\",\n \"coAddress\": \"Co Address 1\",\n \"mobile\": \"0705646788\",\n \"email\": \"tolvan@hotmail.com\",\n \"workPhone\": \"03156788\",\n \"homePhone\": \"3233333\"\n },\n \"listInfo\": {\n \"name\": \"The clinic\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Rohan\"\n },\n \"patientTypeId\": 1,\n \"gender\": \"M\"\n }","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/patient/withoutSocialSecurityNumber"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"08a94eb6-cee2-464d-ac8f-a585654ef108\",\n \"identificationNumber\": \"19121212-M345\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"birthDate\": \"19121212\",\n \"gender\": \"0\",\n \"contact\": {\n \"streetName\": \"Test gatan 1\",\n \"zipCode\": \"12345\",\n \"city\": \"Göteborg\",\n \"coAddress\": \"Co Address 1\",\n \"mobile\": \"0705646788\",\n \"email\": \"tolvan@hotmail.com\",\n \"workPhone\": \"03156788\",\n \"homePhone\": \"3233333\"\n },\n \"listInfo\": {\n \"name\": \"The clinic\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Rohan\"\n },\n \"patientType\": {\n \"id\": 1,\n \"name\": \"Privat\"\n }\n }\n]"},{"id":"91885e82-914c-48db-af9f-105b94a8623c","name":"Reserve Number Patient","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\n \"identificationNumber\": \"2019807276\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"birthDate\": \"1912-12-12\",\n \"contact\": {\n \"streetName\": \"Test gatan 1\",\n \"zipCode\": \"12345\",\n \"city\": \"Göteborg\",\n \"coAddress\": \"Co Address 1\",\n \"mobile\": \"0705646788\",\n \"email\": \"tolvan@hotmail.com\",\n \"workPhone\": \"03156788\",\n \"homePhone\": \"3233333\"\n },\n \"listInfo\": {\n \"name\": \"The clinic\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Rohan\"\n },\n \"patientTypeId\": 1,\n \"gender\": \"M\"\n }","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/patient/withoutSocialSecurityNumber"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"08a94eb6-cee2-464d-ac8f-a585654ef108\",\n \"identificationNumber\": \"2019807276\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"birthDate\": \"19121212\",\n \"gender\": \"0\",\n \"contact\": {\n \"streetName\": \"Test gatan 1\",\n \"zipCode\": \"12345\",\n \"city\": \"Göteborg\",\n \"coAddress\": \"Co Address 1\",\n \"mobile\": \"0705646788\",\n \"email\": \"tolvan@hotmail.com\",\n \"workPhone\": \"03156788\",\n \"homePhone\": \"3233333\"\n },\n \"listInfo\": {\n \"name\": \"The clinic\",\n \"hsaId\": \"SE-123456789\",\n \"countyName\": \"Rohan\"\n },\n \"patientType\": {\n \"id\": 1,\n \"name\": \"Privat\"\n }\n }\n]"}],"_postman_id":"e0f7248a-cad5-4b3f-a843-717d39920229"}],"id":"7410d266-a9df-42a1-91b2-cbdc670a5d7d","_postman_id":"7410d266-a9df-42a1-91b2-cbdc670a5d7d","description":""},{"name":"v2","item":[{"name":"Patients","id":"07beb9c3-1c73-4f6c-898d-8c2069419257","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[{"description":"

Optional - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX.\nForeign personal numbers are also supported. The format needs to be YYYYMMDD-ZXXX, YYYYMMDD+ZXXX, YYYYMMDDZXXX or even in the reduced format of YYMMDD-ZXXX, YYMMDD+ZXXX and YYMMDDZXXX where Z is either M, K or X.

\n","key":"personalNumber","type":"text","value":"121212-1212"}],"url":"{{url}}/v2/patients?id=12345678-1234-1234-1234-123456789ABC&firstName=Jimmy&lastName=Doe","description":"

Available as of Webdoc 6.43

\n

Fetch patients based on filter (query) parameters.

\n

(You can read a more detailed tutorial about the patient flows via API on the Integrator Portal: https://integratorportal.carasent.net/faq/wd-external-cru-requests-of-patients-docs)

\n

Allowed with the following scope:

\n
    \n
  • patient:read
    • \n
\n","urlObject":{"path":["v2","patients"],"host":["{{url}}"],"query":[{"description":{"content":"

Optional - Patient id in UUID format

\n","type":"text/plain"},"key":"id","value":"12345678-1234-1234-1234-123456789ABC"},{"description":{"content":"

Optional - First name of patient

\n","type":"text/plain"},"key":"firstName","value":"Jimmy"},{"description":{"content":"

Optional - Last name of patient

\n","type":"text/plain"},"key":"lastName","value":"Doe"}],"variable":[]}},"response":[{"id":"8623138f-a86e-45e8-a7a7-75b1b971aca8","name":"JSON Schema","originalRequest":{"method":"GET","header":[{"key":"personalNumber","value":"121212-1212","description":"_Optional_ - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX.","disabled":true},{"key":"JSON_Schema","value":"true"}],"url":{"raw":"{{url}}/v2/patients","host":["{{url}}"],"path":["v2","patients"],"query":[{"key":"id","value":"12345678-1234-1234-1234-123456789ABC","description":"_Optional_ - Patient id in UUID format","disabled":true},{"key":"firstName","value":"Jimmy","description":"_Optional_ - First name of patient","disabled":true},{"key":"lastName","value":"Doe","description":"_Optional_ - Last name of patient","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Patients\",\n \"description\": \"Patients identified by a personal Identifier\",\n \"items\": {\n \"title\": \"Patient\",\n \"required\": [\n \"id\",\n \"personalNumber\",\n \"birthDate\",\n \"gender\",\n \"firstName\",\n \"lastName\",\n \"address\",\n \"nationality\",\n \"email\",\n \"mobilePhoneNumber\",\n \"workPhoneNumber\",\n \"homePhoneNumber\",\n \"listedClinic\",\n \"interpreterNeeded\",\n \"interpreterLanguage\",\n \"organization\",\n \"department\",\n \"county\",\n \"patientType\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Patient's Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/items/properties/id\"\n },\n \"personalNumber\": {\n \"title\": \"Patient's personnal identifier\",\n \"$ref\": \"#/definitions/personalNumber\",\n \"$id\": \"#/items/properties/personalNumber\"\n },\n \"birthDate\": {\n \"title\": \"Patient's date of birth\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"2012-12-12\"\n ],\n \"$id\": \"#/items/properties/birthDate\",\n \"type\": \"string\"\n },\n \"gender\": {\n \"title\": \"Patient's gender\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"M\"\n ],\n \"$id\": \"#/items/properties/gender\",\n \"type\": \"string\"\n },\n \"firstName\": {\n \"title\": \"Patient's first name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Yngre\"\n ],\n \"$id\": \"#/items/properties/firstName\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"title\": \"Patient's last name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Tolvis\"\n ],\n \"$id\": \"#/items/properties/lastName\",\n \"type\": \"string\"\n },\n \"address\": {\n \"title\": \"Patient's address\",\n \"required\": [\n \"streetName\",\n \"coAddress\",\n \"city\",\n \"zipCode\"\n ],\n \"properties\": {\n \"streetName\": {\n \"title\": \"Street name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"asdasdasd 45\"\n ],\n \"$id\": \"#/items/properties/address/properties/streetName\",\n \"type\": \"string\"\n },\n \"coAddress\": {\n \"title\": \"C/O address\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"\"\n ],\n \"$id\": \"#/items/properties/address/properties/coAddress\",\n \"type\": \"string\"\n },\n \"city\": {\n \"title\": \"City\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"NORRKÖPING\"\n ],\n \"$id\": \"#/items/properties/address/properties/city\",\n \"type\": \"string\"\n },\n \"zipCode\": {\n \"title\": \"Zip code\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"60361\"\n ],\n \"$id\": \"#/items/properties/address/properties/zipCode\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/items/properties/address\",\n \"type\": \"object\"\n },\n \"nationality\": {\n \"title\": \"Patient's nationality\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Norway\"\n ],\n \"$id\": \"#/items/properties/nationality\",\n \"type\": \"string\"\n },\n \"email\": {\n \"title\": \"E-mail\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"\"\n ],\n \"$id\": \"#/items/properties/email\",\n \"type\": \"string\"\n },\n \"mobilePhoneNumber\": {\n \"title\": \"Mobile phone\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"0760512930\"\n ],\n \"$id\": \"#/items/properties/mobilePhoneNumber\",\n \"type\": \"string\"\n },\n \"workPhoneNumber\": {\n \"title\": \"Work phone\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"\"\n ],\n \"$id\": \"#/items/properties/workPhoneNumber\",\n \"type\": \"string\"\n },\n \"homePhoneNumber\": {\n \"title\": \"Home phone\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"\"\n ],\n \"$id\": \"#/items/properties/homePhoneNumber\",\n \"type\": \"string\"\n },\n \"listedClinic\": {\n \"title\": \"An object value\",\n \"required\": [\n \"hsaId\"\n ],\n \"properties\": {\n \"hsaId\": {\n \"title\": \"A string value\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"SET5565594230-119n\"\n ],\n \"$id\": \"#/items/properties/listedClinic/properties/hsaId\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/items/properties/listedClinic\",\n \"type\": \"object\"\n },\n \"interpreterNeeded\": {\n \"title\": \"Is an interpreter needed?\",\n \"default\": false,\n \"examples\": [\n false\n ],\n \"$id\": \"#/items/properties/interpreterNeeded\",\n \"type\": \"boolean\"\n },\n \"interpreterLanguage\": {\n \"title\": \"Interpreter's language\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"\"\n ],\n \"$id\": \"#/items/properties/interpreterLanguage\",\n \"type\": \"string\"\n },\n \"organization\": {\n \"title\": \"Organization\",\n \"default\": null,\n \"examples\": [\n null,\n {\n \"id\": \"12345678-1234-1234-1234-123456789ABC\",\n \"name\": \"\"\n }\n ],\n \"oneOf\": [\n {\n \"type\": \"null\"\n },\n {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Organization Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/items/properties/organization/properties/id\"\n },\n \"name\": {\n \"title\": \"Organization name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Test företag xxx AB\"\n ],\n \"$id\": \"#/items/properties/organization/properties/name\",\n \"type\": \"string\"\n }\n }\n }\n ],\n \"$id\": \"#/items/properties/organization\"\n },\n \"department\": {\n \"title\": \"Department\",\n \"default\": null,\n \"examples\": [\n null, \n {\n \"id\": \"12345678-1234-1234-1234-123456789ABC\",\n \"name\": \"HR\"\n }\n ],\n \"oneOf\": [\n {\n \"type\": \"null\"\n },\n {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Department Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/items/properties/organization/properties/id\"\n },\n \"name\": {\n \"title\": \"Department name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"HR\"\n ],\n \"$id\": \"#/items/properties/organization/properties/name\",\n \"type\": \"string\"\n }\n }\n }\n ],\n \"$id\": \"#/items/properties/department\"\n },\n \"county\": {\n \"title\": \"County\",\n \"required\": [\n \"code\"\n ],\n \"properties\": {\n \"code\": {\n \"title\": \"County Id\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"0000\"\n ],\n \"$id\": \"#/items/properties/county/properties/code\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/items/properties/county\",\n \"type\": \"object\"\n },\n \"patientType\": {\n \"title\": \"Patient type (Insurance)\",\n \"required\": [\n \"id\",\n \"name\",\n \"type\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Patient type id\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"49\"\n ],\n \"$id\": \"#/items/properties/patientType/properties/id\",\n \"type\": \"string\"\n },\n \"name\": {\n \"title\": \"Patient type name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"VGR Rehab\"\n ],\n \"$id\": \"#/items/properties/patientType/properties/name\",\n \"type\": \"string\"\n },\n \"type\": {\n \"title\": \"Patient type type\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"healthcare_contract\"\n ],\n \"$id\": \"#/items/properties/patientType/properties/type\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/items/properties/patientType\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"#/items\",\n \"type\": \"object\"\n },\n \"$id\": \"http://webdoc.api/response/patients/v2/get/patients\",\n \"type\": \"array\",\n \"definitions\": {\n \"uuid\": {\n \"$id\": \"#/definitions/uuid\",\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"default\": \"\",\n \"examples\": [\n \"ee4d906f-2eca-4345-9907-a4c6c2fcd931\"\n ]\n },\n \"personalNumber\": {\n \"$id\": \"#/definitions/personalNumber\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^([0-9]{6}|[0-9]{8})[-+]?[0-9]{4}$\",\n \"examples\": [\n \"19121212-1212\", \"121212-1212\",\n \"19121212+1212\", \"121212+1212\",\n \"191212121212\", \"1212121212\"\n ] \n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}"},{"id":"f7f50da7-c730-4f19-b6fa-10ce81008825","name":"Patients","originalRequest":{"method":"GET","header":[{"key":"personalNumber","value":"121212-1212","description":"_Optional_ - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX.","disabled":true}],"url":{"raw":"{{url}}/v2/patients","host":["{{url}}"],"path":["v2","patients"],"query":[{"key":"id","value":"12345678-1234-1234-1234-123456789ABC","description":"_Optional_ - Patient id in UUID format","disabled":true},{"key":"firstName","value":"Jimmy","description":"_Optional_ - First name of patient","disabled":true},{"key":"lastName","value":"Doe","description":"_Optional_ - Last name of patient","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"80b3c7b9-f7cb-4e65-9ce5-cca18befcbea\",\n \"personalNumber\": \"19121212-1212\",\n \"birthDate\": \"1912-12-12\",\n \"gender\": \"M\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address\": {\n \"streetName\": \"Test Address 123\",\n \"coAddress\": \"Jane Doe\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\"\n },\n \"nationality\": \"Sweden\",\n \"email\": \"test@evimeria.se\",\n \"mobilePhoneNumber\": \"+46701740605\",\n \"workPhoneNumber\": \"0313900600\",\n \"homePhoneNumber\": \"\",\n \"listedClinic\": {\n \"hsaId\": \"SE1234567890-1231\"\n },\n \"interpreterNeeded\": false,\n \"interpreterLanguage\": \"\",\n \"organization\" : {\n \"id\": \"7032149e-edb5-4235-bb0f-3b2b36d01ebb\",\n \"name\": \"The Company\"\n },\n \"department\": null,\n \"patientType\": {\n \"id\": \"1\",\n \"name\": \"Private\"\n },\n \"county\": {\n \"code\": \"1234\"\n }\n },\n {\n \"id\": \"d1ea387c-e0cf-494c-aef3-7f6ee14ffb7f\",\n \"personalNumber\": \"20121212-1212\",\n \"birthDate\": \"2012-12-12\",\n \"gender\": \"F\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"address\": {\n \"streetName\": \"Test street 123\",\n \"coAddress\": \"John\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\"\n },\n \"nationality\": \"Sweden\",\n \"email\": \"doe@example.com\",\n \"mobilePhoneNumber\": \"+46701740605\",\n \"workPhoneNumber\": \"031-3900600\",\n \"homePhoneNumber\": \"\",\n \"listedClinic\": {\n \"hsaId\": \"SE1234567890-1232\"\n },\n \"interpreterNeeded\": true,\n \"interpreterLanguage\": \"\",\n \"organization\" : {\n \"id\": \"7032149e-edb5-4235-bb0f-3b2b36d01ebb\",\n \"name\": \"The Company\"\n },\n \"department\": {\n \"id\": \"038a2417-d830-11ec-a9d4-0242ac120004\",\n \"name\": \"Team AAA\"\n },\n \"patientType\": {\n \"id\": \"1\",\n \"name\": \"Private\"\n },\n \"county\": {\n \"code\": \"1234\"\n }\n }\n]"},{"id":"a437866a-cd4b-4c67-b9a5-8be552140de9","name":"Patients by PersonalNumber","originalRequest":{"method":"GET","header":[{"key":"personalNumber","value":"121212-1212","description":"_Optional_ - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX."}],"url":{"raw":"{{url}}/v2/patients","host":["{{url}}"],"path":["v2","patients"],"query":[{"key":"id","value":null,"disabled":true},{"key":"firstName","value":"Jimmy","disabled":true},{"key":"lastName","value":"Doe","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"4165f4fa-f41f-434d-a420-578fd99e6beb\",\n \"personalNumber\": \"19121212-1212\",\n \"birthDate\": \"1912-12-12\",\n \"gender\": \"M\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address\": {\n \"streetName\": \"Test Address 123\",\n \"coAddress\": \"\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\"\n },\n \"nationality\": \"Andorra\",\n \"email\": \"test@evimeria.se\",\n \"mobilePhoneNumber\": \"+46701740605\",\n \"workPhoneNumber\": \"031-3900600\",\n \"homePhoneNumber\": \"\",\n \"listedClinic\": {\n \"hsaId\": \"\"\n },\n \"interpreterNeeded\": true,\n \"interpreterLanguage\": \"gl\",\n \"organization\" : {\n \"id\": \"7032149e-edb5-4235-bb0f-3b2b36d01ebb\",\n \"name\": \"The Company\"\n },\n \"department\": {\n \"id\": \"038a2417-d830-11ec-a9d4-0242ac120004\",\n \"name\": \"Team AAA\"\n },\n \"county\": {\n \"code\": \"1480\"\n },\n \"patientType\": {\n \"id\": \"48\",\n \"name\": \"PatientType 1\",\n \"type\": \"healthcare_contract\"\n }\n }\n]"},{"id":"98126272-64eb-4891-b812-c0a779caa8f8","name":"Patients, Empty response","originalRequest":{"method":"GET","header":[{"key":"personalNumber","value":"121212-1212","disabled":true}],"url":{"raw":"{{url}}/v2/patients","host":["{{url}}"],"path":["v2","patients"],"query":[{"key":"id","value":null,"disabled":true},{"key":"firstName","value":"Jimmy","disabled":true},{"key":"lastName","value":"Doe","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"07beb9c3-1c73-4f6c-898d-8c2069419257"}],"id":"addcbe5c-acb3-466b-9f3a-42025c7feec3","_postman_id":"addcbe5c-acb3-466b-9f3a-42025c7feec3","description":""}],"id":"0fa1ee69-71e7-4d0e-ac64-c5737ed610d5","_postman_id":"0fa1ee69-71e7-4d0e-ac64-c5737ed610d5","description":""},{"name":"Patient Types","item":[{"name":"Patient Type by ID","id":"81a45dfe-033a-4a50-89a8-9de2d40408f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[{"key":"JSON_Schema","value":"true","type":"text"}],"url":"{{url}}/v1/patientTypes/:id","description":"

Fetch a patient type by it ID.

\n

Allowed with one of the following scopes:

\n
    \n
  • patient-types:read
    • \n
  • patient-types:write
    • \n
\n","urlObject":{"path":["v1","patientTypes",":id"],"host":["{{url}}"],"query":[],"variable":[{"description":{"content":"

Required - The id of an exisiting patient type

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"da7b9924-3b6d-4054-8f9c-bdbebc8a7d26","name":"Patient Type by id","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/patientTypes/:id","host":["{{url}}"],"path":["v1","patientTypes",":id"],"variable":[{"key":"id","value":"1","description":"The id of an exisiting patient type"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1\",\n \"name\": \"Private\",\n \"type\": \"private\"\n}"},{"id":"262dcb04-879e-4924-a819-ba9bdfdd2080","name":"JSON Schema","originalRequest":{"method":"GET","header":[{"key":"JSON_Schema","value":"true"}],"url":{"raw":"{{url}}/v1/patientTypes/:id","host":["{{url}}"],"path":["v1","patientTypes",":id"],"variable":[{"key":"id","value":"2","description":"_Required_ - The id of an exisiting patient type"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 14 Apr 2023 05:45:35 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.4.33"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"52"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Patient type\",\n \"required\": [\n \"id\",\n \"name\",\n \"type\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Patient type id\",\n \"default\": \"\",\n \"pattern\": \"^[1-9][0-9]*$\",\n \"examples\": [\n \"2\"\n ],\n \"$id\": \"#/properties/id\",\n \"type\": \"string\"\n },\n \"name\": {\n \"title\": \"Patient type name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"AON\"\n ],\n \"$id\": \"#/properties/name\",\n \"type\": \"string\"\n },\n \"type\": {\n \"title\": \"Patient type type\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"healthcare_contract\"\n ],\n \"$id\": \"#/properties/type\",\n \"type\": [\"null\", \"string\"]\n }\n },\n \"$id\": \"http://webdoc.api/response/patient_types/v1/get/patient_type_by_id\",\n \"type\": \"object\",\n \"definitions\": {},\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}"}],"_postman_id":"81a45dfe-033a-4a50-89a8-9de2d40408f6"},{"name":"Patient Types","id":"c62abcd5-c967-4b09-85c5-74f157cd2e56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/v1/patientTypes?name=Private&type=private","description":"

This endpoint can be called to fetch all active patient types by filters.

\n

Allowed with one of the following scopes:

\n
    \n
  • patient-types:read
    • \n
  • patient-types:write
    • \n
\n","urlObject":{"path":["v1","patientTypes"],"host":["{{url}}"],"query":[{"description":{"content":"

Filter patient types by name.

\n","type":"text/plain"},"key":"name","value":"Private"},{"description":{"content":"

Filter patient types by type. Search values:

\n
    \n
  • private - Private patient types
    • \n
  • insurance - Patient types tied to insurance companies.
    • \n
  • healthcare_contract - Patient types tied to healthcare contracts.
    • \n
  • company - Patient types tied to a company.
    • \n
\n","type":"text/plain"},"key":"type","value":"private"},{"disabled":true,"key":null,"value":""}],"variable":[]}},"response":[{"id":"fee0bbeb-cffb-46fe-a499-0d970b23fe11","name":"Patient Types","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/patientTypes","host":["{{url}}"],"path":["v1","patientTypes"],"query":[{"key":"name","value":"Private","disabled":true},{"key":"type","value":"private","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"1\",\n \"name\": \"Private\",\n \"type\": \"private\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Insurance Company\",\n \"type\": \"insurance\"\n },\n {\n \"id\": \"3\",\n \"name\": \"Health Care Contract\",\n \"type\": \"healthcare_contract\"\n }\n]"},{"id":"7a6a3164-bd68-46b2-90bf-c130a5390665","name":"JSON Schema","originalRequest":{"method":"GET","header":[{"key":"JSON_Schema","value":"true"}],"url":{"raw":"{{url}}/v1/patientTypes","host":["{{url}}"],"path":["v1","patientTypes"],"query":[{"key":"name","value":"Privat","description":"Filter patient types by name.","disabled":true},{"key":"type","value":"private","description":"Filter patient types by *type*. **Search values:**\n* **private** - Private patient types\n* **insurance** - Patient types tied to insurance companies.\n* **healthcare_contract** - Patient types tied to healthcare contracts.\n* **company** - Patient types tied to a company.","disabled":true},{"key":null,"value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 14 Apr 2023 06:01:38 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.4.33"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"7354"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Patient types\",\n \"items\": {\n \"title\": \"Patient type\",\n \"required\": [\n \"id\",\n \"name\",\n \"type\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Patient type id\",\n \"default\": \"\",\n \"pattern\": \"^[1-9][0-9]*$\",\n \"examples\": [\n \"1\"\n ],\n \"$id\": \"#/items/properties/id\",\n \"type\": \"string\"\n },\n \"name\": {\n \"title\": \"Patient type name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Privat\"\n ],\n \"$id\": \"#/items/properties/name\",\n \"type\": \"string\"\n },\n \"type\": {\n \"title\": \"Patient type type\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n null, \"private\"\n ],\n \"$id\": \"#/items/properties/type\",\n \"type\": [\"null\", \"string\"]\n }\n },\n \"$id\": \"#/items\",\n \"type\": \"object\"\n },\n \"$id\": \"http://webdoc.api/response/patient_types/v1/get/patient_types\",\n \"type\": \"array\",\n \"definitions\": {},\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}"}],"_postman_id":"c62abcd5-c967-4b09-85c5-74f157cd2e56"}],"id":"998c553d-2b7a-49c2-8f01-d88acab937fd","_postman_id":"998c553d-2b7a-49c2-8f01-d88acab937fd","description":""},{"name":"Payment Methods","item":[{"name":"v1","item":[{"name":"Payment Methods","id":"f6d7fdfc-176d-4b18-ba99-1645d7318090","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/v1/clinics/:clinicId/paymentMethods","description":"

This endpoint can be used to fetch payment methods from a specified clinic.

\n

Allowed with one of the following scopes:

\n
    \n

  • self-service

    \n
    • \n

  • payment-methods:read

    \n
    • \n

  • payment-methods:write

    \n
    • \n
\n","urlObject":{"path":["v1","clinics",":clinicId","paymentMethods"],"host":["{{url}}"],"query":[],"variable":[{"id":"46f94f91-f5cf-4b39-a8aa-57bc418e6d05","description":{"content":"

Required - Clinic identifier (UUID).

\n","type":"text/plain"},"type":"any","value":"481c97c5-0bd7-4aff-aca2-71ce9003b613","key":"clinicId"}]}},"response":[{"id":"2d27ae2f-bd42-4434-ab22-f533dfd7edc4","name":"Payment Methods","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/clinics/:clinicId/paymentMethods","host":["{{url}}"],"path":["v1","clinics",":clinicId","paymentMethods"],"variable":[{"key":"clinicId","value":"873ab456-097c-12fd-aaab-98365cb34009","description":"Clinic identifier (UUID)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"1\",\n \"name\": \"Card\",\n \"directPayment\": true,\n \"active\": false,\n \"assetsAccount\": \"1935\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Cash\",\n \"directPayment\": true,\n \"active\": true,\n \"assetsAccount\": \"1910\"\n },\n {\n \"id\": \"3\",\n \"name\": \"Invoice\",\n \"directPayment\": false,\n \"active\": true,\n \"assetsAccount\": \"1930\"\n },\n {\n \"id\": \"4\",\n \"name\": \"InvoiceCompany\",\n \"directPayment\": false,\n \"active\": true,\n \"assetsAccount\": \"1930\"\n },\n {\n \"id\": \"5\",\n \"name\": \"Swish\",\n \"directPayment\": true,\n \"active\": false,\n \"assetsAccount\": \"1980\"\n }\n]"},{"id":"eee0b087-1dd3-4385-b40e-4c850b8340dd","name":"Payment Methods clinic not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/clinics/:clinicId/paymentMethods","host":["{{url}}"],"path":["v1","clinics",":clinicId","paymentMethods"],"variable":[{"key":"clinicId","value":"0","description":"Clinic identifier (UUID)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"\"Failed to find any clinic with id\""}],"_postman_id":"f6d7fdfc-176d-4b18-ba99-1645d7318090"}],"id":"13b54552-4aa1-4eb3-b34d-53398621210d","_postman_id":"13b54552-4aa1-4eb3-b34d-53398621210d","description":""}],"id":"83e5c067-8c92-426b-8727-78de9afa3c04","_postman_id":"83e5c067-8c92-426b-8727-78de9afa3c04","description":""},{"name":"Records","item":[{"name":"v1","item":[{"name":"Records","id":"1ac0a5e6-64ad-4da1-a5da-3f4c483cf35e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"5F8F7BE8-D2BD-4733-A2F7-7ACE9FE6A5E7\",\n \"keywords\": [\n {\n \"id\": 1,\n \"value\": \"Value for keyword with id 1.\"\n },\n {\n \"id\": 2,\n \"value\": \"Value for keyword with id 2.\"\n }\n ],\n \"diagnosisCodes\": [\n \"W02.03\",\n \"W01.90\"\n ],\n \"actionCodes\": [\n \"PB003\",\n \"GD002\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/visits/:visitId/records","description":"

This endpoint can be used to add additional patient record data to an existing visit or note.

\n

Moreover, the path parameter visitId is meant to refer to the record's visitId created by POST Visit from booking or to the note's noteID created by POST Notes.

\n

(You can read more about how to create notes in Webdoc via API on this tutorial page: https://integratorportal.carasent.net/faq/wd-external-note-population-docs)

\n

Available body parameters (bold are required):

\n
  • userId
    (    The userId shall be in UUID format representing the user that is appending information to the records. Available users can be fetched via endpoint GET Users.)

  • keywords
    (The keywords refer to the form types that are used for the template in which the content can be imported to.)

    • id
      (The form type ID, e.g. a text field or a date field, etc. Available keyword IDs for the templateId can be found via endpoint GET Record Template by ID.)
    • value
      (The content to be imported to the specified form field.)
  • diagnosisCodes
    (KVÅ codes.)
  • actionCodes
    (ICD codes.)

\n\n

Allowed with the following scope:

\n
  • patient:write
","urlObject":{"path":["v1","visits",":visitId","records"],"host":["{{url}}"],"query":[],"variable":[{"description":{"content":"

Required - Visit/note identifier (UUID).

\n","type":"text/plain"},"type":"any","value":"9bab2c27-52bd-4caa-92a4-6deada67bffb","key":"visitId"}]}},"response":[{"id":"4771a6e6-aae3-41f7-b386-250f93a47272","name":"Records","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"5F8F7BE8-D2BD-4733-A2F7-7ACE9FE6A5E7\",\n \"keywords\": [\n {\n \"id\": 1,\n \"value\": \"Value for keyword with id 1.\"\n },\n {\n \"id\": 2,\n \"value\": \"Value for keyword with id 2.\"\n }\n ],\n \"diagnosisCodes\": [\n \"W02.03\",\n \"W01.90\"\n ],\n \"actionCodes\": [\n \"PB003\",\n \"GD002\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/visits/:visitId/records","host":["{{url}}"],"path":["v1","visits",":visitId","records"],"variable":[{"key":"visitId","value":"9bab2c27-52bd-4caa-92a4-6deada67bffb","description":"Visit identifier"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"userId\": \"5F8F7BE8-D2BD-4733-A2F7-7ACE9FE6A5E7\",\n \"keywords\": [\n {\n \"id\": 1,\n \"value\": \"Value for keyword with id 1.\"\n },\n {\n \"id\": 2,\n \"value\": \"Value for keyword with id 2.\"\n }\n ],\n \"diagnoses\": [\n {\n \"code\": \"W02.03\"\n },\n {\n \"code\": \"W01.90\"\n }\n ],\n \"actions\": [\n {\n \"code\": \"PB003\"\n },\n {\n \"code\": \"GD002\"\n }\n ]\n}"}],"_postman_id":"1ac0a5e6-64ad-4da1-a5da-3f4c483cf35e"},{"name":"External Records","id":"2d9f5527-bd96-47fc-a2b9-601d1c376bc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"patientIdentity\": \"12345678-1234-1234-1234-123456789ABC\",\n \"authorIdentity\": 1010,\n \"recordTemplateId\": \"42\",\n \"source\": \"Alpha Children Care AB\",\n \"questionnaireName\": \"Health declaration\",\n \"keywords\": [\n {\n \"id\": 1,\n \"value\": \"85\"\n },\n {\n \"id\": 2,\n \"value\": \"185\"\n }\n ],\n \"actionCodes\": [\n \"AA016\",\n \"AA018\"\n ],\n \"diagnosisCodes\": [\n \"W00.00\",\n \"W00.01\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/externalRecords","description":"

This endpoint can be used to create record template contents externally, which can later be imported to populate a patient journal via the Webdoc GUI, i.e. after a registered patient visit which is based on the same record template.

\n

(You can read a more detailed tutorial about the necessary chain of API calls to post external records from the Integrator Portal:https://integratorportal.carasent.net/faq/wd-external-journal-template-population-docs)


\n\n

Available post parameters (bold are required):

\n
    \n
  • patientIdentity
    (The patient ID in UUID format that a visit refers to. Available patient UUIDs can be fetched via endpoint GET /v2/patients.)
    • \n
  • recordTemplateId
    (The ID for the record template to be used for the journal and visit. Available IDs can be found via endpoint GET Record Templates.)
    • \n
  • keywords
    (The keywords refer to the form types that are used for the template in which the content can be imported to.)
      \n
    • id
      (The form type ID, e.g. a text field or a date field, etc. Available keyword IDs for the templateId can be found via endpoint GET Record Template by ID.)
      • \n
    • value
      (The content to be imported to the specified form field.)
      • \n
    \n
    • \n
  • authorIdentity
    (The user ID for the user that performed the request. Usually refering to a caregiver.)
    • \n
  • source
    (The name of the external source for the request, e.g. the name of the Webdoc integrator.)
    • \n
  • questionnaireName
    (The name of the questionnaire, such as e.g. \"Health declaration\" or such like.)
    • \n
  • actionCodes
    (KVÅ codes.)
    • \n
  • diagnosisCodes
    (ICD codes.)
    • \n
\n

Allowed with the following scope:

\n
    \n
  • system-admin
    • \n
\n","urlObject":{"path":["v1","externalRecords"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"efb4c406-15bd-456a-a691-346b43763b15","name":"External Records","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"patientIdentity\": \"12345678-1234-1234-1234-123456789ABC\",\n \"authorIdentity\": 123,\n \"recordTemplateId\": \"42\",\n \"source\": \"Clinic 1\",\n \"questionnaireName\": \"Health declaration\",\n \"keywords\": [\n {\n \"id\": 1,\n \"value\": \"85.\"\n },\n {\n \"id\": 2,\n \"value\": \"185\"\n }\n ],\n \"actionCodes\": [\n [\n \"AA123\",\n \"BB234\"\n ]\n ],\n \"diagnosisCodes\": [\n [\n \"A12.34\",\n \"B23.45\"\n ]\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/externalRecords"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"5184aa9d-4e65-4972-92c7-d68714502e2f\",\n \"patientIdentity\": \"12345678-1234-1234-1234-123456789ABC\",\n \"authorIdentity\": 123,\n \"recordTemplateId\": 42,\n \"questionnaireName\": \"Health declaration\",\n \"source\": \"ExternalSource\",\n \"keywords\": [\n {\n \"id\": 1,\n \"title\": \"Weight\",\n \"value\": \"85\",\n \"type\": 1\n },\n {\n \"id\": 2,\n \"title\": \"Height\",\n \"value\": \"185\",\n \"type\": 1\n }\n ],\n \"actionCodes\": [\n \"AA016\",\n \"AA018\"\n ],\n \"diagnosisCodes\": [\n \"W00.00\",\n \"W00.01\"\n ]\n}"}],"_postman_id":"2d9f5527-bd96-47fc-a2b9-601d1c376bc7"},{"name":"Record Templates","id":"9e597615-4ece-45bd-8ff7-a148bff96242","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/v1/recordTemplates","description":"

Fetch record templates with associated keywords.\n

Allowed with the following scope:

\n
    \n
  • system-admin
    • \n
\n","urlObject":{"path":["v1","recordTemplates"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"fbf00839-7fae-4fcf-9335-8b95d4c1a253","name":"Record Templates","originalRequest":{"method":"GET","header":[],"url":"{{url}}/v1/recordTemplates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"title\": \"Measurement at 1 year of age\",\n \"templateType\": 2,\n \"previousVersions\": [],\n \"keywords\": [\n {\n \"id\": 1,\n \"title\": \"Height\",\n \"type\": 1,\n \"maxLength\": \"64\",\n \"defaultValue\": \"70\",\n \"parentId\": 0,\n \"warnIfEmpty\": true,\n \"information\": \"The length at 1 year of age\",\n \"repetitionTime\": \"\",\n \"warningTime\": \"\",\n \"visual\": {\n \"order\": 1,\n \"sizeX\": 100,\n \"sizeY\": 20\n }\n }\n ]\n }\n]"}],"_postman_id":"9e597615-4ece-45bd-8ff7-a148bff96242"},{"name":"Record Template by ID","id":"abbcdaa2-9cc7-4edb-b2c8-a932251a18ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/v1/recordTemplates/:templateId","description":"

Fetch a record template by ID with associated keywords (reflecting the template form fields).

\n

Allowed with the following scope:

\n
    \n
  • system-admin
    • \n
\n","urlObject":{"path":["v1","recordTemplates",":templateId"],"host":["{{url}}"],"query":[],"variable":[{"id":"50909ca3-5ed5-4b8c-9536-7455cc3c54c2","description":{"content":"

Required - Record template identifier

\n","type":"text/plain"},"type":"any","value":"1","key":"templateId"}]}},"response":[{"id":"2997cb67-a721-4c99-b17e-b2c6695758a0","name":"Record Template by id","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/recordTemplates/:templateId","host":["{{url}}"],"path":["v1","recordTemplates",":templateId"],"variable":[{"key":"templateId","value":"1","description":"Record template identifier"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"title\": \"General\",\n \"templateType\": 2,\n \"previousVersions\": [],\n \"keywords\": [\n {\n \"id\": 1,\n \"title\": \"condition\",\n \"type\": 1,\n \"maxLength\": \"64\",\n \"defaultValue\": \"60\",\n \"parentId\": 0,\n \"warnIfEmpty\": true,\n \"information\": \"\",\n \"repetitionTime\": \"\",\n \"warningTime\": \"\",\n \"visual\": {\n \"order\": 1,\n \"sizeX\": 100,\n \"sizeY\": 20\n }\n }\n ]\n }\n]"}],"_postman_id":"abbcdaa2-9cc7-4edb-b2c8-a932251a18ad"}],"id":"85356c4a-3868-4668-a5c4-a0cf80cb7cd4","_postman_id":"85356c4a-3868-4668-a5c4-a0cf80cb7cd4","description":""}],"id":"d4ca9a4d-01ab-4422-a78c-bfb5c843496e","_postman_id":"d4ca9a4d-01ab-4422-a78c-bfb5c843496e","description":""},{"name":"Users","item":[{"name":"v1","item":[{"name":"Clinic Users","event":[{"listen":"test","script":{"id":"76222260-46fa-4295-b570-6cad36a7ce54","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const jsonData = pm.response.json();","","pm.test(\"Response contains\", function () {"," pm.expect(jsonData[0]).to.have.property(\"lastLoggedIn\");","}); ","","pm.test(\"Response time is less than 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(3000);","});"],"type":"text/javascript","packages":{}}}],"id":"4a90d10d-840a-43d6-aa51-61a1aaa302db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/v1/clinics/:clinicId/users?isCaregiver=true","description":"

This endpoint enables to fetch Webdoc users on a specified clinic and with optional specific permission.

\n

Currently supports the following permissions:

\n
    \n
  • isCaregiver : true | false
    • \n
\n

Allowed with one of the following scopes:

\n
    \n

  • users:read

    \n
    • \n

  • users:write

    \n
    • \n
\n","urlObject":{"path":["v1","clinics",":clinicId","users"],"host":["{{url}}"],"query":[{"description":{"content":"

Optional - Users with specified caregiver permission.

\n","type":"text/plain"},"key":"isCaregiver","value":"true"}],"variable":[{"description":{"content":"

Required - Clinic identifier (UUID).

\n","type":"text/plain"},"type":"any","value":"481c97c5-0bd7-4aff-aca2-71ce9003b613","key":"clinicId"}]}},"response":[{"id":"25a12871-25b1-40d2-8cc0-af5c80fb66aa","name":"GET Clinic Users - OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/clinics/:clinicId/users?isCaregiver=true","host":["{{url}}"],"path":["v1","clinics",":clinicId","users"],"query":[{"key":"isCaregiver","value":"true"}],"variable":[{"key":"clinicId","value":"481c97c5-0bd7-4aff-aca2-71ce9003b613"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"9c4e2601-a0e3-4bb1-aab2-aedc753abef9\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\"\n },\n {\n \"id\": \"bdac7ecb-dd6c-4f50-b4f8-bc1088147415\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\"\n },\n {\n \"id\": \"ad573609-6555-4a47-8371-8d1d6f2136b7\",\n \"firstName\": \"Jake\",\n \"lastName\": \"Doe\"\n }\n]"},{"id":"c9da19c9-aa67-454a-8074-d88c9ec91c05","name":"GET Clinic Users - No users found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/clinics/:clinicId/users?isCaregiver=true","host":["{{url}}"],"path":["v1","clinics",":clinicId","users"],"query":[{"key":"isCaregiver","value":"true"}],"variable":[{"key":"clinicId","value":"481c97c5-0bd7-4aff-aca2-71ce9003b613"}]}},"status":"OK","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 9901,\n \"message\": \"No users found for this clinic with matching permission\"\n }\n}"},{"id":"d7fcc796-a888-4b49-85e2-fdc49e049931","name":"GET Clinic Users - Clinic not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/clinics/:clinicId/users?isCaregiver=true","host":["{{url}}"],"path":["v1","clinics",":clinicId","users"],"query":[{"key":"isCaregiver","value":"true"}],"variable":[{"key":"clinicId","value":"1"}]}},"status":"OK","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1005,\n \"message\": \"Failed to find any clinic with id\"\n }\n}"}],"_postman_id":"4a90d10d-840a-43d6-aa51-61a1aaa302db"},{"name":"Users","event":[{"listen":"test","script":{"id":"76222260-46fa-4295-b570-6cad36a7ce54","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const jsonData = pm.response.json();","","pm.test(\"Response contains\", function () {"," pm.expect(jsonData[0]).to.have.property(\"lastLoggedIn\");","}); ","","pm.test(\"Response time is less than 5000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(3000);","});"],"type":"text/javascript"}}],"id":"cf1a2c5b-8251-46d6-a990-3c44464ec105","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/v1/users?firstName=John&lastName=Doe&personalNumber=19121212-1212&hsaId=SE123-4567890&id=3213d1a2-e4cc-4c70-8433-4bf48dbafbc2","description":"

This endpoint enables to fetch information about Webdoc users.

\n

Allowed with one of the following scopes:

\n
    \n
  • users:read
    • \n
  • users:write
    • \n
\n","urlObject":{"path":["v1","users"],"host":["{{url}}"],"query":[{"description":{"content":"

Optional - The first name of the user in Webdoc

\n","type":"text/plain"},"key":"firstName","value":"John"},{"description":{"content":"

Optional - The last name of the user in Webdoc

\n","type":"text/plain"},"key":"lastName","value":"Doe"},{"description":{"content":"

Optional - Optional - The personal number of the patient in the format of YYYYMMDD-XXXX or YYYYMMDDXXXX.\nForeign personal numbers are also supported. The format needs to be YYYYMMDD-ZXXX or YYYYMMDDZXXX where Z is either M, K or X.

\n","type":"text/plain"},"key":"personalNumber","value":"19121212-1212"},{"description":{"content":"

Optional - The HSA id of the user in Webdoc.

\n","type":"text/plain"},"key":"hsaId","value":"SE123-4567890"},{"description":{"content":"

Optional - The id of the user in Webdoc.

\n","type":"text/plain"},"key":"id","value":"3213d1a2-e4cc-4c70-8433-4bf48dbafbc2"}],"variable":[]}},"response":[{"id":"5d0f736e-c91b-4ec8-846e-88c6dab88efe","name":"GET Users - OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/users?lastName=Doe","host":["{{url}}"],"path":["v1","users"],"query":[{"key":"firstName","value":"Jake","description":"_Optional_ - The first name of the user in Webdoc","disabled":true},{"key":"lastName","value":"Doe","description":"_Optional_ - The last name of the user in Webdoc"},{"key":"personalNumber","value":"19121212-1212","description":"_Optional_ - The social security number of the user in Webdoc.","disabled":true},{"key":"hsaId","value":"SE123-4567890","description":"_Optional_ - The HSA id of the user in Webdoc.","disabled":true},{"key":"id","value":"3213d1a2-e4cc-4c70-8433-4bf48dbafbc2","description":"_Optional_ - The id of the user in Webdoc.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"23ffb670-fe34-90cf-b259-10986c60bc439\",\n \"firstName\": \"Jake\",\n \"lastName\": \"Doe\",\n \"personalNumber\": \"19121212-1212\",\n \"hsaId\": \"SE1234567890-E000000001234\",\n \"email\": \"doe@example.com\",\n \"phoneNumber\": \"+46701740626\",\n \"lastLoggedIn\": \"2022-01-01 12:00:00\",\n \"clinics\": [\n {\n \"id\": \"873ab456-097c-12fd-aaab-98365cb34009\",\n \"name\": \"Clinic 1\",\n \"hsaId\": \"SE1234567890-639n\",\n \"journalArchiveClinicId\": \"2ba91312-365a-11ef-94ad-0242ac120004\",\n \"invoiceInfo\": {\n \"companyName\": \"Test Company\"\n }\n },\n {\n \"id\": \"cd4509bf-230d-a09d-4a23-ef34009f12ad\",\n \"name\": \"Clinic 2\",\n \"hsaId\": \"SE1234567890-638n\",\n \"journalArchiveClinicId\": null,\n \"invoiceInfo\": {\n \"companyName\": \"Test Company\"\n }\n }\n ],\n \"settings\": {\n \"defaultCostCentreId\": \"34\",\n \"defaultRecordTemplateId\": null,\n \"defaultPatientTypeId\": \"2\"\n }\n },\n {\n \"id\": \"6222731b-acdc-4fa2-8500-3022fd0eeea3\",\n \"firstName\": \"Jake\",\n \"lastName\": \"Doe\",\n \"personalNumber\": \"20121212-1212\",\n \"hsaId\": \"SE1234567890-E000000001235\",\n \"email\": \"doe@example.com\",\n \"phoneNumber\": \"+46701740677\",\n \"lastLoggedIn\": \"2022-02-01 12:00:00\",\n \"clinics\": [\n {\n \"id\": \"873ab456-097c-12fd-aaab-98365cb34009\",\n \"name\": \"Clinic 1\",\n \"hsaId\": \"SE1234567890-639n\",\n \"journalArchiveClinicId\": \"2ba91312-365a-11ef-94ad-0242ac120004\",\n \"invoiceInfo\": {\n \"companyName\": \"Test Company\"\n }\n }\n ],\n \"settings\": {\n \"defaultCostCentreId\": \"83\",\n \"defaultRecordTemplateId\": \"67\",\n \"defaultPatientTypeId\": null\n }\n },\n {\n \"id\": \"6222731b-acdc-4fa2-8500-3022fd0eeea3\",\n \"firstName\": \"Jennyfer\",\n \"lastName\": \"Doe\",\n \"personalNumber\": \"20170105-2399 \",\n \"hsaId\": \"SE1234567890-E000000001236\",\n \"email\": \"doe@example.com\",\n \"phoneNumber\": \"+46701740677\",\n \"lastLoggedIn\": \"2022-03-01 12:00:00\",\n \"clinics\": null,\n \"settings\": {\n \"defaultCostCentreId\": \"83\",\n \"defaultRecordTemplateId\": \"67\",\n \"defaultPatientTypeId\": null\n }\n }\n]"},{"id":"d0cd6cea-6402-4e94-b9a8-31c3fb450947","name":"JSON Schema","originalRequest":{"method":"GET","header":[{"key":"JSON_Schema","value":"true"}],"url":{"raw":"{{url}}/v1/users?firstName=Test","host":["{{url}}"],"path":["v1","users"],"query":[{"key":"firstName","value":"Test","description":"_Optional_ - The first name of the user in Webdoc"},{"key":"lastName","value":"Doe","description":"_Optional_ - The last name of the user in Webdoc","disabled":true},{"key":"personalNumber","value":"19121212-1212","description":"_Optional_ - _Optional_ - The personal number of the patient in the format of YYYYMMDD-XXXX or YYYYMMDDXXXX.\nForeign personal numbers are also supported. The format needs to be YYYYMMDD-ZXXX or YYYYMMDDZXXX where Z is either M, K or X.","disabled":true},{"key":"hsaId","value":"SE123-4567890","description":"_Optional_ - The HSA id of the user in Webdoc.","disabled":true},{"key":"id","value":"3213d1a2-e4cc-4c70-8433-4bf48dbafbc2","description":"_Optional_ - The id of the user in Webdoc.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 14 Apr 2023 06:28:00 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.4.33"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"668"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Users\",\n \"items\": {\n \"title\": \"User\",\n \"required\": [\n \"id\",\n \"firstName\",\n \"lastName\",\n \"personalNumber\",\n \"hsaId\",\n \"email\",\n \"phoneNumber\",\n \"lastLoggedIn\",\n \"clinics\",\n \"settings\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"User's Id\",\n \"description\": \"User's Uuid\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"23ffb670-fe34-90cf-b259-10986c60bc439\"\n ],\n \"$id\": \"#/items/properties/id\",\n \"type\": \"string\"\n },\n \"firstName\": {\n \"title\": \"User's first name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Jake\"\n ],\n \"$id\": \"#/items/properties/firstName\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"title\": \"User's last name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Doe\"\n ],\n \"$id\": \"#/items/properties/lastName\",\n \"type\": \"string\"\n },\n \"personalNumber\": {\n \"title\": \"User's personal identifier\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"19121212-1212\"\n ],\n \"$id\": \"#/items/properties/personalNumber\",\n \"type\": \"string\"\n },\n \"hsaId\": {\n \"title\": \"User's HSA id\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"SE1234567890-E000000001234\"\n ],\n \"$id\": \"#/items/properties/hsaId\",\n \"type\": \"string\"\n },\n \"email\": {\n \"title\": \"User's email\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"doe@example.com\"\n ],\n \"$id\": \"#/items/properties/email\",\n \"type\": \"string\"\n },\n \"phoneNumber\": {\n \"title\": \"User's phone number\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"+46701740626\"\n ],\n \"$id\": \"#/items/properties/phoneNumber\",\n \"type\": \"string\"\n },\n \"lastLoggedIn\": {\n \"title\": \"Last logged in timestamp\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"2022-01-01 12:00:00\"\n ],\n \"$id\": \"#/items/properties/lastLoggedIn\",\n \"type\": \"string\"\n },\n \"clinics\": {\n \"title\": \"User clinics\",\n \"items\": {\n \"title\": \"User clinics\",\n \"required\": [\n \"id\",\n \"name\",\n \"hsaId\",\n \"invoiceInfo\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"The clinic ID\",\n \"default\": 0,\n \"examples\": [\n \"873ab456-097c-12fd-aaab-98365cb34009\"\n ],\n \"$id\": \"#/items/properties/clinics/items/properties/id\",\n \"type\": \"string\"\n },\n \"name\": {\n \"name\": \"The clinic name\",\n \"default\": 0,\n \"examples\": [\n \"Clinic 1\"\n ],\n \"$id\": \"#/items/properties/clinics/items/properties/name\",\n \"type\": \"string\"\n },\n \"hsaId\": {\n \"name\": \"The clinic HSA ID\",\n \"default\": 0,\n \"examples\": [\n \"SE1234567890-639n\"\n ],\n \"$id\": \"#/items/properties/clinics/items/properties/hsaId\",\n \"type\": \"string\"\n },\n \"invoiceInfo\": {\n \"title\": \"Clinic invoice info\",\n \"required\": [\n \"companyName\"\n ],\n \"additionalProperties\": true,\n \"properties\": {\n \"companyName\": {\n \"title\": \"Clinic invoice company name\",\n \"default\": 0,\n \"examples\": [\n \"Example Company\"\n ],\n \"$id\": \"#/items/properties/clinics/items/properties/invoiceInfo/properties/companyName\",\n \"type\": \"string\" \n }\n },\n \"$id\": \"#/items/properties/clinics/items/properties/invoiceInfo/properties\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"#/items/properties/clinics/items\",\n \"type\": \"object\"\n },\n \"$id\": \"#/items/properties/clinics\",\n \"type\": \"array\"\n },\n \"settings\": {\n \"title\": \"Settings\",\n \"required\": [\n \"defaultCostCentreId\",\n \"defaultRecordTemplateId\",\n \"defaultPatientTypeId\"\n ],\n \"properties\": {\n \"defaultCostCentreId\": {\n \"title\": \"Default cost centre Id\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"34\", null\n ],\n \"$id\": \"#/items/properties/settings/properties/defaultCostCentreId\",\n \"type\": [\"null\", \"string\"]\n },\n \"defaultRecordTemplateId\": {\n \"title\": \"Default record template Id\",\n \"default\": null,\n \"examples\": [\n \"22\", null\n ],\n \"$id\": \"#/items/properties/settings/properties/defaultRecordTemplateId\",\n \"type\": [\"null\", \"string\"]\n },\n \"defaultPatientTypeId\": {\n \"title\": \"Default patient type Id\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"2\", null\n ],\n \"$id\": \"#/items/properties/settings/properties/defaultPatientTypeId\",\n \"type\": [\"null\", \"string\"]\n }\n },\n \"$id\": \"#/items/properties/settings\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"#/items\",\n \"type\": \"object\"\n },\n \"$id\": \"http://webdoc.api/response/users/v1/get/users\",\n \"type\": \"array\",\n \"definitions\": {},\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}"}],"_postman_id":"cf1a2c5b-8251-46d6-a990-3c44464ec105"},{"name":"User by ID","id":"bc046596-d2d9-47a1-a5e8-1c514009a2fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/v1/users/:userId","description":"

Fetch user's data from Webdoc. If the user is not found in Webdoc an error code is returned.

\n

Allowed with one of the following scopes:

\n
    \n
  • users:read
    • \n
  • users:write
    • \n
\n","urlObject":{"path":["v1","users",":userId"],"host":["{{url}}"],"query":[],"variable":[{"description":{"content":"

Required - User identifier (UUID).

\n","type":"text/plain"},"type":"any","value":"574d3bfe-1128-4721-b259-2086c60bc405","key":"userId"}]}},"response":[{"id":"b91c348a-fe40-4304-aef5-d5b8c2e68777","name":"GET User by ID - OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/users/:userId","host":["{{url}}"],"path":["v1","users",":userId"],"variable":[{"key":"userId","value":"23ffb670-fe34-90cf-b259-10986c60bc439","description":"_Required_ - User identifier (UUID)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"23ffb670-fe34-90cf-b259-10986c60bc439\",\n \"firstName\": \"Jake\",\n \"lastName\": \"Doe\",\n \"personalNumber\": \"19121212-1212\",\n \"hsaId\": \"SE1234567890-E000000001234\",\n \"email\": \"doe@example.com\",\n \"phoneNumber\": \"+46701740626\",\n \"lastLoggedIn\": \"2022-01-01 12:00:00\",\n \"clinics\": [\n {\n \"id\": \"873ab456-097c-12fd-aaab-98365cb34009\",\n \"name\": \"Clinic 1\",\n \"hsaId\": \"SE1234567890-639n\",\n \"journalArchiveClinicId\": \"2ba91312-365a-11ef-94ad-0242ac120004\",\n \"invoiceInfo\": {\n \"companyName\": \"Test Company\"\n }\n },\n {\n \"id\": \"cd4509bf-230d-a09d-4a23-ef34009f12ad\",\n \"name\": \"Clinic 2\",\n \"hsaId\": \"SE1234567890-638n\",\n \"journalArchiveClinicId\": null,\n \"invoiceInfo\": {\n \"companyName\": \"Test Company\"\n }\n }\n ],\n \"settings\": {\n \"defaultCostCenterId\": \"34\",\n \"defaultRecordTemplateId\": null,\n \"defaultPatientTypeId\": \"2\"\n }\n}"},{"id":"4ca35110-bc53-4884-8652-567f5976d8fb","name":"GET User by ID - User not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/users/:userId","host":["{{url}}"],"path":["v1","users",":userId"],"variable":[{"key":"userId","value":"23ffb670-fe34-90cf-b259-10986c60bc439","description":"_Required_ - User identifier (UUID)."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Could not find any user with ID '5471f10f-f9b1-11eb-b518-0242ac12000'!\",\n \"code\": 1005\n}"},{"id":"8c3cb9ad-3bf2-4754-8ce7-56faa30e4763","name":"JSON Schema","originalRequest":{"method":"GET","header":[{"key":"JSON_Schema","value":"true"}],"url":{"raw":"{{url}}/v1/users/:userId","host":["{{url}}"],"path":["v1","users",":userId"],"variable":[{"key":"userId","value":"574d3bfe-1128-4721-b259-2086c60bc405","description":"_Required_ - User identifier (UUID)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 17 Apr 2023 05:05:19 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.4.33"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"346"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"User By ID\",\n \"required\": [\n \"id\",\n \"firstName\",\n \"lastName\",\n \"personalNumber\",\n \"hsaId\",\n \"phoneNumber\",\n \"email\",\n \"lastLoggedIn\",\n \"clinics\",\n \"settings\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"User's ID\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"574d3bfe-1128-4721-b259-2086c60bc405\"\n ],\n \"$id\": \"#/properties/id\",\n \"type\": \"string\"\n },\n \"firstName\": {\n \"title\": \"User's first name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Mio\"\n ],\n \"$id\": \"#/properties/firstName\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"title\": \"User's last name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Lundqvist\"\n ],\n \"$id\": \"#/properties/lastName\",\n \"type\": \"string\"\n },\n \"personalNumber\": {\n \"title\": \"User's personal identifier.\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"19951228-6080\"\n ],\n \"$id\": \"#/properties/personalNumber\",\n \"type\": \"string\"\n },\n \"hsaId\": {\n \"title\": \"User's HSA ID\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"SET5565594230-115R\"\n ],\n \"$id\": \"#/properties/hsaId\",\n \"type\": \"string\"\n },\n \"phoneNumber\": {\n \"title\": \"User's phone number\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"0707397922\"\n ],\n \"$id\": \"#/properties/phoneNumber\",\n \"type\": \"string\"\n },\n \"email\": {\n \"title\": \"User's email\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"jane.doe@webdoc.se\"\n ],\n \"$id\": \"#/properties/email\",\n \"type\": \"string\"\n },\n \"lastLoggedIn\": {\n \"title\": \"Last logged in timestamp\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"2024-06-14 14:00:16\"\n ],\n \"$id\": \"#/properties/lastLoggedIn\",\n \"type\": \"string\"\n },\n \"clinics\": {\n \"title\": \"User clinics.\",\n \"items\": {\n \"title\": \"User clinics.\",\n \"required\": [\n \"id\",\n \"name\",\n \"hsaId\",\n \"invoiceInfo\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"The clinic ID\",\n \"default\": 0,\n \"examples\": [\n \"873ab456-097c-12fd-aaab-98365cb34009\"\n ],\n \"$id\": \"#/properties/clinics/items/properties/id\",\n \"type\": \"string\"\n },\n \"name\": {\n \"name\": \"The clinic name\",\n \"default\": 0,\n \"examples\": [\n \"Clinic 1\"\n ],\n \"$id\": \"#/properties/clinics/items/properties/name\",\n \"type\": \"string\"\n },\n \"hsaId\": {\n \"name\": \"The clinic HSA ID\",\n \"default\": 0,\n \"examples\": [\n \"SE1234567890-639n\"\n ],\n \"$id\": \"#/properties/clinics/items/properties/hsaId\",\n \"type\": \"string\"\n },\n \"invoiceInfo\": {\n \"title\": \"Clinic invoice info schema\",\n \"required\": [\n \"companyName\"\n ],\n \"additionalProperties\": true,\n \"properties\": {\n \"companyName\": {\n \"title\": \"Clinic invoice company name\",\n \"default\": 0,\n \"examples\": [\n \"Example Company\"\n ],\n \"$id\": \"#/properties/clinics/items/properties/invoiceInfo/properties/companyName\",\n \"type\": \"string\" \n }\n },\n \"$id\": \"#/properties/clinics/items/properties/invoiceInfo/properties\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"#/properties/clinics/items\",\n \"type\": \"object\"\n },\n \"$id\": \"#/properties/clinics\",\n \"type\": \"array\"\n },\n \"settings\": {\n \"title\": \"Settings\",\n \"required\": [\n \"defaultCostCentreId\",\n \"defaultRecordTemplateId\",\n \"defaultPatientTypeId\"\n ],\n \"properties\": {\n \"defaultCostCentreId\": {\n \"title\": \"Default cost centre Id\",\n \"default\": null,\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"34\", null\n ],\n \"$id\": \"#/properties/settings/properties/defaultCostCentreId\",\n \"type\": [\"null\", \"string\"]\n },\n \"defaultRecordTemplateId\": {\n \"title\": \"Default record template Id\",\n \"default\": null,\n \"examples\": [\n \"22\", null\n ],\n \"$id\": \"#/properties/settings/properties/defaultRecordTemplateId\",\n \"type\": [\"null\", \"string\"]\n },\n \"defaultPatientTypeId\": {\n \"title\": \"Default patient type Id\",\n \"default\": null,\n \"examples\": [\n \"2\", null\n ],\n \"$id\": \"#/properties/settings/properties/defaultPatientTypeId\",\n \"type\": [\"null\", \"string\"]\n }\n },\n \"$id\": \"#/properties/settings\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"http://webdoc.api/response/users/v1/get/user_by_id\",\n \"type\": \"object\",\n \"definitions\": {},\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}"}],"_postman_id":"bc046596-d2d9-47a1-a5e8-1c514009a2fd"},{"name":"User Permissions by ID","event":[{"listen":"test","script":{"id":"aa07e5e0-d776-4eb9-8ac5-236dc19258b0","exec":[""],"type":"text/javascript"}}],"id":"e37c000d-02f0-4845-874f-d08ba015d369","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/v1/users/:uuid/permissions","description":"

Fetch user's permissions data per clinic from Webdoc. If the user's permission is not found in Webdoc an error code is returned.

\n

Allowed with the following scope:

\n

* users:read

\n","urlObject":{"path":["v1","users",":uuid","permissions"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":null,"key":"uuid"}]}},"response":[{"id":"07aeae8f-c5a5-4a6b-bbfc-d3fc1d801869","name":"Users Permission by id","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/users/:uuid/permissions","host":["{{url}}"],"path":["v1","users",":uuid","permissions"],"variable":[{"key":"uuid","value":"23ffb670-fe34-90cf-b259-10986c60bc439","description":"_Required_ - User identifier (UUID)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"34ffb670-fe34-90cf-b259-10986c60bc439\": {\n \"AdministratorReports\": \"full\",\n \"AdministratorSettings\": \"full\",\n \"AdministratorUsers\": \"none\",\n \"ReadRecords\": \"read\",\n \"WriteRecords\": \"read\",\n \"Invoicing\": \"read\",\n \"Caregiver\": \"no\",\n \"Calendar\": \"yes\",\n \"OnlineBooking\": \"read\",\n \"VisitRegistration\": \"read/write\",\n \"Referrals\": \"read/write\",\n \"TestResults\": \"read/write\",\n \"Notes\": \"read/write\",\n \"AddressLabels\": \"read/write\",\n \"Certificate\": \"read/write\",\n \"EconomicOverview\": \"read\",\n \"Files\": \"read/write\",\n \"PatientTemplates\": \"read\",\n \"SMSToPatient\": \"read/write\",\n \"SickNote\": \"read/write\",\n \"Dictation\": \"read/write\",\n \"PatientLetter\": \"read/write\",\n \"Cancellation\": \"read\",\n \"WaitingList\": \"read/write\",\n \"Surgery\": \"read/write\",\n \"SampleLabel\": \"read\",\n \"WelchAllyn\": \"read\",\n \"PatientLog\": \"read\",\n \"DrugPrescription\": \"read\",\n \"ReminderList\": \"read\",\n \"CashReport\": \"read\",\n \"Cachier\": \"read\",\n \"Addresses\": \"read\",\n \"Pascal\": \"read\",\n \"DeviationReporting\": \"read/write\",\n \"Warnings\": \"read\",\n \"Outgoing\": \"read\",\n \"eFreecard\": \"read\",\n \"administratePatientsPersonalNumber\": \"read\",\n \"DocumentOverview\": \"read/write\",\n \"vaccinations\": \"read\",\n \"GrowthMeasurements\": \"read/write\",\n \"bvcOverview\": \"read/write\",\n \"labelTemplate\": \"read\"\n },\n \"97ffb670-fe34-90cf-b259-10986c60bc439\": {\n \"AdministratorReports\": \"full\",\n \"AdministratorSettings\": \"full\",\n \"AdministratorUsers\": \"full\",\n \"ReminderList\": \"read\"\n }\n}"},{"id":"eb6dbdef-5cef-4ac3-9d9c-7d442d63752a","name":"JSON Schema","originalRequest":{"method":"GET","header":[{"key":"JSON_Schema","value":"true"}],"url":{"raw":"{{url}}/v1/users/:uuid/permissions","host":["{{url}}"],"path":["v1","users",":uuid","permissions"],"variable":[{"key":"uuid","value":"574d3bfe-1128-4721-b259-2086c60bc405"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 17 Apr 2023 14:35:51 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.4.33"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"2544"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"User permissions\",\n \"propertyNames\":{\n \"format\": \"uuid\"\n },\n \"additionalProperties\": {\n \"type\": \"object\",\n \"required\": [\n \"AdministratorReports\",\n \"AdministratorSettings\",\n \"AdministratorUsers\",\n \"ReadRecords\",\n \"WriteRecords\",\n \"Invoicing\",\n \"Caregiver\",\n \"Calendar\",\n \"OnlineBooking\",\n \"VisitRegistration\",\n \"Referrals\",\n \"TestResults\",\n \"Notes\",\n \"AddressLabels\",\n \"Certificate\",\n \"EconomicOverview\",\n \"Files\",\n \"PatientTemplates\",\n \"SMSToPatient\",\n \"SickNote\",\n \"Dictation\",\n \"PatientLetter\",\n \"Cancellation\",\n \"WaitingList\",\n \"Surgery\",\n \"SampleLabel\",\n \"WelchAllyn\",\n \"PatientLog\",\n \"DrugPrescription\",\n \"NationalPatientOverview\",\n \"CashReport\",\n \"Cachier\",\n \"Addresses\",\n \"Pascal\",\n \"DeviationReporting\",\n \"VardvalVGR\",\n \"Warnings\",\n \"Outgoing\",\n \"eFreecard\",\n \"DocumentOverview\",\n \"administratePatientsPersonalNumber\",\n \"vaccinations\",\n \"GrowthMeasurements\",\n \"bvcOverview\",\n \"labelTemplate\",\n \"organizationInformation\",\n \"organizationJournal\",\n \"organizationInvoice\",\n \"organizationAgreement\"\n ],\n \"properties\": {\n \"AdministratorReports\": {\n \"title\": \"Administrator Reports\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/AdministratorReports\",\n \"type\": \"string\"\n },\n \"AdministratorSettings\": {\n \"title\": \"Administrator Settings\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/AdministratorSettings\",\n \"type\": \"string\"\n },\n \"AdministratorUsers\": {\n \"title\": \"Administrator Users\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/AdministratorUsers\",\n \"type\": \"string\"\n },\n \"ReadRecords\": {\n \"title\": \"Read Records\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/ReadRecords\",\n \"type\": \"string\"\n },\n \"WriteRecords\": {\n \"title\": \"Write Records\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/WriteRecords\",\n \"type\": \"string\"\n },\n \"Invoicing\": {\n \"title\": \"Invoicing\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/Invoicing\",\n \"type\": \"string\"\n },\n \"Caregiver\": {\n \"title\": \"Caregiver\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"yes\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/Caregiver\",\n \"type\": \"string\"\n },\n \"Calendar\": {\n \"title\": \"Calendar\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"yes\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/Calendar\",\n \"type\": \"string\"\n },\n \"OnlineBooking\": {\n \"title\": \"Online Booking\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/OnlineBooking\",\n \"type\": \"string\"\n },\n \"VisitRegistration\": {\n \"title\": \"Visit Registration\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read/write\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/VisitRegistration\",\n \"type\": \"string\"\n },\n \"Referrals\": {\n \"title\": \"Referrals\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read/write\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/Referrals\",\n \"type\": \"string\"\n },\n \"TestResults\": {\n \"title\": \"Test Results\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read/write\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/TestResults\",\n \"type\": \"string\"\n },\n \"Notes\": {\n \"title\": \"Notes\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read/write\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/Notes\",\n \"type\": \"string\"\n },\n \"AddressLabels\": {\n \"title\": \"Address Labels\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/AddressLabels\",\n \"type\": \"string\"\n },\n \"Certificate\": {\n \"title\": \"Certificate\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read/write\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/Certificate\",\n \"type\": \"string\"\n },\n \"EconomicOverview\": {\n \"title\": \"Economic Overview\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/EconomicOverview\",\n \"type\": \"string\"\n },\n \"Files\": {\n \"title\": \"Files\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read/write\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/Files\",\n \"type\": \"string\"\n },\n \"PatientTemplates\": {\n \"title\": \"Patient Templates\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/PatientTemplates\",\n \"type\": \"string\"\n },\n \"SMSToPatient\": {\n \"title\": \"SMS To Patient\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read/write\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/SMSToPatient\",\n \"type\": \"string\"\n },\n \"SickNote\": {\n \"title\": \"Sick Note\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read/write\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/SickNote\",\n \"type\": \"string\"\n },\n \"Dictation\": {\n \"title\": \"Dictation\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read/write\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/Dictation\",\n \"type\": \"string\"\n },\n \"PatientLetter\": {\n \"title\": \"Patient Letter\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read/write\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/PatientLetter\",\n \"type\": \"string\"\n },\n \"Cancellation\": {\n \"title\": \"Cancellation\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/Cancellation\",\n \"type\": \"string\"\n },\n \"WaitingList\": {\n \"title\": \"WaitingList\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read/write\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/WaitingList\",\n \"type\": \"string\"\n },\n \"Surgery\": {\n \"title\": \"Surgery\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read/write\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/Surgery\",\n \"type\": \"string\"\n },\n \"SampleLabel\": {\n \"title\": \"Sample Label\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/SampleLabel\",\n \"type\": \"string\"\n },\n \"WelchAllyn\": {\n \"title\": \"Welch Allyn\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/WelchAllyn\",\n \"type\": \"string\"\n },\n \"PatientLog\": {\n \"title\": \"Patient Log\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/PatientLog\",\n \"type\": \"string\"\n },\n \"DrugPrescription\": {\n \"title\": \"Drug Prescription\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/DrugPrescription\",\n \"type\": \"string\"\n },\n \"NationalPatientOverview\": {\n \"title\": \"National Patient Overview\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"none\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/NationalPatientOverview\",\n \"type\": \"string\"\n },\n \"CashReport\": {\n \"title\": \"Cash Report\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/CashReport\",\n \"type\": \"string\"\n },\n \"Cachier\": {\n \"title\": \"Cachier\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/Cachier\",\n \"type\": \"string\"\n },\n \"Addresses\": {\n \"title\": \"Addresses\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/Addresses\",\n \"type\": \"string\"\n },\n \"Pascal\": {\n \"title\": \"Pascal\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/Pascal\",\n \"type\": \"string\"\n },\n \"DeviationReporting\": {\n \"title\": \"Deviation Reporting\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/DeviationReporting\",\n \"type\": \"string\"\n },\n \"VardvalVGR\": {\n \"title\": \"Vardval VGR\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/VardvalVGR\",\n \"type\": \"string\"\n },\n \"Warnings\": {\n \"title\": \"Warnings\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/Warnings\",\n \"type\": \"string\"\n },\n \"Outgoing\": {\n \"title\": \"Outgoing\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/Outgoing\",\n \"type\": \"string\"\n },\n \"eFreecard\": {\n \"title\": \"eFree card\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/eFreecard\",\n \"type\": \"string\"\n },\n \"DocumentOverview\": {\n \"title\": \"Document Overview\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read/write\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/DocumentOverview\",\n \"type\": \"string\"\n },\n \"administratePatientsPersonalNumber\": {\n \"title\": \"Administrate Patients Personal Number\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"yes\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/administratePatientsPersonalNumber\",\n \"type\": \"string\"\n },\n \"vaccinations\": {\n \"title\": \"Vaccinations\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/vaccinations\",\n \"type\": \"string\"\n },\n \"GrowthMeasurements\": {\n \"title\": \"Growth Measurements\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/GrowthMeasurements\",\n \"type\": \"string\"\n },\n \"bvcOverview\": {\n \"title\": \"Bvc Overview\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read/write\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/bvcOverview\",\n \"type\": \"string\"\n },\n \"labelTemplate\": {\n \"title\": \"Label Template\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"full\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/labelTemplate\",\n \"type\": \"string\"\n },\n \"organizationInformation\": {\n \"title\": \"Organization Information\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read/write\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/organizationInformation\",\n \"type\": \"string\"\n },\n \"organizationJournal\": {\n \"title\": \"Organization Journal\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read/write\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/organizationJournal\",\n \"type\": \"string\"\n },\n \"organizationInvoice\": {\n \"title\": \"Organization Invoice\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"read/write\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/organizationInvoice\",\n \"type\": \"string\"\n },\n \"organizationAgreement\": {\n \"title\": \"Organization Agreement\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"no\"\n ],\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613/properties/organizationAgreement\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/properties/481c97c5-0bd7-4aff-aca2-71ce9003b613\"\n },\n \"$id\": \"http://webdoc.api/response/users/v1/get/user_permissions_by_id\",\n \"type\": \"object\",\n \"definitions\": {},\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}"}],"_postman_id":"e37c000d-02f0-4845-874f-d08ba015d369"}],"id":"bce83391-3723-43a0-8bf4-f01af4f2c524","_postman_id":"bce83391-3723-43a0-8bf4-f01af4f2c524","description":""}],"id":"3cbcd2a7-dba6-4592-a21e-4ce201b6854a","_postman_id":"3cbcd2a7-dba6-4592-a21e-4ce201b6854a","description":""},{"name":"Visits","item":[{"name":"v1","item":[{"name":"Visits","id":"5a0f0e01-7ca1-4ee3-be16-88a659f4d912","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/v1/clinics/:clinicId/visits?personalNumber=19121212-1212&date=2024-12-20&fromDate=2024-12-20&toDate=2025-01-16&userId=5d89c632-dcbf-4697-938b-782b80a3e2f4&recordTemplateId=123&isSigned=1","description":"

Fetch visits from a specified clinic based on filters (query params).

\n

Examples of use cases:

\n
    \n

  • Get visits for a specific patient.

    \n
    • \n

  • Get visitis for a specific date.

    \n
    • \n

  • Get visits for a specific period of time.

    \n
    • \n
\n

Allowed with the following scope:

\n
    \n
  • self-service
    • \n
\n","urlObject":{"path":["v1","clinics",":clinicId","visits"],"host":["{{url}}"],"query":[{"description":{"content":"

Optional - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, and YYMMDDXXXX.\nForeign personal numbers are also supported. The format needs to be YYYYMMDD-ZXXX, YYYYMMDDZXXX or even in the reduced format of YYMMDD-ZXXX and YYMMDDZXXX where Z is either M, K or X.

\n","type":"text/plain"},"key":"personalNumber","value":"19121212-1212"},{"description":{"content":"

Optional - Visits date in the format of YYYY-MM-DD. Timezone: 'CET'.

\n","type":"text/plain"},"key":"date","value":"2024-12-20"},{"description":{"content":"

Optional - Lower limit date in the format of YYYY-MM-DD. Timezone: 'CET'.

\n","type":"text/plain"},"key":"fromDate","value":"2024-12-20"},{"description":{"content":"

Optional - Upper limit date in the format of YYYY-MM-DD. Timezone: 'CET'.

\n","type":"text/plain"},"key":"toDate","value":"2025-01-16"},{"description":{"content":"

Optional - The id of a specific user (caregiver).

\n","type":"text/plain"},"key":"userId","value":"5d89c632-dcbf-4697-938b-782b80a3e2f4"},{"description":{"content":"

Optional - The id of a specific record template.

\n","type":"text/plain"},"key":"recordTemplateId","value":"123"},{"description":{"content":"

Optional - 0 = Only unsigned visits. 1 = Only signed visits. If absent, all visits regardless of sign status will be returned.

\n","type":"text/plain"},"key":"isSigned","value":"1"}],"variable":[{"description":{"content":"

Required - Clinic identifier (UUID).

\n","type":"text/plain"},"type":"any","value":"873ab456-097c-12fd-aaab-98365cb34009","key":"clinicId"}]}},"response":[{"id":"4d2ff76a-cbf3-41fe-8c2c-f37bb8fe3b20","name":"Visits","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v1/clinics/:clinicId/visits?personalNumber=19121212-1212&date=2024-12-20&fromDate=2024-12-20&toDate=2025-01-16&userId=5d89c632-dcbf-4697-938b-782b80a3e2f4&recordTemplateId=123&isSigned=1","host":["{{url}}"],"path":["v1","clinics",":clinicId","visits"],"query":[{"key":"personalNumber","value":"19121212-1212","description":"_Optional_ - _Optional_ - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDD+XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, YYMMDD+XXXX and YYMMDDXXXX."},{"key":"date","value":"2024-12-20","description":"_Optional_ - A specific date for the visits in the format of YYYY-MM-DD. Timezone: 'CET'"},{"key":"fromDate","value":"2024-12-20","description":"_Optional_ - A date to determine from which date the visits in the reply should contain"},{"key":"toDate","value":"2025-01-16","description":"_Optional_ A date to determine to which date the visits in the reply should contain"},{"key":"userId","value":"5d89c632-dcbf-4697-938b-782b80a3e2f4","description":"_Optional_ The id of a specific user (caregiver)."},{"key":"recordTemplateId","value":"123","description":"_Optional_ The id of a specific record template."},{"key":"isSigned","value":"1","description":"_Optional_ 0 = only unsigned visits. 1 = only signed visits. If absent, all visits regarding of sign status will be returned."}],"variable":[{"key":"clinicId","value":"873ab456-097c-12fd-aaab-98365cb34009","description":"_Required_ - Clinic identifier (UUID)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"a17daa2e-75c7-417f-867f-d6eecb4e87f4\",\n \"clinicId\": \"873ab456-097c-12fd-aaab-98365cb34009\",\n \"visitDate\": \"2025-01-15\",\n \"recordTemplateId\": \"123\",\n \"bookingId\": \"f17f40c0-e5be-44d3-9dfe-98527c5fa706\",\n \"injuryNumber\": \"123456-7890\",\n \"payments\": [\n {\n \"patientFee\": \"300\",\n \"amount\": 1,\n \"comment\": \"X-Ray cost\",\n \"VATPercentage\": 0,\n \"VAT\": 0,\n \"expiryDate\": \"2025-02-14\",\n \"articleName\": \"Action code name\"\n }\n ],\n \"patient\": {\n \"personalNumber\": \"19121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Privat\",\n \"address\": {\n \"streetName\": \"Test Address 123\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\",\n \"coAddress\": \"Jane Doe\"\n },\n \"mobilePhone\": \"+46701740605\"\n },\n \"caregiver\": {\n \"id\": \"5d89c632-dcbf-4697-938b-782b80a3e2f4\",\n \"title\": \"Doctor\",\n \"firstName\": \"Jake\",\n \"lastName\": \"Doe\",\n \"identifier\": \"20121212-1212\"\n }\n },\n {\n \"id\": \"0c7a81aa-86a0-4170-a974-5f84b8c71e46\",\n \"clinicId\": \"873ab456-097c-12fd-aaab-98365cb34009\",\n \"visitDate\": \"2024-12-22\",\n \"recordTemplateId\": \"123\",\n \"bookingId\": \"2ebdb8c7-1792-4693-b90d-d304a06b4017\",\n \"injuryNumber\": \"078910-1234\",\n \"payments\": [],\n \"patient\": {\n \"personalNumber\": \"19121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Privat\",\n \"address\": {\n \"streetName\": \"Test Address 123\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\",\n \"coAddress\": \"Jane Doe\"\n },\n \"mobilePhone\": \"+46701740605\"\n },\n \"caregiver\": {\n \"id\": \"5d89c632-dcbf-4697-938b-782b80a3e2f4\",\n \"title\": \"Doctor\",\n \"firstName\": \"Jake\",\n \"lastName\": \"Doe\",\n \"identifier\": \"20121212-1212\"\n }\n }\n]"},{"id":"f27923fd-7002-4775-bea4-11fa2d150296","name":"JSON Schema","originalRequest":{"method":"GET","header":[{"key":"JSON_Schema","value":"true"}],"url":{"raw":"{{url}}/v1/clinics/:clinicId/visits?personalNumber=19121212-1212&toDate=2025-01-16","host":["{{url}}"],"path":["v1","clinics",":clinicId","visits"],"query":[{"key":"personalNumber","value":"19121212-1212","description":"_Optional_ -_Optional_ - The personal number of the patient in the format of YYYYMMDD-XXXX, YYYYMMDDXXXX or even in the reduced format of YYMMDD-XXXX, and YYMMDDXXXX.\nForeign personal numbers are also supported. The format needs to be YYYYMMDD-ZXXX, YYYYMMDDZXXX or even in the reduced format of YYMMDD-ZXXX and YYMMDDZXXX where Z is either M, K or X."},{"key":"date","value":"2024-12-20","description":"_Optional_ - Visits date in the format of YYYY-MM-DD. Timezone: 'CET'.","disabled":true},{"key":"fromDate","value":"2024-12-20","description":"_Optional_ - Lower limit date in the format of YYYY-MM-DD. Timezone: 'CET'.","disabled":true},{"key":"toDate","value":"2025-01-16"}],"variable":[{"key":"clinicId","value":"481c97c5-0bd7-4aff-aca2-71ce9003b613","description":"_Required_ - Clinic identifier (UUID)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 17 Apr 2023 06:36:30 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.4.33"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Visits\",\n \"items\": {\n \"title\": \"Visit\",\n \"required\": [\n \"id\",\n \"clinicId\",\n \"visitDate\",\n \"recordTemplateId\",\n \"injuryNumber\",\n \"bookingId\",\n \"patient\",\n \"caregiver\"\n ],\n \"additionalProperties\": true,\n \"properties\": {\n \"id\": {\n \"title\": \"Visit Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/items/properties/id\"\n },\n \"clinicId\": {\n \"title\": \"Clinic Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/items/properties/clinicId\"\n },\n \"visitDate\": {\n \"title\": \"Visit date\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"2020-06-05 13:23:50\"\n ],\n \"$id\": \"#/items/properties/visitDate\",\n \"type\": \"string\"\n },\n \"recordTemplateId\": {\n \"title\": \"Record template Id\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"112\"\n ],\n \"$id\": \"#/items/properties/recordTemplateId\",\n \"type\": \"string\"\n },\n \"injuryNumber\": {\n \"title\": \"Injury number\",\n \"default\": null,\n \"examples\": [\n null\n ],\n \"$id\": \"#/items/properties/injuryNumber\",\n \"type\": [\"null\", \"string\"]\n },\n \"bookingId\": {\n \"title\": \"Booking Id\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"2fb1fb5a-e359-4c40-a69b-ae2d15d5d62a\"\n ],\n \"$id\": \"#/items/properties/bookingId\",\n \"type\": [\"null\", \"string\"]\n },\n \"payments\": {\n \"title\": \"Payments\",\n \"items\": {\n \"title\": \"Payment\",\n \"required\": [\n \"price\",\n \"amount\",\n \"comment\",\n \"account\",\n \"VATPercentage\",\n \"VAT\",\n \"expiryDate\",\n \"articleName\"\n ],\n \"additionalProperties\": true,\n \"properties\": {\n \"price\": {\n \"title\": \"Price\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n null, \"200\"\n ],\n \"$id\": \"#/items/properties/payments/items/properties/price\",\n \"type\": [\"null\", \"string\", \"integer\"]\n },\n \"amount\": {\n \"title\": \"Amount\",\n \"default\": 0,\n \"examples\": [\n 1\n ],\n \"$id\": \"#/items/properties/payments/items/properties/amount\",\n \"type\": \"integer\"\n },\n \"comment\": {\n \"title\": \"Comment\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Patientavgift avseende besök på WebDoc nr1 den 2020-06-05 för Tolvan Tolvansson 19121212-1212\"\n ],\n \"$id\": \"#/items/properties/payments/items/properties/comment\",\n \"type\": \"string\"\n },\n \"account\": {\n \"title\": \"Account\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"3010\"\n ],\n \"$id\": \"#/items/properties/payments/items/properties/account\",\n \"type\": \"string\"\n },\n \"VATPercentage\": {\n \"title\": \"VAT percentage\",\n \"default\": 0,\n \"examples\": [\n 0\n ],\n \"$id\": \"#/items/properties/payments/items/properties/VATPercentage\",\n \"type\": \"integer\"\n },\n \"VAT\": {\n \"title\": \"VAT\",\n \"default\": 0,\n \"examples\": [\n 0\n ],\n \"$id\": \"#/items/properties/payments/items/properties/VAT\",\n \"type\": \"integer\"\n },\n \"expiryDate\": {\n \"title\": \"Expiry date\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"2023-05-17\"\n ],\n \"$id\": \"#/items/properties/payments/items/properties/expiryDate\",\n \"type\": \"string\"\n },\n \"freeByFreeCard\": {\n \"title\": \"Is the visit fee free due to free card\",\n \"default\": false,\n \"examples\": [\n false\n ],\n \"$id\": \"#/items/properties/payments/items/properties/freeByFreeCard\",\n \"type\": \"boolean\"\n },\n \"reducedByFreeCard\": {\n \"title\": \"Is the visit fee reduced by free card\",\n \"default\": false,\n \"examples\": [\n false\n ],\n \"$id\": \"#/items/properties/payments/items/properties/reducedByFreeCard\",\n \"type\": \"boolean\"\n },\n \"articleName\": {\n \"title\": \"Article name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Patientavgift\"\n ],\n \"$id\": \"#/items/properties/payments/items/properties/articleName\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/items/properties/payments/items\",\n \"type\": \"object\"\n },\n \"$id\": \"#/items/properties/payments\",\n \"type\": \"array\"\n },\n \"patient\": {\n \"title\": \"Patient\",\n \"required\": [\n \"personalNumber\",\n \"firstName\",\n \"lastName\",\n \"patientType\",\n \"address\",\n \"mobilePhone\"\n ],\n \"properties\": {\n \"personalNumber\": {\n \"title\": \"Patient's personal identifier\",\n \"$ref\": \"#/definitions/personalNumber\",\n \"$id\": \"#/items/properties/patient/properties/personalNumber\"\n },\n \"firstName\": {\n \"title\": \"Patient's first name\",\n \"$ref\": \"#/definitions/properName\",\n \"$id\": \"#/items/properties/patient/properties/firstName\"\n },\n \"lastName\": {\n \"title\": \"Patient's last name\",\n \"$ref\": \"#/definitions/properName\",\n \"$id\": \"#/items/properties/patient/properties/lastName\"\n },\n \"patientType\": {\n \"title\": \"Patient's patient type\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"VGR Primärvård\"\n ],\n \"$id\": \"#/items/properties/patient/properties/patientType\",\n \"type\": \"string\"\n },\n \"address\": {\n \"title\": \"Patient's address\",\n \"required\": [\n \"streetName\",\n \"city\",\n \"zipCode\"\n ],\n \"properties\": {\n \"streetName\": {\n \"title\": \"Street name\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Nellickevägen 20\"\n ],\n \"$id\": \"#/items/properties/patient/properties/address/properties/streetName\",\n \"type\": \"string\"\n },\n \"city\": {\n \"title\": \"City\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"GÖTEBORG\"\n ],\n \"$id\": \"#/items/properties/patient/properties/address/properties/city\",\n \"type\": \"string\"\n },\n \"zipCode\": {\n \"title\": \"Zip code\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"41263\"\n ],\n \"$id\": \"#/items/properties/patient/properties/address/properties/zipCode\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/items/properties/patient/properties/address\",\n \"type\": \"object\"\n },\n \"mobilePhone\": {\n \"title\": \"Mobile phone\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"\"\n ],\n \"$id\": \"#/items/properties/patient/properties/mobilePhone\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"#/items/properties/patient\",\n \"type\": \"object\"\n },\n \"caregiver\": {\n \"title\": \"Caregiver\",\n \"required\": [\n \"id\",\n \"title\",\n \"firstName\",\n \"lastName\",\n \"identifier\"\n ],\n \"properties\": {\n \"id\": {\n \"title\": \"Caregiver's Id\",\n \"$ref\": \"#/definitions/uuid\",\n \"$id\": \"#/items/properties/caregiver/properties/id\"\n },\n \"title\": {\n \"title\": \"Caregiver's title\",\n \"default\": \"\",\n \"pattern\": \"^(.*)$\",\n \"examples\": [\n \"Läkare\"\n ],\n \"$id\": \"#/items/properties/caregiver/properties/title\",\n \"type\": \"string\"\n },\n \"firstName\": {\n \"title\": \"Caregiver's first name\",\n \"$ref\": \"#/definitions/properName\",\n \"$id\": \"#/items/properties/caregiver/properties/firstName\"\n },\n \"lastName\": {\n \"title\": \"Caregiver's last name\",\n \"$ref\": \"#/definitions/properName\",\n \"$id\": \"#/items/properties/caregiver/properties/lastName\"\n },\n \"identifier\": {\n \"title\": \"Caregiver's personal identifier\",\n \"$ref\": \"#/definitions/personalNumber\",\n \"$id\": \"#/items/properties/caregiver/properties/identifier\"\n }\n },\n \"$id\": \"#/items/properties/caregiver\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"#/items\",\n \"type\": \"object\"\n },\n \"$id\": \"http://example.org/root.json#\",\n \"type\": \"array\",\n \"definitions\": {\n \"uuid\": {\n \"$id\": \"#/definitions/uuid\",\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"default\": \"\",\n \"examples\": [\n \"ee4d906f-2eca-4345-9907-a4c6c2fcd931\"\n ]\n },\n \"personalNumber\": {\n \"$id\": \"#/definitions/personalNumber\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^([0-9]{6}|[0-9]{8})[-+]?[0-9]{4}$\",\n \"examples\": [\n \"19121212-1212\", \"121212-1212\",\n \"19121212+1212\", \"121212+1212\",\n \"191212121212\", \"1212121212\"\n ] \n },\n \"time\": {\n \"$id\": \"#/definitions/time\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^[01][0-9]|2[0-3]:[0-5][0-9]$\",\n \"examples\": [\n \"19:25\"\n ] \n },\n \"hsaId\": {\n \"$id\": \"#/definitions/hsaId\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^SE[0-9]{10}-[0-9A-Za-z]+$\",\n \"examples\": [\n \"SE2321000131-007643n\"\n ]\n },\n \"properName\": {\n \"$id\": \"#/definitions/properName\",\n \"type\": \"string\",\n \"default\": \"\",\n \"pattern\": \"^[A-ZÅÄÖ][a-zåäöA-ZÅÄÖ \\\\-_.]+$\",\n \"examples\": [\n \"Joe\", \"Jean-Pierre\", \"Anna Maria\"\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}"}],"_postman_id":"5a0f0e01-7ca1-4ee3-be16-88a659f4d912"},{"name":"Visit Record Signatures","id":"0e2bbfab-43ce-4768-9f33-ef8173971370","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"23ffb670-fe34-90cf-b259-10986c60bc439\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/visits/:visitId/records/signatures","description":"

Available as of Webdoc 6.38\n

Create a signature for a visit record.\n

Note! Signing visit records via API requires that signature password verification via Webdoc is disabled. In production environments, this can be done by contacting support@evimeria.se.\n

Available post parameters (bold parameters are required):

\n
    \n
  • userId\n
    (The user ID in UUID format of the caregiver that creates the signature.)
    • \n
\n

Allowed with the following scope:

\n
    \n
  • record-signatures:write
    • \n
\n","urlObject":{"path":["v1","visits",":visitId","records","signatures"],"host":["{{url}}"],"query":[],"variable":[{"id":"6aaa8d0d-f68a-4d40-892c-70c1d1ec0702","description":{"content":"

Required - The visit ID to be signed (UUID).

\n","type":"text/plain"},"type":"any","value":"a17daa2e-75c7-417f-867f-d6eecb4e87f4","key":"visitId"}]}},"response":[{"id":"19e3a5e4-a96b-430a-9095-78e6ce4057cd","name":"Visit record signature OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"23ffb670-fe34-90cf-b259-10986c60bc439\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/visits/:visitId/records/signatures","host":["{{url}}"],"path":["v1","visits",":visitId","records","signatures"],"variable":[{"key":"visitId","value":"a17daa2e-75c7-417f-867f-d6eecb4e87f4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"66466cf7-c65e-48d2-9d67-0c0f561f0cce","name":"Visits signature no permissions","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"d29e23b2-def9-4804-85e8-79e0d6192b81\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/visits/:visitId/records/signatures","host":["{{url}}"],"path":["v1","visits",":visitId","records","signatures"],"variable":[{"key":"visitId","value":"a17daa2e-75c7-417f-867f-d6eecb4e87f4"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1006,\n \"message\": \"The user ID '23ffb670-fe34-90cf-b259-10986c60bc439' does not have sufficient permissions to sign this visit record!\"\n }\n}"},{"id":"561cd9d1-e08d-483c-b4ce-45488d89a1ab","name":"Visits records locked","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"d29e23b2-def9-4804-85e8-79e0d6192b81\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/visits/:visitId/records/signatures","host":["{{url}}"],"path":["v1","visits",":visitId","records","signatures"],"variable":[{"key":"visitId","value":"a17daa2e-75c7-417f-867f-d6eecb4e87f4"}]}},"status":"Locked","code":423,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 6903,\n \"message\": \"The visit ID 'a17daa2e-75c7-417f-867f-d6eecb4e87f4' is already signed and locked!\"\n }\n}"},{"id":"1e15a030-9c2c-467a-8921-61d1725ff25d","name":"Visit record signature needs password","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"d29e23b2-def9-4804-85e8-79e0d6192b81\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/visits/:visitId/records/signatures","host":["{{url}}"],"path":["v1","visits",":visitId","records","signatures"],"variable":[{"key":"visitId","value":"a17daa2e-75c7-417f-867f-d6eecb4e87f4"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 6904,\n \"message\": \"Signing visit records needs password verification via Webdoc!\"\n }\n}"}],"_postman_id":"0e2bbfab-43ce-4768-9f33-ef8173971370"}],"id":"b5af34c5-7a78-4b7d-8f65-d5be2613c23b","_postman_id":"b5af34c5-7a78-4b7d-8f65-d5be2613c23b","description":""},{"name":"v2","item":[{"name":"Visits From Bookings","id":"4c8770c5-0d9a-4666-b9db-8245b2fbd5cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"bookingId\": \"d29e23b2-def9-4804-85e8-79e0d6192b81\",\n \"visitDate\": \"2017-01-01\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v2/visits","description":"

Create a new visit from a provided booking.

\n

(This endpoint can be used in the context of a patient arrival registration at a clinic. You can read a more detailed tutorial about the self-service flow on the Integrator Portal: https://integratorportal.carasent.net/faq/wd-arrival-registration-docs)

\n

Available post parameters (bold parameters are required):

\n
    \n
  • bookingId
    • \n
  • visitDate
    (The visit date in the format of YYYY-MM-DD. Timezone: 'CET'.)
    • \n
\n

Allowed with the following scope:

\n
    \n
  • self-service
    • \n
\n","urlObject":{"path":["v2","visits"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"8dad00ec-6d7c-4e9f-be63-401b5dbaadb9","name":"Visits","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"bookingId\": \"d29e23b2-def9-4804-85e8-79e0d6192b81\",\n \"visitDate\": \"2018-10-11\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v2/visits"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"a17daa2e-75c7-417f-867f-d6eecb4e87f4\",\n \"clinicId\": \"873ab456-097c-12fd-aaab-98365cb34009\",\n \"visitDate\": \"2018-10-11\",\n \"bookingId\": \"d29e23b2-def9-4804-85e8-79e0d6192b81\",\n \"payments\": [\n {\n \"price\": \"200\",\n \"amount\": 1,\n \"comment\": \"Checkup visit\",\n \"account\": \"3325\",\n \"VATPercentage\": \"25\",\n \"VAT\": \"50\",\n \"expiryDate\": \"2018-11-11\",\n \"articleName\": \"Checkup visit\"\n }\n ],\n \"patient\": {\n \"personalNumber\": \"19121212-1212\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"patientType\": \"Private\",\n \"address\": {\n \"streetName\": \"Test street 123\",\n \"city\": \"Gothenburg\",\n \"zipCode\": \"12345\"\n },\n \"mobilePhone\": \"+46701740605\"\n },\n \"caregiver\": {\n \"title\": \"Doctor\",\n \"firstName\": \"Jake\",\n \"lastName\": \"Doe\",\n \"identifier\": \"20121212-1212\"\n }\n}"}],"_postman_id":"4c8770c5-0d9a-4666-b9db-8245b2fbd5cd"}],"id":"3df0abde-536e-46c6-bccd-4fea93af340c","_postman_id":"3df0abde-536e-46c6-bccd-4fea93af340c","description":""}],"id":"860acfe9-01a5-4610-b5e6-c8c6db624489","_postman_id":"860acfe9-01a5-4610-b5e6-c8c6db624489","description":""},{"name":"Health check","id":"f8f2567c-e02f-4cbf-beb8-84b309a21df6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v1/health-check","description":"

Check if the web server and Webdoc polling are running correctly.

\n","urlObject":{"path":["v1","health-check"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"dbec4081-07b6-45e5-9359-4bce386a66c1","name":"Health check","originalRequest":{"method":"GET","header":[],"url":"{{url}}/v1/health-check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 17 Jan 2021 18:45:40 GMT"},{"key":"Server","value":"Apache"},{"key":"Set-Cookie","value":"PHPSESSID=vhsrkbeg34dmccn2qe0icivc3d; path=/"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"https://api-doc.atlan.se"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"}],"_postman_id":"f8f2567c-e02f-4cbf-beb8-84b309a21df6"}],"event":[{"listen":"prerequest","script":{"id":"149e7e1c-3add-47b4-8f38-f1f83ea13c6d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"31f84b91-41a9-46bc-a023-7f9972cdddd4","type":"text/javascript","exec":[""]}}]}