{"info":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","description":"<html><head></head><body><p>This collection shows how a hospital system (patient administration, scheduling, document management) exchanges administrative data with the heyPatient app through <strong>FHIR R4</strong>: connection and admission requests, appointments, tasks, documents and messages.</p>\n<h2 id=\"how-it-works\">How it works</h2>\n<ul>\n<li>heyPatient runs one FHIR R4 server per hospital and environment, hosted on Microsoft Azure in Switzerland:\n<code>https://heypatienthds&lt;environment&gt;-&lt;hospital&gt;.fhir.azurehealthcareapis.com</code></li>\n<li>The hospital system reads and writes resources there with standard FHIR REST calls (<code>GET</code>, <code>PUT</code>, <code>POST</code>, <code>PATCH</code>, <code>DELETE</code>).</li>\n<li>heyPatient is notified of every change, reads the current version of the resource, and updates the patient's app. The patient receives a notification where the sections below say so.</li>\n<li>heyPatient writes to the same server: patients who ask to connect, admission requests with their documents, check-ins, and status updates.</li>\n</ul>\n<h2 id=\"what-heypatient-reads\">What heyPatient reads</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Resource</th>\n<th>Shown to the patient as</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>Patient</code></td>\n<td>Confirmed connection and admission (local PID and FID); patient data for patients without the app</td>\n</tr>\n<tr>\n<td><code>Encounter</code></td>\n<td>Case number (FID) of an admission request</td>\n</tr>\n<tr>\n<td><code>Appointment</code></td>\n<td>Appointment in the timeline</td>\n</tr>\n<tr>\n<td><code>Task</code></td>\n<td>To-do in the inbox</td>\n</tr>\n<tr>\n<td><code>DocumentReference</code></td>\n<td>Document in the inbox</td>\n</tr>\n<tr>\n<td><code>Communication</code></td>\n<td>Message in the inbox</td>\n</tr>\n</tbody>\n</table>\n</div><p>Other resource types can be stored on the server, but they do not appear in the app.</p>\n<h2 id=\"conventions\">Conventions</h2>\n<ul>\n<li><strong><code>https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com</code></strong> is the hospital's FHIR server. The requests use the DEMO hospital on staging: <code>https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com</code>.</li>\n<li><strong><code>DEMO</code></strong> is the hospital's identifier at heyPatient, for example <code>DEMO</code>. It is part of several identifier systems, such as <code>http://fhir.heypatient.com/valuesets/DEMO-PID</code>. Document codes use it in lower case (<code>demo</code>, for example <code>demo</code>). heyPatient tells you yours.</li>\n<li><strong>References</strong> are relative and use the FHIR resource id: <code>Patient/&lt;id&gt;</code>, not the PID.</li>\n<li><strong>Resource ids:</strong> heyPatient's <code>Patient</code>, <code>Encounter</code>, <code>AuditEvent</code> and patient documents get server-assigned ids. Update them under the id you read. For your own resources, choose the id with <code>PUT</code> (for example your appointment number) or let the server assign one with <code>POST</code>.</li>\n<li><strong>Identifier <code>use</code>:</strong> <code>official</code>, <code>temp</code>, <code>old</code> or <code>secondary</code>.</li>\n<li><strong>Times</strong> carry a UTC offset. The app shows them in Swiss time (Europe/Zurich).</li>\n<li><strong>Reserved tags:</strong> the meta tag system <code>http://fhir.heypatient.com/meta-tags/last-heypatient-update</code> and the tag system <code>https://heypatient.com/fhir/tags</code> mark heyPatient's own writes. Do not set them.</li>\n<li><strong>Searches</strong> return pages of up to 100 entries; follow the <code>next</code> link in the Bundle to read further pages.</li>\n</ul>\n<h2 id=\"environments\">Environments</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Environment</th>\n<th>FHIR server</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Test (staging)</td>\n<td><code>https://heypatienthdsstaging-&lt;hospital&gt;.fhir.azurehealthcareapis.com</code></td>\n</tr>\n<tr>\n<td>Production</td>\n<td><code>https://heypatienthdsprod-&lt;hospital&gt;.fhir.azurehealthcareapis.com</code></td>\n</tr>\n</tbody>\n</table>\n</div><p>heyPatient sets up a technical user for each hospital and environment; see <strong>Authentication</strong>.</p>\n<h2 id=\"changes-in-november-2026\">Changes in November 2026</h2>\n<p>This version replaces the 2023 version and describes heyPatient as it works today.</p>\n<ul>\n<li><strong>Authentication:</strong> the token request needs no client secret.</li>\n<li><strong>Connection requests:</strong> confirm under the <code>Patient</code> id you read, and set the PID with <code>use: official</code> in the same write. The JSON Patch variant replaces the whole identifier.</li>\n<li><strong>Admissions:</strong> find requests with <code>class=AMB</code>; write the case number with <code>use: official</code>.</li>\n<li><strong>Appointments:</strong> <code>pending</code> announces a new appointment; new: <code>AppointmentSuppressNotifications</code>, <code>required: information-only</code>, cancelling and deleting.</li>\n<li><strong>Tasks:</strong> the task type goes into <code>code.id</code>; <code>basedOn</code> links a task to an appointment; <code>executionPeriod</code> and <code>restriction.period.end</code> set when it shows and when it is due.</li>\n<li><strong>Documents:</strong> type and category codes come from heyPortal; documents can also be https links; up to 20 MB per file.</li>\n<li><strong>Messages:</strong> <code>Communication</code> with <code>status: in-progress</code>, <code>recipient</code> and <code>topic.text</code>.</li>\n<li><strong>New:</strong> patient data reference, documents uploaded by patients, check-ins (<code>AuditEvent</code>).</li>\n<li><strong>Removed:</strong> heyPatient's internal sublimd calls (form tasks with a URL are in <strong>Tasks</strong>).</li>\n</ul>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15566227","collectionId":"91005237-b0b4-45a9-8390-40f2292e5253","publishedId":"2s93CNNtJu","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-11-14T12:26:20.000Z"},"item":[{"name":"Authentication","item":[{"name":"Get token","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function () {","    pm.response.to.have.status(200);","});","pm.collectionVariables.set(\"accessToken\", pm.response.json().access_token);"]}}],"id":"80e40524-75df-48e4-9b45-30aa08f47ca0","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"client_id","value":"","type":"text"},{"key":"scope","value":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/user_impersonation offline_access","type":"text"},{"key":"username","value":"","type":"text"},{"key":"password","value":"","type":"text"}]},"url":"https://login.microsoftonline.com/f049c21e-43d2-4bf5-9209-dbaa9e9e278e/oauth2/v2.0/token","description":"<p>Requests an access token for <code>https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com</code>. The test script stores it in the collection variable <code>accessToken</code>, which the other requests use.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>grant_type</code></td>\n<td><code>password</code></td>\n</tr>\n<tr>\n<td><code>client_id</code></td>\n<td>client id from heyPatient</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td><code>https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/user_impersonation offline_access</code></td>\n</tr>\n<tr>\n<td><code>username</code></td>\n<td>technical user</td>\n</tr>\n<tr>\n<td><code>password</code></td>\n<td>its password</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["f049c21e-43d2-4bf5-9209-dbaa9e9e278e","oauth2","v2.0","token"],"host":["login","microsoftonline","com"],"query":[],"variable":[]}},"response":[{"id":"2cccef8d-c29b-4644-995e-fa8fb48b820e","name":"Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"client_id","value":"","type":"text"},{"key":"scope","value":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/user_impersonation offline_access","type":"text"},{"key":"username","value":"","type":"text"},{"key":"password","value":"","type":"text"}]},"url":"https://login.microsoftonline.com/f049c21e-43d2-4bf5-9209-dbaa9e9e278e/oauth2/v2.0/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"token_type\": \"Bearer\",\n  \"scope\": \"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/user_impersonation\",\n  \"expires_in\": 4486,\n  \"ext_expires_in\": 4486,\n  \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJodHRwczovL2hleXBhdGllbnRoZHMuLi4ifQ.c2lnbmF0dXJl\",\n  \"refresh_token\": \"1.AQIAH8JJ8E...\"\n}"}],"_postman_id":"80e40524-75df-48e4-9b45-30aa08f47ca0"}],"id":"ad667c3e-c2e4-47bf-af98-27aebb9b63f3","description":"<p>Every request needs an access token from Microsoft Entra ID for the hospital's FHIR server.</p>\n<p><strong>What heyPatient gives you, per hospital and environment:</strong></p>\n<ul>\n<li>a technical user (<code>&lt;name&gt;-fhir-test@heypatient.com</code> or <code>&lt;name&gt;-fhir-prod@heypatient.com</code>) with read and write access to that hospital's FHIR server only</li>\n<li>its password</li>\n<li>the client id (<code></code>)</li>\n</ul>\n<p><strong>Token request:</strong> OAuth 2.0 resource owner password grant against heyPatient's tenant (<code>f049c21e-43d2-4bf5-9209-dbaa9e9e278e</code>).</p>\n<ul>\n<li><code>scope</code> is the FHIR server address followed by <code>/user_impersonation</code>. Add <code>offline_access</code> to also receive a refresh token.</li>\n<li>Send the token as <code>Authorization: Bearer &lt;access_token&gt;</code> with every FHIR request. The requests in this collection do this with the variable <code></code>.</li>\n<li>A token is valid for about an hour (<code>expires_in</code>, in seconds). Request a new one, or use the refresh token, when the FHIR server answers <code>401</code>.</li>\n<li>Keep the password in a secret store, not in shared collections.</li>\n</ul>\n","_postman_id":"ad667c3e-c2e4-47bf-af98-27aebb9b63f3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}}},{"name":"Connection requests (Patient)","item":[{"name":"Find new connection requests","id":"94ed4c91-74fd-48e5-9a99-d7061301f12c","request":{"method":"GET","header":[],"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient?identifier=http://fhir.heypatient.com/valuesets/DEMO-PID|unassigned&active=true","description":"<p>Lists patients who asked to connect and wait for confirmation: PID <code>unassigned</code>, still active.</p>\n<p>Match each one to your patient records, for example by AHV number, name and birth date, and note the resource <code>id</code>.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Patient"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[{"key":"identifier","value":"http://fhir.heypatient.com/valuesets/DEMO-PID|unassigned"},{"key":"active","value":"true"}],"variable":[]}},"response":[{"id":"46b823f9-4d50-46d7-a5e0-970dc3bfb830","name":"One connection request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient?identifier=http://fhir.heypatient.com/valuesets/DEMO-PID|unassigned&active=true","host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"path":["Patient"],"query":[{"key":"identifier","value":"http://fhir.heypatient.com/valuesets/DEMO-PID|unassigned"},{"key":"active","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/fhir+json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"resourceType\": \"Bundle\",\n  \"type\": \"searchset\",\n  \"link\": [\n    {\n      \"relation\": \"self\",\n      \"url\": \"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient?identifier=http://fhir.heypatient.com/valuesets/DEMO-PID|unassigned&active=true\"\n    }\n  ],\n  \"entry\": [\n    {\n      \"fullUrl\": \"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\",\n      \"resource\": {\n        \"resourceType\": \"Patient\",\n        \"id\": \"4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\",\n        \"meta\": {\n          \"versionId\": \"3\",\n          \"lastUpdated\": \"2026-11-18T09:14:03.112+00:00\"\n        },\n        \"extension\": [\n          {\n            \"extension\": [\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/heyUsertype\",\n                \"valueString\": \"heyAppUser\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/Profession\",\n                \"valueString\": \"Interaction Designer\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/Anstellungsverhältnis\",\n                \"valueString\": \"EMPLOYED\"\n              }\n            ]\n          },\n          {\n            \"extension\": [\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/VEKAnummerBasicInsurance\",\n                \"valueString\": \"80756015420226137217\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/NameBasicInsurance\",\n                \"valueString\": \"Assura\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/PlaceBasicInsurance\",\n                \"valueString\": \"Zürich\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/VersichertennummerBasicInsurance\",\n                \"valueString\": \"01542\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/ExpirationBasicInsurance\",\n                \"valueDate\": \"2027-12-31\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/CoverageBasicInsurance\",\n                \"valueString\": \"GENERAL\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/ModelBasicInsurance\",\n                \"valueString\": \"family_doctor\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/BAGBasicInsurance\",\n                \"valueInteger\": 1542\n              }\n            ]\n          }\n        ],\n        \"identifier\": [\n          {\n            \"use\": \"official\",\n            \"system\": \"urn:oid:2.16.756.5.30.1.127.3.10.3\",\n            \"value\": \"756.9217.0769.85\"\n          },\n          {\n            \"use\": \"temp\",\n            \"system\": \"http://fhir.heypatient.com/valuesets/DEMO-PID\",\n            \"value\": \"unassigned\"\n          },\n          {\n            \"use\": \"official\",\n            \"system\": \"http://fhir.heypatient.com/valuesets/heyID\",\n            \"value\": \"165dcf46-a994-4f9b-b9f5-10443817213f\"\n          },\n          {\n            \"use\": \"official\",\n            \"system\": \"urn:oid:2.16.756.5.32\",\n            \"value\": \"756.9217.0769.85\"\n          }\n        ],\n        \"active\": true,\n        \"name\": [\n          {\n            \"use\": \"official\",\n            \"family\": \"Demopatient\",\n            \"given\": [\n              \"Heidi\"\n            ]\n          }\n        ],\n        \"telecom\": [\n          {\n            \"system\": \"phone\",\n            \"value\": \"+41761234567\",\n            \"use\": \"mobile\"\n          },\n          {\n            \"system\": \"email\",\n            \"value\": \"heidi.demopatient@example.com\"\n          }\n        ],\n        \"gender\": \"female\",\n        \"birthDate\": \"1990-07-21\",\n        \"address\": [\n          {\n            \"use\": \"home\",\n            \"line\": [\n              \"Musterstrasse 43\"\n            ],\n            \"city\": \"Zürich\",\n            \"postalCode\": \"8032\",\n            \"country\": \"CH\"\n          }\n        ],\n        \"communication\": [\n          {\n            \"language\": {\n              \"coding\": [\n                {\n                  \"system\": \"urn:ietf:bcp:47\",\n                  \"code\": \"de-ch\"\n                }\n              ]\n            },\n            \"preferred\": true\n          }\n        ],\n        \"managingOrganization\": {\n          \"reference\": \"Organization/DEMO\"\n        }\n      },\n      \"search\": {\n        \"mode\": \"match\"\n      }\n    }\n  ]\n}"}],"_postman_id":"94ed4c91-74fd-48e5-9a99-d7061301f12c"},{"name":"Confirm a connection (PUT)","id":"2c55139d-c7bc-437a-a567-9d4090a80f4f","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/fhir+json"}],"body":{"mode":"raw","raw":"{\n  \"resourceType\": \"Patient\",\n  \"id\": \"4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\",\n  \"extension\": [\n    {\n      \"extension\": [\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/heyUsertype\",\n          \"valueString\": \"heyAppUser\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/Profession\",\n          \"valueString\": \"Interaction Designer\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/Anstellungsverhältnis\",\n          \"valueString\": \"EMPLOYED\"\n        }\n      ]\n    },\n    {\n      \"extension\": [\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/VEKAnummerBasicInsurance\",\n          \"valueString\": \"80756015420226137217\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/NameBasicInsurance\",\n          \"valueString\": \"Assura\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/PlaceBasicInsurance\",\n          \"valueString\": \"Zürich\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/VersichertennummerBasicInsurance\",\n          \"valueString\": \"01542\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/ExpirationBasicInsurance\",\n          \"valueDate\": \"2027-12-31\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/CoverageBasicInsurance\",\n          \"valueString\": \"GENERAL\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/ModelBasicInsurance\",\n          \"valueString\": \"family_doctor\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/BAGBasicInsurance\",\n          \"valueInteger\": 1542\n        }\n      ]\n    }\n  ],\n  \"identifier\": [\n    {\n      \"use\": \"official\",\n      \"system\": \"urn:oid:2.16.756.5.30.1.127.3.10.3\",\n      \"value\": \"756.9217.0769.85\"\n    },\n    {\n      \"use\": \"official\",\n      \"system\": \"http://fhir.heypatient.com/valuesets/DEMO-PID\",\n      \"value\": \"21001\"\n    },\n    {\n      \"use\": \"official\",\n      \"system\": \"http://fhir.heypatient.com/valuesets/heyID\",\n      \"value\": \"165dcf46-a994-4f9b-b9f5-10443817213f\"\n    },\n    {\n      \"use\": \"official\",\n      \"system\": \"urn:oid:2.16.756.5.32\",\n      \"value\": \"756.9217.0769.85\"\n    }\n  ],\n  \"active\": true,\n  \"name\": [\n    {\n      \"use\": \"official\",\n      \"family\": \"Demopatient\",\n      \"given\": [\n        \"Heidi\"\n      ]\n    }\n  ],\n  \"telecom\": [\n    {\n      \"system\": \"phone\",\n      \"value\": \"+41761234567\",\n      \"use\": \"mobile\"\n    },\n    {\n      \"system\": \"email\",\n      \"value\": \"heidi.demopatient@example.com\"\n    }\n  ],\n  \"gender\": \"female\",\n  \"birthDate\": \"1990-07-21\",\n  \"address\": [\n    {\n      \"use\": \"home\",\n      \"line\": [\n        \"Musterstrasse 43\"\n      ],\n      \"city\": \"Zürich\",\n      \"postalCode\": \"8032\",\n      \"country\": \"CH\"\n    }\n  ],\n  \"communication\": [\n    {\n      \"language\": {\n        \"coding\": [\n          {\n            \"system\": \"urn:ietf:bcp:47\",\n            \"code\": \"de-ch\"\n          }\n        ]\n      },\n      \"preferred\": true\n    }\n  ],\n  \"managingOrganization\": {\n    \"reference\": \"Organization/DEMO\"\n  }\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8","description":"<p>Confirms a connection request: the PID identifier gets your PID with <code>use: official</code>.</p>\n<ul>\n<li>Send the complete resource you read, with only the PID identifier changed. <code>PUT</code> replaces the whole resource, so elements you leave out are removed from the FHIR server.</li>\n<li>Write the PID value and <code>use: official</code> in the same request.</li>\n<li>Optional: add your case number as <code>http://fhir.heypatient.com/valuesets/DEMO-FID</code> with <code>use: official</code>. A new FID on the <code>Patient</code> tells the patient \" hat Ihre Anmeldung zum Eintritt bestätigt\" (see <strong>Admissions</strong>).</li>\n</ul>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Patient","4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c55139d-c7bc-437a-a567-9d4090a80f4f"},{"name":"Confirm a connection (JSON Patch)","id":"531ad618-d368-4364-9d08-06111643f0b6","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"op\": \"test\",\n    \"path\": \"/identifier/1/system\",\n    \"value\": \"http://fhir.heypatient.com/valuesets/DEMO-PID\"\n  },\n  {\n    \"op\": \"replace\",\n    \"path\": \"/identifier/1\",\n    \"value\": {\n      \"use\": \"official\",\n      \"system\": \"http://fhir.heypatient.com/valuesets/DEMO-PID\",\n      \"value\": \"21001\"\n    }\n  }\n]","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8","description":"<p>Confirms a connection request without sending the whole resource.</p>\n<ul>\n<li>The position of the PID identifier differs between patients. Read the <code>Patient</code> first and use the index of the identifier whose <code>system</code> is <code>http://fhir.heypatient.com/valuesets/DEMO-PID</code>. The example uses index 1.</li>\n<li>The <code>test</code> operation makes the request fail with <code>422</code> instead of changing another identifier when the index is wrong.</li>\n<li>Replace the whole identifier object, so that the value and <code>use: official</code> change together.</li>\n</ul>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Patient","4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"531ad618-d368-4364-9d08-06111643f0b6"}],"id":"03074717-9411-42d7-910e-c1a6a4643567","description":"<p>When an app user asks to connect to the hospital, heyPatient writes a <code>Patient</code> resource to the hospital's FHIR server, or updates the one it wrote before. It contains:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Element</th>\n<th>Value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>identifier</code> <code>http://fhir.heypatient.com/valuesets/DEMO-PID</code></td>\n<td><code>unassigned</code>, <code>use: temp</code> (or the PID the patient entered)</td>\n</tr>\n<tr>\n<td><code>identifier</code> <code>http://fhir.heypatient.com/valuesets/heyID</code></td>\n<td>heyPatient's id for the person; do not change it</td>\n</tr>\n<tr>\n<td><code>identifier</code> <code>urn:oid:2.16.756.5.32</code> and <code>urn:oid:2.16.756.5.30.1.127.3.10.3</code></td>\n<td>AHV number, <code>756.XXXX.XXXX.XX</code>, when the patient entered it</td>\n</tr>\n<tr>\n<td>extension <code>http://fhir.heypatient.com/valuesets/heyUsertype</code></td>\n<td><code>heyAppUser</code></td>\n</tr>\n<tr>\n<td><code>name</code>, <code>birthDate</code>, <code>gender</code>, <code>telecom</code>, <code>address</code>, insurances …</td>\n<td>as the patient entered them (see <strong>Patient data</strong>)</td>\n</tr>\n<tr>\n<td><code>managingOrganization</code></td>\n<td><code>Organization/DEMO</code></td>\n</tr>\n</tbody>\n</table>\n</div><p>heyPatient also writes an <code>Encounter</code> with class <code>PRENC</code> (pre-admission) for each connection. It needs no action.</p>\n<p><strong>Confirming the connection:</strong> write your local patient number (PID) into the PID identifier with <code>use: official</code>, in one write. The patient then</p>\n<ul>\n<li>receives the notification \" hat Ihre Verbindungsanfrage bestätigt\",</li>\n<li>is connected, and sees their appointments, tasks, documents and messages from the hospital.</li>\n</ul>\n<p>If the request is not one of your patients, leave it unconfirmed.</p>\n<p><strong>Patient data of app users:</strong> heyPatient reads only the identifiers (PID, FID) of a <code>Patient</code> whose <code>heyUsertype</code> is <code>heyAppUser</code>. The patient keeps their name, address and other data up to date in the app.</p>\n<p><strong>Disconnecting:</strong> when a patient disconnects from the hospital in the app, heyPatient sets the PID identifier to <code>use: old</code> and <code>active</code> to <code>false</code>.</p>\n","_postman_id":"03074717-9411-42d7-910e-c1a6a4643567","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}}},{"name":"Patient data (Patient)","item":[{"name":"Create or update a patient (all elements)","id":"b345c2db-29c3-4f12-ac6d-9196f1fa9015","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/fhir+json"}],"body":{"mode":"raw","raw":"{\n  \"resourceType\": \"Patient\",\n  \"id\": \"4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\",\n  \"extension\": [\n    {\n      \"extension\": [\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/heyUsertype\",\n          \"valueString\": \"heyGuest\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/Profession\",\n          \"valueString\": \"Interaction Designer\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/Anstellungsverhältnis\",\n          \"valueString\": \"EMPLOYED\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/eprUser\",\n          \"valueBoolean\": true\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/disabled\",\n          \"valueBoolean\": false\n        }\n      ]\n    },\n    {\n      \"url\": \"http://hl7.org/fhir/StructureDefinition/patient-citizenship\",\n      \"extension\": [\n        {\n          \"url\": \"code\",\n          \"valueCodeableConcept\": {\n            \"coding\": [\n              {\n                \"system\": \"urn:iso:std:iso:3166\",\n                \"code\": \"CH\"\n              }\n            ]\n          }\n        }\n      ]\n    },\n    {\n      \"url\": \"http://fhir.heypatient.com/valuesets/ResidencePermits\",\n      \"valueCodeableConcept\": {\n        \"coding\": [\n          {\n            \"system\": \"urn:oid:2.16.756.5.30.1.112.3.1.201812.8\",\n            \"code\": \"C\"\n          }\n        ]\n      }\n    },\n    {\n      \"url\": \"http://fhir.heypatient.com/valuesets/LivingArrangement\",\n      \"valueCodeableConcept\": {\n        \"coding\": [\n          {\n            \"system\": \"http://fhir.heypatient.com/valuesets/LivingArrangement\",\n            \"code\": \"OTHER\",\n            \"display\": \"Wohngemeinschaft\"\n          }\n        ]\n      }\n    },\n    {\n      \"url\": \"http://fhir.heypatient.com/valuesets/Religion\",\n      \"valueString\": \"reformiert\"\n    },\n    {\n      \"url\": \"http://fhir.heypatient.com/valuesets/LivingWill\",\n      \"valueBoolean\": true\n    },\n    {\n      \"extension\": [\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/VEKAnummerBasicInsurance\",\n          \"valueString\": \"80756015420226137217\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/NameBasicInsurance\",\n          \"valueString\": \"Assura\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/PlaceBasicInsurance\",\n          \"valueString\": \"Zürich\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/VersichertennummerBasicInsurance\",\n          \"valueString\": \"01542\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/ExpirationBasicInsurance\",\n          \"valueDate\": \"2027-12-31\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/CoverageBasicInsurance\",\n          \"valueString\": \"GENERAL\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/ModelBasicInsurance\",\n          \"valueString\": \"family_doctor\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/BAGBasicInsurance\",\n          \"valueInteger\": 1542\n        }\n      ]\n    },\n    {\n      \"extension\": [\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/VEKAnummerAddtlInsurance\",\n          \"valueString\": \"80756013840060642196\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/NameAddtlInsurance\",\n          \"valueString\": \"SWICA\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/PlaceAddtlInsurance\",\n          \"valueString\": \"Winterthur\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/VersichertennummerAddtlInsurance\",\n          \"valueString\": \"77-1234\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/ExpirationAddtlInsurance\",\n          \"valueDate\": \"2027-12-31\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/CoverageAddtlInsurance\",\n          \"valueString\": \"HALF_PRIVATE\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/ModelAddtlInsurance\",\n          \"valueString\": \"another\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/BAGAddtlInsurance\",\n          \"valueInteger\": 1384\n        }\n      ]\n    },\n    {\n      \"extension\": [\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/NameAccidentInsurance\",\n          \"valueString\": \"Suva\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/NumberAccidentInsurance\",\n          \"valueString\": \"123.45678\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/NameAddtlAccidentInsurance\",\n          \"valueString\": \"AXA\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/NumberAddtlAccidentInsurance\",\n          \"valueString\": \"9876543\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/CoverageAddtlAccidentInsurance\",\n          \"valueString\": \"PRIVATE\"\n        }\n      ]\n    },\n    {\n      \"extension\": [\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/IV-Number\",\n          \"valueString\": \"IV-2026-0042\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/IV-InsuranceName\",\n          \"valueString\": \"IV-Stelle Kanton Zürich\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/IV-Place\",\n          \"valueString\": \"Zürich\"\n        }\n      ]\n    }\n  ],\n  \"identifier\": [\n    {\n      \"use\": \"official\",\n      \"system\": \"http://fhir.heypatient.com/valuesets/DEMO-PID\",\n      \"value\": \"21001\"\n    },\n    {\n      \"use\": \"official\",\n      \"system\": \"http://fhir.heypatient.com/valuesets/DEMO-FID\",\n      \"value\": \"210000001\"\n    },\n    {\n      \"use\": \"official\",\n      \"system\": \"urn:oid:2.16.756.5.32\",\n      \"value\": \"756.9217.0769.85\"\n    }\n  ],\n  \"active\": true,\n  \"name\": [\n    {\n      \"use\": \"official\",\n      \"family\": \"Demopatient\",\n      \"given\": [\n        \"Heidi\",\n        \"Annabelle\"\n      ]\n    },\n    {\n      \"use\": \"maiden\",\n      \"family\": \"Musterpatient\"\n    }\n  ],\n  \"telecom\": [\n    {\n      \"system\": \"phone\",\n      \"value\": \"+41761234567\",\n      \"use\": \"mobile\"\n    },\n    {\n      \"system\": \"phone\",\n      \"value\": \"+41441234567\",\n      \"use\": \"home\"\n    },\n    {\n      \"system\": \"email\",\n      \"value\": \"heidi.demopatient@example.com\"\n    }\n  ],\n  \"gender\": \"female\",\n  \"birthDate\": \"1990-07-21\",\n  \"address\": [\n    {\n      \"use\": \"home\",\n      \"line\": [\n        \"Musterstrasse 43\"\n      ],\n      \"city\": \"Zürich\",\n      \"postalCode\": \"8032\",\n      \"country\": \"CH\"\n    },\n    {\n      \"use\": \"billing\",\n      \"line\": [\n        \"Postfach 12\"\n      ],\n      \"city\": \"Zürich\",\n      \"postalCode\": \"8021\",\n      \"country\": \"CH\"\n    }\n  ],\n  \"maritalStatus\": {\n    \"coding\": [\n      {\n        \"system\": \"http://terminology.hl7.org/CodeSystem/v3-MaritalStatus\",\n        \"code\": \"M\"\n      },\n      {\n        \"system\": \"https://fhir.ch/ig/ch-core/CodeSystem-ech-11-maritalstatus.html\",\n        \"code\": \"2\"\n      }\n    ]\n  },\n  \"contact\": [\n    {\n      \"relationship\": [\n        {\n          \"coding\": [\n            {\n              \"system\": \"http://www.hl7.org/FHIR/v3/RoleCode/cs.html\",\n              \"code\": \"C\"\n            }\n          ]\n        },\n        {\n          \"coding\": [\n            {\n              \"system\": \"http://www.hl7.org/FHIR/v3/RoleCode/cs.html\",\n              \"code\": \"SPS\"\n            }\n          ]\n        }\n      ],\n      \"extension\": [\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/comment\",\n          \"valueString\": \"Erreichbar ab 17 Uhr\"\n        }\n      ],\n      \"name\": {\n        \"family\": \"Demopatient\",\n        \"given\": [\n          \"Hans\"\n        ]\n      },\n      \"telecom\": [\n        {\n          \"system\": \"phone\",\n          \"value\": \"+41791234567\",\n          \"use\": \"mobile\"\n        },\n        {\n          \"system\": \"email\",\n          \"value\": \"hans.demopatient@example.com\"\n        }\n      ],\n      \"address\": {\n        \"use\": \"home\",\n        \"line\": [\n          \"Musterstrasse 43\"\n        ],\n        \"city\": \"Zürich\",\n        \"postalCode\": \"8032\",\n        \"country\": \"CH\"\n      }\n    },\n    {\n      \"relationship\": [\n        {\n          \"coding\": [\n            {\n              \"system\": \"http://www.hl7.org/FHIR/v3/RoleCode/cs.html\",\n              \"code\": \"C\"\n            }\n          ]\n        },\n        {\n          \"coding\": [\n            {\n              \"system\": \"http://www.hl7.org/FHIR/v3/RoleCode/cs.html\",\n              \"code\": \"PRN\"\n            }\n          ]\n        }\n      ],\n      \"extension\": [\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/ParentalAuthority\",\n          \"valueBoolean\": false\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/birthDate\",\n          \"valueDate\": \"1962-03-02\"\n        }\n      ],\n      \"name\": {\n        \"family\": \"Musterpatient\",\n        \"given\": [\n          \"Erika\"\n        ]\n      },\n      \"telecom\": [\n        {\n          \"system\": \"phone\",\n          \"value\": \"+41799876543\",\n          \"use\": \"home\"\n        }\n      ]\n    },\n    {\n      \"relationship\": [\n        {\n          \"coding\": [\n            {\n              \"system\": \"http://www.hl7.org/FHIR/v3/RoleCode/cs.html\",\n              \"code\": \"E\"\n            }\n          ]\n        }\n      ],\n      \"name\": {\n        \"text\": \"Demo Design AG\"\n      },\n      \"telecom\": [\n        {\n          \"system\": \"phone\",\n          \"value\": \"+41445556677\",\n          \"use\": \"work\"\n        }\n      ],\n      \"address\": {\n        \"use\": \"work\",\n        \"line\": [\n          \"Werkstrasse 1\"\n        ],\n        \"city\": \"Zürich\",\n        \"postalCode\": \"8005\",\n        \"country\": \"CH\"\n      }\n    }\n  ],\n  \"communication\": [\n    {\n      \"language\": {\n        \"coding\": [\n          {\n            \"system\": \"urn:ietf:bcp:47\",\n            \"code\": \"de-ch\"\n          }\n        ]\n      },\n      \"preferred\": true\n    },\n    {\n      \"language\": {\n        \"coding\": [\n          {\n            \"system\": \"urn:ietf:bcp:47\",\n            \"code\": \"en\"\n          }\n        ]\n      }\n    }\n  ],\n  \"generalPractitioner\": [\n    {\n      \"reference\": \"http://fhir.heypatient.com/valuesets/PrimaryCare\",\n      \"display\": \"Praxis am See, Dr. med. Muster, 8032 Zürich\",\n      \"extension\": [\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/PraxisName\",\n          \"valueString\": \"Praxis am See\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/DoctorName\",\n          \"valueString\": \"Dr. med. Muster\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/Phone\",\n          \"valueString\": \"+41441112233\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/Email\",\n          \"valueString\": \"praxis@example.com\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/Address\",\n          \"valueAddress\": {\n            \"line\": [\n              \"Seestrasse 10\"\n            ],\n            \"city\": \"Zürich\",\n            \"postalCode\": \"8032\",\n            \"country\": \"CH\"\n          }\n        }\n      ]\n    },\n    {\n      \"reference\": \"http://fhir.heypatient.com/valuesets/Gynecologist\",\n      \"display\": \"Frauenpraxis Oerlikon\",\n      \"extension\": [\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/PraxisName\",\n          \"valueString\": \"Frauenpraxis Oerlikon\"\n        }\n      ]\n    }\n  ],\n  \"managingOrganization\": {\n    \"reference\": \"Organization/DEMO\"\n  }\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8","description":"<p>Creates or updates a patient with every element heyPatient reads. Use your own id for a new patient, or the id you read for an existing one.</p>\n<p>For a patient who uses the app (<code>heyUsertype</code> <code>heyAppUser</code>), only the identifiers are taken over.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Patient","4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b345c2db-29c3-4f12-ac6d-9196f1fa9015"}],"id":"629bd34c-4367-4a21-9be3-11c79e4ee257","description":"<p>The patient data heyPatient reads from and writes to a <code>Patient</code>, with the exact shape of each element.</p>\n<p><strong>Patients without the app:</strong> a <code>Patient</code> you create, or one without <code>heyUsertype</code> <code>heyAppUser</code>, becomes a patient record without an app account in heyPatient. heyPatient fills it with the data below and matches it to an existing person by</p>\n<ol>\n<li>the resource id,</li>\n<li>the heyID identifier,</li>\n<li>AHV number and birth date,</li>\n<li>e-mail address, birth date and given names.</li>\n</ol>\n<p>For patients with the app (<code>heyAppUser</code>), heyPatient reads only the identifiers; see <strong>Connection requests</strong>.</p>\n<p><strong>Extensions:</strong> some extensions stand alone, others are grouped as children of one extension without <code>url</code>. Keep the grouping shown here; heyPatient reads the children by their <code>url</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Extension (<code>http://fhir.heypatient.com/valuesets/…</code>)</th>\n<th>Placement</th>\n<th>Value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>heyUsertype</code></td>\n<td>group with <code>Profession</code>, <code>Anstellungsverhältnis</code>, <code>eprUser</code>, <code>disabled</code></td>\n<td><code>valueString</code> <code>heyAppUser</code> (set by heyPatient) or <code>heyGuest</code></td>\n</tr>\n<tr>\n<td><code>Profession</code></td>\n<td>same group</td>\n<td><code>valueString</code></td>\n</tr>\n<tr>\n<td><code>Anstellungsverhältnis</code></td>\n<td>same group</td>\n<td><code>valueString</code>: <code>EMPLOYED</code>, <code>EMPLOYED_LT8H</code>, <code>SELFEMPLOYED</code>, <code>UNEMPLOYED</code>, <code>JOBSEEKING</code>, <code>RETIRED</code>, <code>STUDENT</code>, <code>UNKNOWN</code></td>\n</tr>\n<tr>\n<td><code>eprUser</code>, <code>disabled</code></td>\n<td>same group</td>\n<td><code>valueBoolean</code> (JSON <code>true</code> or <code>false</code>)</td>\n</tr>\n<tr>\n<td><code>VEKAnummerBasicInsurance</code>, <code>NameBasicInsurance</code>, <code>PlaceBasicInsurance</code>, <code>VersichertennummerBasicInsurance</code></td>\n<td>one group per insurance</td>\n<td><code>valueString</code></td>\n</tr>\n<tr>\n<td><code>ExpirationBasicInsurance</code></td>\n<td>same group</td>\n<td><code>valueDate</code></td>\n</tr>\n<tr>\n<td><code>CoverageBasicInsurance</code></td>\n<td>same group</td>\n<td><code>valueString</code>: <code>GENERAL</code>, <code>GENERAL_SWITZERLAND</code>, <code>HALF_PRIVATE</code>, <code>PRIVATE</code>, <code>FLEX</code></td>\n</tr>\n<tr>\n<td><code>ModelBasicInsurance</code></td>\n<td>same group</td>\n<td><code>valueString</code>: <code>family_doctor</code> or <code>another</code></td>\n</tr>\n<tr>\n<td><code>BAGBasicInsurance</code></td>\n<td>same group</td>\n<td><code>valueInteger</code>, the insurer's BAG number</td>\n</tr>\n<tr>\n<td><code>…AddtlInsurance</code> (same eight names)</td>\n<td>one group for the supplementary insurance</td>\n<td>as above</td>\n</tr>\n<tr>\n<td><code>NameAccidentInsurance</code>, <code>NumberAccidentInsurance</code>, <code>NameAddtlAccidentInsurance</code>, <code>NumberAddtlAccidentInsurance</code>, <code>CoverageAddtlAccidentInsurance</code></td>\n<td>one group</td>\n<td><code>valueString</code></td>\n</tr>\n<tr>\n<td><code>BAGAccidentInsurance</code>, <code>BAGAddtlAccidentInsurance</code></td>\n<td>same group</td>\n<td><code>valueInteger</code></td>\n</tr>\n<tr>\n<td><code>IV-Number</code>, <code>IV-InsuranceName</code>, <code>IV-Place</code></td>\n<td>one group (disability insurance)</td>\n<td><code>valueString</code></td>\n</tr>\n<tr>\n<td><code>ResidencePermits</code></td>\n<td>alone</td>\n<td><code>valueCodeableConcept</code>, system <code>urn:oid:2.16.756.5.30.1.112.3.1.201812.8</code>, code <code>B</code>, <code>C</code>, <code>Ci</code>, <code>F</code>, <code>G</code>, <code>L</code> or <code>S</code></td>\n</tr>\n<tr>\n<td><code>LivingArrangement</code></td>\n<td>alone</td>\n<td><code>valueCodeableConcept</code>, system <code>http://fhir.heypatient.com/valuesets/LivingArrangement</code>, code <code>PARENTS</code>, <code>MOTHER</code>, <code>FATHER</code> or <code>OTHER</code>, <code>display</code> as free text</td>\n</tr>\n<tr>\n<td><code>Religion</code></td>\n<td>alone</td>\n<td><code>valueString</code></td>\n</tr>\n<tr>\n<td><code>LivingWill</code></td>\n<td>alone</td>\n<td><code>valueBoolean</code></td>\n</tr>\n<tr>\n<td><code>http://hl7.org/fhir/StructureDefinition/patient-citizenship</code></td>\n<td>alone, child <code>code</code></td>\n<td><code>valueCodeableConcept</code>, system <code>urn:iso:std:iso:3166</code>, two-letter country code</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Other elements:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Element</th>\n<th>Shape</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>name</code></td>\n<td><code>use: official</code> with <code>family</code> and <code>given</code> (several given names allowed); <code>use: maiden</code> with <code>family</code> for the birth name</td>\n</tr>\n<tr>\n<td><code>telecom</code></td>\n<td>phones with <code>use</code> <code>mobile</code>, <code>home</code> or <code>work</code>; one e-mail</td>\n</tr>\n<tr>\n<td><code>address</code></td>\n<td>one per <code>use</code> (<code>home</code>, <code>work</code>, <code>billing</code>, <code>temp</code>); <code>home</code> is the main address</td>\n</tr>\n<tr>\n<td><code>maritalStatus</code></td>\n<td>system <code>http://terminology.hl7.org/CodeSystem/v3-MaritalStatus</code> (<code>M</code>, <code>W</code>, <code>D</code>, <code>L</code>, <code>U</code>, <code>UNK</code>) and/or <code>https://fhir.ch/ig/ch-core/CodeSystem-ech-11-maritalstatus.html</code> (<code>2</code>–<code>7</code>, <code>9</code>)</td>\n</tr>\n<tr>\n<td><code>communication</code></td>\n<td>system <code>urn:ietf:bcp:47</code>; <code>preferred: true</code> for the preferred language</td>\n</tr>\n<tr>\n<td><code>contact</code> (emergency contact)</td>\n<td>relationship codings with system <code>http://www.hl7.org/FHIR/v3/RoleCode/cs.html</code>: first <code>C</code>, then the relationship: <code>SPS</code> spouse, <code>DOMPART</code> partner, <code>PRN</code> parent, <code>CHILD</code>, <code>FAMMEMB</code> family member, <code>SIGOTHR</code> significant other, <code>O</code> other. <code>name</code> with <code>family</code> and <code>given</code>; extensions <code>ParentalAuthority</code> (<code>valueBoolean</code>), <code>birthDate</code> (<code>valueDate</code>), <code>comment</code> (<code>valueString</code>)</td>\n</tr>\n<tr>\n<td><code>contact</code> (employer)</td>\n<td>relationship code <code>E</code>; company in <code>name.text</code></td>\n</tr>\n<tr>\n<td><code>generalPractitioner</code></td>\n<td><code>reference</code> <code>http://fhir.heypatient.com/valuesets/PrimaryCare</code> (family doctor) or <code>…/Gynecologist</code>; extensions <code>PraxisName</code>, <code>DoctorName</code>, <code>Phone</code>, <code>Email</code> (<code>valueString</code>) and <code>Address</code> (<code>valueAddress</code>)</td>\n</tr>\n<tr>\n<td><code>identifier</code></td>\n<td>PID and FID with <code>use: official</code>; AHV number under <code>urn:oid:2.16.756.5.32</code></td>\n</tr>\n</tbody>\n</table>\n</div>","_postman_id":"629bd34c-4367-4a21-9be3-11c79e4ee257","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}}},{"name":"Admissions (Encounter)","item":[{"name":"Find new admission requests","id":"dba8d814-8193-4b8e-b338-ab594c5acdb4","request":{"method":"GET","header":[],"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Encounter?identifier=http://fhir.heypatient.com/ig/identifier/DEMO/localFID|unassigned&class=AMB&_include=Encounter:subject","description":"<p>Lists admission requests without a case number, with their patients (<code>_include=Encounter:subject</code>).</p>\n<p>When the patient entered a case number, <code>localFID</code> holds it with <code>use: temp</code>. To find those as well, search <code>Encounter?class=AMB&amp;_lastUpdated=ge&lt;last search&gt;</code> and pick the ones whose <code>localFID</code> has <code>use: temp</code>.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Encounter"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[{"key":"identifier","value":"http://fhir.heypatient.com/ig/identifier/DEMO/localFID|unassigned"},{"key":"class","value":"AMB"},{"key":"_include","value":"Encounter:subject"}],"variable":[]}},"response":[{"id":"b38eec98-9911-40d7-8030-8240c4252e35","name":"One admission request with its patient","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Encounter?identifier=http://fhir.heypatient.com/ig/identifier/DEMO/localFID|unassigned&class=AMB&_include=Encounter:subject","host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"path":["Encounter"],"query":[{"key":"identifier","value":"http://fhir.heypatient.com/ig/identifier/DEMO/localFID|unassigned"},{"key":"class","value":"AMB"},{"key":"_include","value":"Encounter:subject"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/fhir+json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"resourceType\": \"Bundle\",\n  \"type\": \"searchset\",\n  \"link\": [\n    {\n      \"relation\": \"self\",\n      \"url\": \"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Encounter?identifier=http://fhir.heypatient.com/ig/identifier/DEMO/localFID|unassigned&class=AMB&_include=Encounter:subject\"\n    }\n  ],\n  \"entry\": [\n    {\n      \"fullUrl\": \"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Encounter/2cefc305-b335-4722-bf50-5203d9271e23\",\n      \"resource\": {\n        \"resourceType\": \"Encounter\",\n        \"id\": \"2cefc305-b335-4722-bf50-5203d9271e23\",\n        \"meta\": {\n          \"versionId\": \"1\",\n          \"lastUpdated\": \"2026-11-18T09:14:05.051+00:00\"\n        },\n        \"extension\": [\n          {\n            \"url\": \"http://fhir.heypatient.com/valuesets/Source\",\n            \"valueString\": \"WEB\"\n          },\n          {\n            \"extension\": [\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/AdmissionDate\",\n                \"valueString\": \"2026-12-03\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/ReasonForAdmission\",\n                \"valueString\": \"DISEASE\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/AdmissionType\",\n                \"valueString\": \"DOCTOR\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/AdmissionService\",\n                \"valueString\": \"Orthopädie\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/Accident\",\n                \"valueBoolean\": false\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/Birth\",\n                \"valueBoolean\": false\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/PastorVisit\",\n                \"valueBoolean\": false\n              }\n            ]\n          },\n          {\n            \"url\": \"http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-desiredaccommodation\",\n            \"valueCoding\": {\n              \"system\": \"http://fhir.ch/ig/ch-core/CodeSystem/bfs-medstats-21-encountertype\",\n              \"code\": \"1\",\n              \"display\": \"allgemein\"\n            }\n          }\n        ],\n        \"identifier\": [\n          {\n            \"use\": \"official\",\n            \"system\": \"http://fhir.heypatient.com/ig/identifier/DEMO/EncounterId\",\n            \"value\": \"d561e352-cb78-4291-b689-5f7aaccab9cb\"\n          },\n          {\n            \"use\": \"temp\",\n            \"system\": \"http://fhir.heypatient.com/ig/identifier/DEMO/localFID\",\n            \"value\": \"unassigned\"\n          }\n        ],\n        \"status\": \"planned\",\n        \"class\": {\n          \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\n          \"code\": \"AMB\",\n          \"display\": \"ambulatory\"\n        },\n        \"subject\": {\n          \"reference\": \"Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\",\n          \"display\": \"Heidi Demopatient\"\n        },\n        \"serviceProvider\": {\n          \"reference\": \"Organization/DEMO\"\n        }\n      },\n      \"search\": {\n        \"mode\": \"match\"\n      }\n    },\n    {\n      \"fullUrl\": \"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\",\n      \"resource\": {\n        \"resourceType\": \"Patient\",\n        \"id\": \"4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\",\n        \"meta\": {\n          \"versionId\": \"3\",\n          \"lastUpdated\": \"2026-11-18T09:14:03.112+00:00\"\n        },\n        \"extension\": [\n          {\n            \"extension\": [\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/heyUsertype\",\n                \"valueString\": \"heyAppUser\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/Profession\",\n                \"valueString\": \"Interaction Designer\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/Anstellungsverhältnis\",\n                \"valueString\": \"EMPLOYED\"\n              }\n            ]\n          }\n        ],\n        \"identifier\": [\n          {\n            \"use\": \"official\",\n            \"system\": \"urn:oid:2.16.756.5.30.1.127.3.10.3\",\n            \"value\": \"756.9217.0769.85\"\n          },\n          {\n            \"use\": \"temp\",\n            \"system\": \"http://fhir.heypatient.com/valuesets/DEMO-PID\",\n            \"value\": \"unassigned\"\n          },\n          {\n            \"use\": \"official\",\n            \"system\": \"http://fhir.heypatient.com/valuesets/heyID\",\n            \"value\": \"165dcf46-a994-4f9b-b9f5-10443817213f\"\n          },\n          {\n            \"use\": \"official\",\n            \"system\": \"urn:oid:2.16.756.5.32\",\n            \"value\": \"756.9217.0769.85\"\n          }\n        ],\n        \"active\": true,\n        \"name\": [\n          {\n            \"use\": \"official\",\n            \"family\": \"Demopatient\",\n            \"given\": [\n              \"Heidi\"\n            ]\n          }\n        ],\n        \"telecom\": [\n          {\n            \"system\": \"phone\",\n            \"value\": \"+41761234567\",\n            \"use\": \"mobile\"\n          },\n          {\n            \"system\": \"email\",\n            \"value\": \"heidi.demopatient@example.com\"\n          }\n        ],\n        \"gender\": \"female\",\n        \"birthDate\": \"1990-07-21\",\n        \"address\": [\n          {\n            \"use\": \"home\",\n            \"line\": [\n              \"Musterstrasse 43\"\n            ],\n            \"city\": \"Zürich\",\n            \"postalCode\": \"8032\",\n            \"country\": \"CH\"\n          }\n        ],\n        \"communication\": [\n          {\n            \"language\": {\n              \"coding\": [\n                {\n                  \"system\": \"urn:ietf:bcp:47\",\n                  \"code\": \"de-ch\"\n                }\n              ]\n            },\n            \"preferred\": true\n          }\n        ],\n        \"managingOrganization\": {\n          \"reference\": \"Organization/DEMO\"\n        }\n      },\n      \"search\": {\n        \"mode\": \"include\"\n      }\n    }\n  ]\n}"}],"_postman_id":"dba8d814-8193-4b8e-b338-ab594c5acdb4"},{"name":"Confirm an admission (case number)","id":"48d3276b-8734-405a-a19c-8f893588723e","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/fhir+json"}],"body":{"mode":"raw","raw":"{\n  \"resourceType\": \"Encounter\",\n  \"id\": \"2cefc305-b335-4722-bf50-5203d9271e23\",\n  \"extension\": [\n    {\n      \"url\": \"http://fhir.heypatient.com/valuesets/Source\",\n      \"valueString\": \"WEB\"\n    },\n    {\n      \"extension\": [\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/AdmissionDate\",\n          \"valueString\": \"2026-12-03\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/ReasonForAdmission\",\n          \"valueString\": \"DISEASE\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/AdmissionType\",\n          \"valueString\": \"DOCTOR\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/AdmissionService\",\n          \"valueString\": \"Orthopädie\"\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/Accident\",\n          \"valueBoolean\": false\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/Birth\",\n          \"valueBoolean\": false\n        },\n        {\n          \"url\": \"http://fhir.heypatient.com/valuesets/PastorVisit\",\n          \"valueBoolean\": false\n        }\n      ]\n    },\n    {\n      \"url\": \"http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-desiredaccommodation\",\n      \"valueCoding\": {\n        \"system\": \"http://fhir.ch/ig/ch-core/CodeSystem/bfs-medstats-21-encountertype\",\n        \"code\": \"1\",\n        \"display\": \"allgemein\"\n      }\n    }\n  ],\n  \"identifier\": [\n    {\n      \"use\": \"official\",\n      \"system\": \"http://fhir.heypatient.com/ig/identifier/DEMO/EncounterId\",\n      \"value\": \"d561e352-cb78-4291-b689-5f7aaccab9cb\"\n    },\n    {\n      \"use\": \"official\",\n      \"system\": \"http://fhir.heypatient.com/ig/identifier/DEMO/localFID\",\n      \"value\": \"210000001\"\n    }\n  ],\n  \"status\": \"planned\",\n  \"class\": {\n    \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\n    \"code\": \"AMB\",\n    \"display\": \"ambulatory\"\n  },\n  \"subject\": {\n    \"reference\": \"Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\",\n    \"display\": \"Heidi Demopatient\"\n  },\n  \"serviceProvider\": {\n    \"reference\": \"Organization/DEMO\"\n  }\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Encounter/2cefc305-b335-4722-bf50-5203d9271e23","description":"<p>Writes your case number into the admission request.</p>\n<p>Send the complete <code>Encounter</code> you read with only the <code>localFID</code> identifier changed: your FID with <code>use: official</code>. Keep <code>subject</code> and the <code>EncounterId</code> identifier.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Encounter","2cefc305-b335-4722-bf50-5203d9271e23"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"48d3276b-8734-405a-a19c-8f893588723e"}],"id":"c813561c-a7ce-4ea9-b719-572c86365fa5","description":"<p>When a patient submits an admission in the app or on the web, heyPatient writes</p>\n<ul>\n<li>the <code>Patient</code>, with the admission data,</li>\n<li>an <code>Encounter</code> for the admission request,</li>\n<li>the documents the patient uploaded, as <code>DocumentReference</code> (see <strong>Documents</strong>).</li>\n</ul>\n<p><strong>The admission <code>Encounter</code>:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Element</th>\n<th>Value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>identifier</code> <code>http://fhir.heypatient.com/ig/identifier/DEMO/EncounterId</code></td>\n<td>heyPatient's id for the admission request; do not change it</td>\n</tr>\n<tr>\n<td><code>identifier</code> <code>http://fhir.heypatient.com/ig/identifier/DEMO/localFID</code></td>\n<td><code>unassigned</code>, <code>use: temp</code>, or the case number the patient entered, <code>use: temp</code></td>\n</tr>\n<tr>\n<td><code>status</code></td>\n<td><code>planned</code>; heyPatient sets <code>arrived</code> when the patient checks in</td>\n</tr>\n<tr>\n<td><code>class</code></td>\n<td><code>AMB</code> (system <code>http://terminology.hl7.org/CodeSystem/v3-ActCode</code>). Encounters with class <code>PRENC</code> belong to connection requests, not admissions.</td>\n</tr>\n<tr>\n<td><code>subject</code></td>\n<td><code>Patient/&lt;id&gt;</code></td>\n</tr>\n<tr>\n<td><code>serviceProvider</code></td>\n<td><code>Organization/DEMO</code></td>\n</tr>\n<tr>\n<td>extension <code>http://fhir.heypatient.com/valuesets/Source</code></td>\n<td><code>valueString</code> <code>MOBILE</code> or <code>WEB</code></td>\n</tr>\n<tr>\n<td>extension group: <code>AdmissionDate</code> (<code>valueString</code>, <code>YYYY-MM-DD</code>), <code>ReasonForAdmission</code>, <code>AdmissionType</code>, <code>AdmissionService</code>, <code>UVG-Number</code> (<code>valueString</code>), <code>Accident</code>, <code>Birth</code>, <code>PastorVisit</code> (<code>valueBoolean</code>), <code>DateOfAccident</code> (<code>valueDate</code>)</td>\n<td>under <code>http://fhir.heypatient.com/valuesets/</code></td>\n</tr>\n<tr>\n<td>extension <code>http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-desiredaccommodation</code></td>\n<td>desired ward class, when the hospital offers a choice</td>\n</tr>\n</tbody>\n</table>\n</div><p>Values: <code>ReasonForAdmission</code> is <code>DISEASE</code>, <code>ACCIDENT</code>, <code>MATERNITY</code>, <code>BIRTH_DEFECT</code>, <code>OCCUPATIONAL_DISEASE</code>, <code>MILITARY_SERVICE</code>, <code>NON_PAYABLE</code> or <code>OTHER</code>; <code>AdmissionType</code> is <code>SELF</code>, <code>DOCTOR</code> or <code>OTHER</code>.</p>\n<p><strong>Confirming the admission:</strong> write your case number (FID) into the <code>localFID</code> identifier with <code>use: official</code>. To also tell the patient \" hat Ihre Anmeldung zum Eintritt bestätigt\", add the FID to the <code>Patient</code> as <code>http://fhir.heypatient.com/valuesets/DEMO-FID</code> with <code>use: official</code> (see <strong>Connection requests</strong>).</p>\n<p>A confirmed case number lets the patient check in for the admission (see <strong>Check-ins</strong>).</p>\n","_postman_id":"c813561c-a7ce-4ea9-b719-572c86365fa5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}}},{"name":"Appointments","item":[{"name":"Find a patient by PID","id":"9e64239f-6085-45a6-828f-265e00a3e2ae","request":{"method":"GET","header":[],"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient?identifier=http://fhir.heypatient.com/valuesets/DEMO-PID|21001&active=true","description":"<p>Finds the <code>Patient</code> resource id for your PID, for the <code>Patient/&lt;id&gt;</code> reference in appointments, tasks, documents and messages.</p>\n<p>Store the id; then this search is needed only for new patients.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Patient"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[{"key":"identifier","value":"http://fhir.heypatient.com/valuesets/DEMO-PID|21001"},{"key":"active","value":"true"}],"variable":[]}},"response":[{"id":"868681c7-a160-4812-8f43-a0e9a8b4f7c7","name":"Patient found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient?identifier=http://fhir.heypatient.com/valuesets/DEMO-PID|21001&active=true","host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"path":["Patient"],"query":[{"key":"identifier","value":"http://fhir.heypatient.com/valuesets/DEMO-PID|21001"},{"key":"active","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/fhir+json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"resourceType\": \"Bundle\",\n  \"type\": \"searchset\",\n  \"link\": [\n    {\n      \"relation\": \"self\",\n      \"url\": \"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient?identifier=http://fhir.heypatient.com/valuesets/DEMO-PID|21001&active=true\"\n    }\n  ],\n  \"entry\": [\n    {\n      \"fullUrl\": \"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\",\n      \"resource\": {\n        \"resourceType\": \"Patient\",\n        \"id\": \"4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\",\n        \"meta\": {\n          \"versionId\": \"4\",\n          \"lastUpdated\": \"2026-11-18T09:14:03.112+00:00\"\n        },\n        \"extension\": [\n          {\n            \"extension\": [\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/heyUsertype\",\n                \"valueString\": \"heyAppUser\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/Profession\",\n                \"valueString\": \"Interaction Designer\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/Anstellungsverhältnis\",\n                \"valueString\": \"EMPLOYED\"\n              }\n            ]\n          },\n          {\n            \"extension\": [\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/VEKAnummerBasicInsurance\",\n                \"valueString\": \"80756015420226137217\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/NameBasicInsurance\",\n                \"valueString\": \"Assura\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/PlaceBasicInsurance\",\n                \"valueString\": \"Zürich\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/VersichertennummerBasicInsurance\",\n                \"valueString\": \"01542\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/ExpirationBasicInsurance\",\n                \"valueDate\": \"2027-12-31\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/CoverageBasicInsurance\",\n                \"valueString\": \"GENERAL\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/ModelBasicInsurance\",\n                \"valueString\": \"family_doctor\"\n              },\n              {\n                \"url\": \"http://fhir.heypatient.com/valuesets/BAGBasicInsurance\",\n                \"valueInteger\": 1542\n              }\n            ]\n          }\n        ],\n        \"identifier\": [\n          {\n            \"use\": \"official\",\n            \"system\": \"urn:oid:2.16.756.5.30.1.127.3.10.3\",\n            \"value\": \"756.9217.0769.85\"\n          },\n          {\n            \"use\": \"official\",\n            \"system\": \"http://fhir.heypatient.com/valuesets/DEMO-PID\",\n            \"value\": \"21001\"\n          },\n          {\n            \"use\": \"official\",\n            \"system\": \"http://fhir.heypatient.com/valuesets/heyID\",\n            \"value\": \"165dcf46-a994-4f9b-b9f5-10443817213f\"\n          },\n          {\n            \"use\": \"official\",\n            \"system\": \"urn:oid:2.16.756.5.32\",\n            \"value\": \"756.9217.0769.85\"\n          }\n        ],\n        \"active\": true,\n        \"name\": [\n          {\n            \"use\": \"official\",\n            \"family\": \"Demopatient\",\n            \"given\": [\n              \"Heidi\"\n            ]\n          }\n        ],\n        \"telecom\": [\n          {\n            \"system\": \"phone\",\n            \"value\": \"+41761234567\",\n            \"use\": \"mobile\"\n          },\n          {\n            \"system\": \"email\",\n            \"value\": \"heidi.demopatient@example.com\"\n          }\n        ],\n        \"gender\": \"female\",\n        \"birthDate\": \"1990-07-21\",\n        \"address\": [\n          {\n            \"use\": \"home\",\n            \"line\": [\n              \"Musterstrasse 43\"\n            ],\n            \"city\": \"Zürich\",\n            \"postalCode\": \"8032\",\n            \"country\": \"CH\"\n          }\n        ],\n        \"communication\": [\n          {\n            \"language\": {\n              \"coding\": [\n                {\n                  \"system\": \"urn:ietf:bcp:47\",\n                  \"code\": \"de-ch\"\n                }\n              ]\n            },\n            \"preferred\": true\n          }\n        ],\n        \"managingOrganization\": {\n          \"reference\": \"Organization/DEMO\"\n        }\n      },\n      \"search\": {\n        \"mode\": \"match\"\n      }\n    }\n  ]\n}"}],"_postman_id":"9e64239f-6085-45a6-828f-265e00a3e2ae"},{"name":"Send an appointment (required elements)","id":"8a5ca4c9-8a87-4ab3-aa13-65667856cea3","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/fhir+json"}],"body":{"mode":"raw","raw":"{\n  \"resourceType\": \"Appointment\",\n  \"id\": \"A-2026-004711\",\n  \"status\": \"pending\",\n  \"serviceType\": [\n    {\n      \"coding\": [\n        {\n          \"system\": \"urn:oid:2.16.756.5.30.1.279.4.1.10\",\n          \"code\": \"OP\",\n          \"display\": \"Operation\"\n        }\n      ]\n    }\n  ],\n  \"description\": \"Operation Knie\",\n  \"start\": \"2026-12-03T07:30:00+01:00\",\n  \"end\": \"2026-12-03T10:00:00+01:00\",\n  \"participant\": [\n    {\n      \"actor\": {\n        \"reference\": \"Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\",\n        \"display\": \"Heidi Demopatient\"\n      },\n      \"status\": \"needs-action\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Appointment/A-2026-004711","description":"<p>Sends a new appointment with the required elements. <code>pending</code> gives the patient the notification \"Neuer Termin\".</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Appointment","A-2026-004711"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8a5ca4c9-8a87-4ab3-aa13-65667856cea3"},{"name":"Send an appointment (all elements)","id":"34aeab6f-1978-47ff-ab47-49d07fd80a24","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/fhir+json"}],"body":{"mode":"raw","raw":"{\n  \"resourceType\": \"Appointment\",\n  \"id\": \"A-2026-004711\",\n  \"extension\": [\n    {\n      \"extension\": [\n        {\n          \"url\": \"http://fhir.heypatient.com/ig/extensions/DateOnlyDisplay\",\n          \"valueBoolean\": false\n        }\n      ]\n    },\n    {\n      \"extension\": [\n        {\n          \"url\": \"http://fhir.heypatient.com/ig/extensions/AssociatedFID\",\n          \"valueString\": \"210000001\"\n        }\n      ]\n    }\n  ],\n  \"identifier\": [\n    {\n      \"use\": \"official\",\n      \"system\": \"http://fhir.demospital.ch/DEMO/Appointment/id\",\n      \"value\": \"T-2026-004711\"\n    },\n    {\n      \"use\": \"official\",\n      \"system\": \"http://fhir.heypatient.com/ig/identifier/DEMO/localFID\",\n      \"value\": \"210000001\"\n    }\n  ],\n  \"status\": \"pending\",\n  \"serviceCategory\": [\n    {\n      \"coding\": [\n        {\n          \"system\": \"urn:oid:2.16.756.5.30.1.279.4.1.11\",\n          \"code\": \"PHYS\",\n          \"display\": \"Therapien\"\n        }\n      ]\n    }\n  ],\n  \"serviceType\": [\n    {\n      \"coding\": [\n        {\n          \"system\": \"urn:oid:2.16.756.5.30.1.279.4.1.10\",\n          \"code\": \"PHYSIO\",\n          \"display\": \"Physiotherapie\"\n        }\n      ]\n    }\n  ],\n  \"specialty\": [\n    {\n      \"coding\": [\n        {\n          \"system\": \"urn:oid:2.16.756.5.30.1.279.4.1.12\",\n          \"code\": \"ORTHO\",\n          \"display\": \"Orthopädie\"\n        }\n      ]\n    }\n  ],\n  \"appointmentType\": {\n    \"coding\": [\n      {\n        \"system\": \"http://terminology.hl7.org/CodeSystem/v2-0276\",\n        \"code\": \"FOLLOWUP\"\n      }\n    ]\n  },\n  \"description\": \"Physiotherapie nach Knie-Operation\",\n  \"start\": \"2026-12-10T10:00:00+01:00\",\n  \"end\": \"2026-12-10T10:40:00+01:00\",\n  \"minutesDuration\": 40,\n  \"comment\": \"Bitte melden Sie sich am Empfang Physiotherapie im 1. Stock.\",\n  \"patientInstruction\": \"Bitte bequeme Kleidung und ein Handtuch mitbringen.\",\n  \"participant\": [\n    {\n      \"actor\": {\n        \"reference\": \"Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\",\n        \"display\": \"Heidi Demopatient\"\n      },\n      \"status\": \"accepted\"\n    },\n    {\n      \"actor\": {\n        \"reference\": \"Practitioner/123456\",\n        \"display\": \"Dr. med. Anna Beispiel\"\n      },\n      \"status\": \"accepted\"\n    },\n    {\n      \"actor\": {\n        \"reference\": \"Location/PHYSIO-1\",\n        \"type\": \"Location\",\n        \"display\": \"Physiotherapie, 1. Stock\"\n      },\n      \"status\": \"accepted\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Appointment/A-2026-004711","description":"<p>Sends an appointment with every element heyPatient uses: your appointment number, the case number, practitioner, location, comment and instructions.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Appointment","A-2026-004711"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"34aeab6f-1978-47ff-ab47-49d07fd80a24"},{"name":"Cancel an appointment","id":"5d9a7bc6-f74c-46b1-a881-437c24360a21","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/fhir+json"}],"body":{"mode":"raw","raw":"{\n  \"resourceType\": \"Appointment\",\n  \"id\": \"A-2026-004711\",\n  \"status\": \"cancelled\",\n  \"serviceType\": [\n    {\n      \"coding\": [\n        {\n          \"system\": \"urn:oid:2.16.756.5.30.1.279.4.1.10\",\n          \"code\": \"OP\",\n          \"display\": \"Operation\"\n        }\n      ]\n    }\n  ],\n  \"description\": \"Operation Knie\",\n  \"start\": \"2026-12-03T07:30:00+01:00\",\n  \"end\": \"2026-12-03T10:00:00+01:00\",\n  \"participant\": [\n    {\n      \"actor\": {\n        \"reference\": \"Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\",\n        \"display\": \"Heidi Demopatient\"\n      },\n      \"status\": \"needs-action\"\n    }\n  ],\n  \"cancelationReason\": {\n    \"text\": \"Termin durch Spital abgesagt\"\n  }\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Appointment/A-2026-004711","description":"<p>Cancels an appointment. Send the complete appointment with <code>status: cancelled</code>. The patient sees it as cancelled and receives the notification \"Termin abgesagt\"; reminders for it are withdrawn.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Appointment","A-2026-004711"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5d9a7bc6-f74c-46b1-a881-437c24360a21"},{"name":"Send an appointment without notifications","id":"b7a897d2-c906-485e-9c72-be29ac059191","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/fhir+json"}],"body":{"mode":"raw","raw":"{\n  \"resourceType\": \"Appointment\",\n  \"id\": \"A-2026-004711\",\n  \"status\": \"booked\",\n  \"serviceType\": [\n    {\n      \"coding\": [\n        {\n          \"system\": \"urn:oid:2.16.756.5.30.1.279.4.1.10\",\n          \"code\": \"OP\",\n          \"display\": \"Operation\"\n        }\n      ]\n    }\n  ],\n  \"description\": \"Operation Knie\",\n  \"start\": \"2026-12-03T07:30:00+01:00\",\n  \"end\": \"2026-12-03T10:00:00+01:00\",\n  \"participant\": [\n    {\n      \"actor\": {\n        \"reference\": \"Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\",\n        \"display\": \"Heidi Demopatient\"\n      },\n      \"status\": \"needs-action\"\n    }\n  ],\n  \"extension\": [\n    {\n      \"url\": \"http://fhir.heypatient.com/ig/extensions/AppointmentSuppressNotifications\",\n      \"valueBoolean\": true\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Appointment/A-2026-004711","description":"<p>Writes an appointment without notifying the patient: the top-level extension <code>AppointmentSuppressNotifications</code> set to <code>true</code>. Use it when loading existing appointments, for example when a hospital starts with heyPatient.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Appointment","A-2026-004711"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b7a897d2-c906-485e-9c72-be29ac059191"},{"name":"Delete an appointment","id":"530a608f-1f09-4abe-9681-9d68a1d55801","request":{"method":"DELETE","header":[],"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Appointment/A-2026-004711","description":"<p>Removes the appointment from the patient's app without a notification. To tell the patient, send <code>status: cancelled</code> instead.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Appointment","A-2026-004711"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"530a608f-1f09-4abe-9681-9d68a1d55801"}],"id":"763e2bfc-0a9b-4865-aa1a-4f3e8c71e72b","description":"<p>An <code>Appointment</code> appears in the patient's timeline when a participant is a connected patient: <code>participant.actor.reference</code> = <code>Patient/&lt;id&gt;</code>.</p>\n<p><strong>Required:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Element</th>\n<th>Rule</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>status</code></td>\n<td>see the table below</td>\n</tr>\n<tr>\n<td><code>start</code>, <code>end</code></td>\n<td>with UTC offset</td>\n</tr>\n<tr>\n<td><code>participant</code></td>\n<td><code>Patient/&lt;id&gt;</code> (relative reference)</td>\n</tr>\n<tr>\n<td><code>description</code></td>\n<td>title in the app; may be left out when the appointment type in heyPortal has a description, which then takes precedence</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Appointment types:</strong> <code>serviceType[0].coding[0]</code> (<code>system</code> and <code>code</code>) links the appointment to an appointment type configured in heyPortal. The type adds information, reminders (for example fasting), tasks, the location with directions, and whether the patient has to confirm. Appointments of a type set to <em>blocked</em> in heyPortal are not shown. Without a matching type the appointment is shown with the data it carries.</p>\n<p><strong>Status:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><code>status</code></th>\n<th>Patient sees</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>pending</code></td>\n<td>new appointment, notification \"Neuer Termin\"</td>\n</tr>\n<tr>\n<td><code>proposed</code></td>\n<td>changed appointment, notification \"Termin aktualisiert\"</td>\n</tr>\n<tr>\n<td><code>booked</code></td>\n<td>the appointment, no notification</td>\n</tr>\n<tr>\n<td><code>cancelled</code></td>\n<td>the appointment as cancelled, notification \"Termin abgesagt\"; reminders are withdrawn</td>\n</tr>\n<tr>\n<td><code>arrived</code></td>\n<td>set by heyPatient when the patient checks in</td>\n</tr>\n<tr>\n<td><code>fulfilled</code>, <code>noshow</code></td>\n<td>the appointment, no notification</td>\n</tr>\n</tbody>\n</table>\n</div><p>The patient is notified once for each status and start time, and only for appointments in the future. A <code>pending</code> appointment that is sent again later counts as changed.</p>\n<p><strong>Confirmation:</strong> for appointment types that need confirmation, the patient confirms in the app and heyPatient sets <code>status</code> to <code>booked</code> on the <code>Appointment</code>.</p>\n<p><strong>Removing an appointment from the app:</strong></p>\n<ul>\n<li><code>status: cancelled</code>: shown as cancelled, with a notification.</li>\n<li><code>DELETE</code>: removed without a notification.</li>\n<li>Patient participant with <code>required: information-only</code>: not shown, for appointments the patient does not need to see.</li>\n</ul>\n<p><strong>Other elements:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Element</th>\n<th>Use</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>identifier</code></td>\n<td>your appointment number; <code>http://fhir.heypatient.com/ig/identifier/DEMO/localFID</code> with <code>use: official</code> gives the case number that lets the patient check in for this appointment</td>\n</tr>\n<tr>\n<td><code>participant</code> <code>Practitioner/…</code></td>\n<td><code>actor.display</code> is shown as the doctor</td>\n</tr>\n<tr>\n<td><code>participant</code> <code>Location/…</code> (or <code>actor.type</code> <code>Location</code>)</td>\n<td><code>actor.display</code> is shown; the reference is matched to the locations configured in heyPortal for directions</td>\n</tr>\n<tr>\n<td><code>comment</code></td>\n<td>shown with the appointment</td>\n</tr>\n<tr>\n<td><code>patientInstruction</code></td>\n<td>shown when heyPatient has enabled it for the hospital; otherwise the appointment type's information is shown</td>\n</tr>\n<tr>\n<td><code>serviceCategory</code>, <code>specialty</code>, <code>minutesDuration</code></td>\n<td>stored with the appointment</td>\n</tr>\n<tr>\n<td><code>appointmentType</code></td>\n<td>system <code>http://terminology.hl7.org/CodeSystem/v2-0276</code>, code <code>CHECKUP</code>, <code>EMERGENCY</code>, <code>FOLLOWUP</code>, <code>ROUTINE</code> or <code>WALKIN</code></td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Extensions</strong> (<code>http://fhir.heypatient.com/ig/extensions/…</code>):</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Extension</th>\n<th>Placement</th>\n<th>Value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>DateOnlyDisplay</code></td>\n<td>child of an extension without <code>url</code></td>\n<td><code>valueBoolean</code>; <code>true</code> shows the date without a time. Appointments starting at midnight show the date only.</td>\n</tr>\n<tr>\n<td><code>AssociatedFID</code></td>\n<td>child of an extension without <code>url</code></td>\n<td><code>valueString</code>, the case number shown with the appointment</td>\n</tr>\n<tr>\n<td><code>AppointmentSuppressNotifications</code></td>\n<td>top level, with <code>url</code></td>\n<td><code>valueBoolean</code>; <code>true</code> updates the appointment without notifications or e-mails, for example for an initial import</td>\n</tr>\n</tbody>\n</table>\n</div>","_postman_id":"763e2bfc-0a9b-4865-aa1a-4f3e8c71e72b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}}},{"name":"Tasks","item":[{"name":"Send a form task","id":"840ed25a-c43b-43f8-8562-86e68d5e766c","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/fhir+json"}],"body":{"mode":"raw","raw":"{\n  \"resourceType\": \"Task\",\n  \"id\": \"T-2026-000815\",\n  \"identifier\": [\n    {\n      \"system\": \"http://fhir.demospital.ch/DEMO/Task/id\",\n      \"value\": \"F-2026-0815\"\n    }\n  ],\n  \"status\": \"ready\",\n  \"intent\": \"order\",\n  \"code\": {\n    \"id\": \"ANAESTHESIE-FORM\",\n    \"text\": \"Anästhesie-Fragebogen\"\n  },\n  \"owner\": {\n    \"reference\": \"Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\"\n  },\n  \"input\": [\n    {\n      \"type\": {\n        \"text\": \"https://forms.example.ch/anaesthesie?token=c2VjcmV0LXBsYWNlaG9sZGVy\"\n      },\n      \"valueString\": \"Formular öffnen\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Task/T-2026-000815","description":"<p>Sends a to-do with a form: the patient opens the address in <code>input[0].type.text</code> from the task.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Task","T-2026-000815"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"840ed25a-c43b-43f8-8562-86e68d5e766c"},{"name":"Send a task for an appointment","id":"38e07481-2057-4987-89ca-c6da9866b1eb","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/fhir+json"}],"body":{"mode":"raw","raw":"{\n  \"resourceType\": \"Task\",\n  \"id\": \"T-2026-000815\",\n  \"basedOn\": [\n    {\n      \"reference\": \"Appointment/A-2026-004711\"\n    }\n  ],\n  \"status\": \"ready\",\n  \"intent\": \"order\",\n  \"code\": {\n    \"id\": \"ANAESTHESIE-FORM\",\n    \"text\": \"Anästhesie-Fragebogen\"\n  },\n  \"executionPeriod\": {\n    \"start\": \"2026-11-20T00:00:00+01:00\",\n    \"end\": \"2026-12-03T07:30:00+01:00\"\n  },\n  \"authoredOn\": \"2026-11-19T10:00:00+01:00\",\n  \"owner\": {\n    \"reference\": \"Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\"\n  },\n  \"restriction\": {\n    \"period\": {\n      \"end\": \"2026-12-01T23:59:00+01:00\"\n    }\n  },\n  \"input\": [\n    {\n      \"type\": {\n        \"text\": \"https://forms.example.ch/anaesthesie?token=c2VjcmV0LXBsYWNlaG9sZGVy\"\n      },\n      \"valueString\": \"Formular öffnen\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Task/T-2026-000815","description":"<p>Sends a to-do that belongs to an appointment (<code>basedOn</code>), shows from 20 November until the appointment starts (<code>executionPeriod</code>), and is due on 1 December (<code>restriction.period.end</code>).</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Task","T-2026-000815"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"38e07481-2057-4987-89ca-c6da9866b1eb"},{"name":"Close a task","id":"4bb8b596-8db6-44ea-9d48-fb14ebd457a8","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/fhir+json"}],"body":{"mode":"raw","raw":"{\n  \"resourceType\": \"Task\",\n  \"id\": \"T-2026-000815\",\n  \"basedOn\": [\n    {\n      \"reference\": \"Appointment/A-2026-004711\"\n    }\n  ],\n  \"status\": \"completed\",\n  \"intent\": \"order\",\n  \"code\": {\n    \"id\": \"ANAESTHESIE-FORM\",\n    \"text\": \"Anästhesie-Fragebogen\"\n  },\n  \"executionPeriod\": {\n    \"start\": \"2026-11-20T00:00:00+01:00\",\n    \"end\": \"2026-12-03T07:30:00+01:00\"\n  },\n  \"authoredOn\": \"2026-11-19T10:00:00+01:00\",\n  \"owner\": {\n    \"reference\": \"Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\"\n  },\n  \"restriction\": {\n    \"period\": {\n      \"end\": \"2026-12-01T23:59:00+01:00\"\n    }\n  },\n  \"input\": [\n    {\n      \"type\": {\n        \"text\": \"https://forms.example.ch/anaesthesie?token=c2VjcmV0LXBsYWNlaG9sZGVy\"\n      },\n      \"valueString\": \"Formular öffnen\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Task/T-2026-000815","description":"<p>Closes a to-do: the complete task with <code>status: completed</code>.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Task","T-2026-000815"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4bb8b596-8db6-44ea-9d48-fb14ebd457a8"}],"id":"3bc5940a-2014-4424-a380-c6e494f5afd0","description":"<p>A <code>Task</code> appears as a to-do in the patient's inbox, with a notification.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Element</th>\n<th>Rule</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>owner</code></td>\n<td><code>Patient/&lt;id&gt;</code>, required</td>\n</tr>\n<tr>\n<td><code>code.id</code></td>\n<td>the id of a task type configured in heyPortal (<code>ANAESTHESIE-FORM</code>). The patient sees that task type's title and text.</td>\n</tr>\n<tr>\n<td><code>status</code></td>\n<td>open: <code>ready</code>, <code>requested</code>, <code>received</code>, <code>accepted</code>; closed: <code>completed</code>, <code>cancelled</code>, <code>rejected</code>; or <code>draft</code></td>\n</tr>\n<tr>\n<td><code>intent</code></td>\n<td><code>order</code></td>\n</tr>\n<tr>\n<td><code>input[0].type.text</code></td>\n<td>address of a form the patient opens from the task (for example a sublimd form)</td>\n</tr>\n<tr>\n<td><code>basedOn[0]</code></td>\n<td><code>Appointment/&lt;id&gt;</code> links the task to an appointment</td>\n</tr>\n<tr>\n<td><code>executionPeriod</code></td>\n<td><code>start</code> and <code>end</code> of the period in which the task is shown</td>\n</tr>\n<tr>\n<td><code>restriction.period.end</code></td>\n<td>due date; without it the task is due 5 days after it arrives</td>\n</tr>\n<tr>\n<td><code>identifier</code></td>\n<td>your task number, stored with the task</td>\n</tr>\n</tbody>\n</table>\n</div><p>Each create or update notifies the patient, so write a task again only when something changes for the patient. Close a task with <code>status: completed</code> or <code>cancelled</code>.</p>\n","_postman_id":"3bc5940a-2014-4424-a380-c6e494f5afd0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}}},{"name":"Documents (DocumentReference)","item":[{"name":"Send a document","id":"b40d6663-1271-4275-a43a-e0a43e21bd02","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/fhir+json"}],"body":{"mode":"raw","raw":"{\n  \"resourceType\": \"DocumentReference\",\n  \"id\": \"D-2026-000042\",\n  \"status\": \"current\",\n  \"subject\": {\n    \"reference\": \"Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\"\n  },\n  \"date\": \"2026-11-19T10:00:00+01:00\",\n  \"description\": \"Austrittsbericht Orthopädie\",\n  \"content\": [\n    {\n      \"attachment\": {\n        \"contentType\": \"application/pdf\",\n        \"data\": \"JVBERi0xLjQKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZyAvUGFnZXMgMiAwIFIgPj4KZW5kb2JqCjIgMCBvYmoKPDwgL1R5cGUgL1BhZ2VzIC9LaWRzIFszIDAgUl0gL0NvdW50IDEgPj4KZW5kb2JqCjMgMCBvYmoKPDwgL1R5cGUgL1BhZ2UgL1BhcmVudCAyIDAgUiAvTWVkaWFCb3ggWzAgMCA1OTUgODQyXSA+PgplbmRvYmoKdHJhaWxlcgo8PCAvUm9vdCAxIDAgUiA+PgolJUVPRgo=\",\n        \"title\": \"Austrittsbericht.pdf\"\n      }\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/DocumentReference/D-2026-000042","description":"<p>Sends a PDF to the patient, without a document type.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["DocumentReference","D-2026-000042"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b40d6663-1271-4275-a43a-e0a43e21bd02"},{"name":"Send a document with type and category","id":"27bf695f-087f-424c-a76f-55abec5f00d6","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/fhir+json"}],"body":{"mode":"raw","raw":"{\n  \"resourceType\": \"DocumentReference\",\n  \"id\": \"D-2026-000042\",\n  \"status\": \"current\",\n  \"type\": {\n    \"coding\": [\n      {\n        \"system\": \"http://fhir.heypatient.com/valuesets/heypatient/demo/documentType\",\n        \"code\": \"invoice\",\n        \"display\": \"Rechnungskopie\"\n      }\n    ]\n  },\n  \"category\": [\n    {\n      \"coding\": [\n        {\n          \"system\": \"http://fhir.heypatient.com/valuesets/heypatient/demo/documentCategory\",\n          \"code\": \"AdminDoc\",\n          \"display\": \"Administratives Dokument\"\n        }\n      ]\n    }\n  ],\n  \"subject\": {\n    \"reference\": \"Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\"\n  },\n  \"date\": \"2026-11-19T10:00:00+01:00\",\n  \"description\": \"Rechnungskopie Fall 210000001\",\n  \"content\": [\n    {\n      \"attachment\": {\n        \"contentType\": \"application/pdf\",\n        \"data\": \"JVBERi0xLjQKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZyAvUGFnZXMgMiAwIFIgPj4KZW5kb2JqCjIgMCBvYmoKPDwgL1R5cGUgL1BhZ2VzIC9LaWRzIFszIDAgUl0gL0NvdW50IDEgPj4KZW5kb2JqCjMgMCBvYmoKPDwgL1R5cGUgL1BhZ2UgL1BhcmVudCAyIDAgUiAvTWVkaWFCb3ggWzAgMCA1OTUgODQyXSA+PgplbmRvYmoKdHJhaWxlcgo8PCAvUm9vdCAxIDAgUiA+PgolJUVPRgo=\",\n        \"title\": \"Rechnungskopie.pdf\"\n      }\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/DocumentReference/D-2026-000042","description":"<p>Sends a PDF with a document type and category. The codes (<code>invoice</code>, <code>AdminDoc</code>) are examples; use the codes configured for your hospital in heyPortal.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["DocumentReference","D-2026-000042"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"27bf695f-087f-424c-a76f-55abec5f00d6"},{"name":"Send a link","id":"262fec77-1570-4318-a9b7-d02f8dcbf245","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/fhir+json"}],"body":{"mode":"raw","raw":"{\n  \"resourceType\": \"DocumentReference\",\n  \"id\": \"D-2026-000042\",\n  \"status\": \"current\",\n  \"subject\": {\n    \"reference\": \"Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\"\n  },\n  \"date\": \"2026-11-19T10:00:00+01:00\",\n  \"description\": \"Röntgenbilder Knie\",\n  \"content\": [\n    {\n      \"attachment\": {\n        \"url\": \"https://portal.demospital.ch/share/7f3c9a2e\",\n        \"title\": \"Bilder im Spitalportal ansehen\"\n      }\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/DocumentReference/D-2026-000042","description":"<p>Sends a link instead of a file. The patient opens the address in the browser.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["DocumentReference","D-2026-000042"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"262fec77-1570-4318-a9b7-d02f8dcbf245"},{"name":"Find documents uploaded by patients","id":"38c73b6c-a241-4c88-9f50-27a0e64a9c40","request":{"method":"GET","header":[],"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/DocumentReference?_tag=https://heypatient.com/fhir/tags|patient-uploaded&encounter=Encounter/2cefc305-b335-4722-bf50-5203d9271e23","description":"<p>Lists the documents a patient uploaded with an admission request. Leave out <code>encounter</code> to list all uploads, and add <code>_lastUpdated=ge&lt;date&gt;</code> to read only new ones.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["DocumentReference"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[{"key":"_tag","value":"https://heypatient.com/fhir/tags|patient-uploaded"},{"key":"encounter","value":"Encounter/2cefc305-b335-4722-bf50-5203d9271e23"}],"variable":[]}},"response":[{"id":"aae0aa2f-ae53-4725-a9bd-eea653878255","name":"One uploaded document","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/DocumentReference?_tag=https://heypatient.com/fhir/tags|patient-uploaded&encounter=Encounter/2cefc305-b335-4722-bf50-5203d9271e23","host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"path":["DocumentReference"],"query":[{"key":"_tag","value":"https://heypatient.com/fhir/tags|patient-uploaded"},{"key":"encounter","value":"Encounter/2cefc305-b335-4722-bf50-5203d9271e23"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/fhir+json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"resourceType\": \"Bundle\",\n  \"type\": \"searchset\",\n  \"link\": [\n    {\n      \"relation\": \"self\",\n      \"url\": \"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/DocumentReference?_tag=https://heypatient.com/fhir/tags|patient-uploaded&encounter=Encounter/2cefc305-b335-4722-bf50-5203d9271e23\"\n    }\n  ],\n  \"entry\": [\n    {\n      \"fullUrl\": \"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/DocumentReference/9f95350f-000c-426f-823e-f8d1f4bf2418\",\n      \"resource\": {\n        \"resourceType\": \"DocumentReference\",\n        \"id\": \"9f95350f-000c-426f-823e-f8d1f4bf2418\",\n        \"meta\": {\n          \"versionId\": \"1\",\n          \"lastUpdated\": \"2026-11-18T09:14:16.145+00:00\",\n          \"tag\": [\n            {\n              \"system\": \"https://heypatient.com/fhir/tags\",\n              \"code\": \"patient-uploaded\",\n              \"display\": \"Patient Uploaded Document\"\n            }\n          ]\n        },\n        \"status\": \"current\",\n        \"type\": {\n          \"coding\": [\n            {\n              \"system\": \"http://fhir.heypatient.com/valuesets/heypatient/demo/documentType\",\n              \"code\": \"insurance-card\",\n              \"display\": \"insurance-card\"\n            }\n          ]\n        },\n        \"category\": [\n          {\n            \"coding\": [\n              {\n                \"system\": \"http://fhir.heypatient.com/valuesets/heypatient/demo/documentCategory\",\n                \"code\": \"AdminDoc\",\n                \"display\": \"AdminDoc\"\n              }\n            ]\n          }\n        ],\n        \"subject\": {\n          \"reference\": \"Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\",\n          \"display\": \"4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\"\n        },\n        \"date\": \"2026-11-18T09:14:10.963+00:00\",\n        \"description\": \"Versicherungskarte\",\n        \"content\": [\n          {\n            \"attachment\": {\n              \"contentType\": \"image/jpeg\",\n              \"data\": \"/9j/4AAQSkZJRgABAQ...\",\n              \"size\": 48211,\n              \"hash\": \"rA6PLA5dHMFv6lmWXZnpX0sbQYE=\"\n            }\n          }\n        ],\n        \"context\": {\n          \"encounter\": [\n            {\n              \"reference\": \"Encounter/2cefc305-b335-4722-bf50-5203d9271e23\",\n              \"display\": \"2cefc305-b335-4722-bf50-5203d9271e23\"\n            }\n          ]\n        }\n      },\n      \"search\": {\n        \"mode\": \"match\"\n      }\n    }\n  ]\n}"}],"_postman_id":"38c73b6c-a241-4c88-9f50-27a0e64a9c40"}],"id":"a29041d5-183b-43af-9a13-d1b240cb6a37","description":"<p>A <code>DocumentReference</code> appears as a document in the patient's inbox, with the notification \"Sie haben ein neues Dokument erhalten.\"</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Element</th>\n<th>Rule</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>subject</code></td>\n<td><code>Patient/&lt;id&gt;</code> of a connected patient, required</td>\n</tr>\n<tr>\n<td><code>description</code></td>\n<td>title in the app and file name. The title <code>Admission document</code> is reserved for heyPatient.</td>\n</tr>\n<tr>\n<td><code>date</code></td>\n<td>date shown; without it, the time the document arrives</td>\n</tr>\n<tr>\n<td><code>type.coding[0].code</code> and <code>category[0].coding[0].code</code></td>\n<td>together they select a document type configured in heyPortal. heyPatient writes them with the systems <code>http://fhir.heypatient.com/valuesets/heypatient/demo/documentType</code> and <code>…/documentCategory</code>. Without matching codes the document is shown without a type.</td>\n</tr>\n<tr>\n<td><code>status</code></td>\n<td><code>current</code></td>\n</tr>\n<tr>\n<td><code>content[0].attachment</code></td>\n<td>the file, either as <code>data</code> or as <code>url</code>, see below</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>File as <code>data</code>:</strong> base64 with <code>contentType</code>. PDF, JPEG, PNG, WebP, GIF and MP4 open in the app; other formats are offered as a download. Up to 20 MB per file.</p>\n<p><strong>Link as <code>url</code>:</strong> an <code>https</code> address of at most 2,048 characters that opens in the browser without a login to the FHIR server, for example a share link of your patient portal. <code>attachment.title</code> is the link text.</p>\n<p><strong>Documents from patients:</strong> documents the patient uploads with an admission are written by heyPatient as <code>DocumentReference</code> with the meta tag <code>https://heypatient.com/fhir/tags|patient-uploaded</code> and <code>context.encounter</code> pointing to the admission <code>Encounter</code>. heyPatient does not send them back to the patient.</p>\n","_postman_id":"a29041d5-183b-43af-9a13-d1b240cb6a37","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}}},{"name":"Messages (Communication)","item":[{"name":"Send a message to a patient","id":"60b57c1e-8b6c-448d-8e40-9c268fffae63","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/fhir+json"}],"body":{"mode":"raw","raw":"{\n  \"resourceType\": \"Communication\",\n  \"id\": \"M-2026-000007\",\n  \"status\": \"in-progress\",\n  \"topic\": {\n    \"text\": \"Ihr Eintritt am 3. Dezember\"\n  },\n  \"recipient\": [\n    {\n      \"reference\": \"Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\"\n    }\n  ],\n  \"payload\": [\n    {\n      \"contentString\": \"Guten Tag Frau Demopatient\"\n    },\n    {\n      \"contentString\": \"Bitte bringen Sie am Eintrittstag Ihre Versicherungskarte und Ihre Medikamentenliste mit.\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Communication/M-2026-000007","description":"<p>Sends a message to one patient.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Communication","M-2026-000007"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"60b57c1e-8b6c-448d-8e40-9c268fffae63"},{"name":"Send a message to all patients","id":"d36f6fba-8a46-4fc6-afff-56f00ad19ba9","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/fhir+json"}],"body":{"mode":"raw","raw":"{\n  \"resourceType\": \"Communication\",\n  \"id\": \"M-2026-000007\",\n  \"status\": \"in-progress\",\n  \"topic\": {\n    \"text\": \"Neue Besuchszeiten\"\n  },\n  \"recipient\": [\n    {\n      \"reference\": \"Organization/DEMO\"\n    }\n  ],\n  \"payload\": [\n    {\n      \"contentString\": \"Ab 1. Dezember sind Besuche täglich von 10 bis 20 Uhr möglich.\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Communication/M-2026-000007","description":"<p>Sends a message to every patient connected to the hospital with the app.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Communication","M-2026-000007"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d36f6fba-8a46-4fc6-afff-56f00ad19ba9"},{"name":"Check a message's delivery","id":"8a483e03-fd65-4a11-93f0-e855a8fdd99a","request":{"method":"GET","header":[],"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Communication/M-2026-000007","description":"<p>Reads the message back to see whether it was delivered: <code>status</code> <code>completed</code>, or <code>stopped</code> when it was not.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["Communication","M-2026-000007"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[],"variable":[]}},"response":[{"id":"6c14916b-83f0-42b6-bec4-26a23c33381f","name":"Delivered","originalRequest":{"method":"GET","header":[],"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Communication/M-2026-000007"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/fhir+json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"resourceType\": \"Communication\",\n  \"id\": \"b7d1a1c4-3f0e-4d55-9a57-1f2f5e3c9d10\",\n  \"status\": \"completed\",\n  \"topic\": {\n    \"text\": \"Ihr Eintritt am 3. Dezember\"\n  },\n  \"recipient\": [\n    {\n      \"reference\": \"Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\"\n    }\n  ],\n  \"payload\": [\n    {\n      \"contentString\": \"Guten Tag Frau Demopatient\"\n    },\n    {\n      \"contentString\": \"Bitte bringen Sie am Eintrittstag Ihre Versicherungskarte und Ihre Medikamentenliste mit.\"\n    }\n  ],\n  \"meta\": {\n    \"versionId\": \"2\",\n    \"lastUpdated\": \"2026-11-19T09:00:02.318+00:00\"\n  }\n}"}],"_postman_id":"8a483e03-fd65-4a11-93f0-e855a8fdd99a"}],"id":"35997533-d11b-471b-a5d7-4713aabd9082","description":"<p>A <code>Communication</code> with <code>status: in-progress</code> appears as a message in the inbox, with a notification.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Element</th>\n<th>Rule</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>status</code></td>\n<td><code>in-progress</code></td>\n</tr>\n<tr>\n<td><code>recipient</code></td>\n<td><code>Patient/&lt;id&gt;</code> for one patient, or <code>Organization/DEMO</code> for every patient connected to the hospital with the app</td>\n</tr>\n<tr>\n<td><code>topic.text</code></td>\n<td>title of the message, required</td>\n</tr>\n<tr>\n<td><code>payload[].contentString</code></td>\n<td>text; several payloads are shown as separate paragraphs</td>\n</tr>\n</tbody>\n</table>\n</div><p>heyPatient then sets <code>status</code> to <code>completed</code>, or to <code>stopped</code> when the message could not be delivered.</p>\n","_postman_id":"35997533-d11b-471b-a5d7-4713aabd9082","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}}},{"name":"Check-ins (AuditEvent)","item":[{"name":"Find check-ins","id":"cd22338f-e0bb-4894-a299-6fbd9328b7ea","request":{"method":"GET","header":[],"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/AuditEvent?type=http://fhir.heypatient.com/valuesets/eventtypes|CHECKIN&date=ge2026-12-01","description":"<p>Lists the check-ins since a date. Search by <code>entity=Appointment/&lt;id&gt;</code> for the check-ins of one appointment.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}},"urlObject":{"path":["AuditEvent"],"host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"query":[{"key":"type","value":"http://fhir.heypatient.com/valuesets/eventtypes|CHECKIN"},{"key":"date","value":"ge2026-12-01"}],"variable":[]}},"response":[{"id":"a5c3c749-3e3a-4146-afa6-87206a29e70a","name":"One check-in","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/AuditEvent?type=http://fhir.heypatient.com/valuesets/eventtypes|CHECKIN&date=ge2026-12-01","host":["https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"],"path":["AuditEvent"],"query":[{"key":"type","value":"http://fhir.heypatient.com/valuesets/eventtypes|CHECKIN"},{"key":"date","value":"ge2026-12-01"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/fhir+json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"resourceType\": \"Bundle\",\n  \"type\": \"searchset\",\n  \"link\": [\n    {\n      \"relation\": \"self\",\n      \"url\": \"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/AuditEvent?type=http://fhir.heypatient.com/valuesets/eventtypes|CHECKIN&date=ge2026-12-01\"\n    }\n  ],\n  \"entry\": [\n    {\n      \"fullUrl\": \"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/AuditEvent/5ea952b5-b300-4df8-835d-713e80558b8b\",\n      \"resource\": {\n        \"resourceType\": \"AuditEvent\",\n        \"id\": \"5ea952b5-b300-4df8-835d-713e80558b8b\",\n        \"meta\": {\n          \"versionId\": \"1\",\n          \"lastUpdated\": \"2026-12-03T06:58:12.237+00:00\"\n        },\n        \"type\": {\n          \"system\": \"http://fhir.heypatient.com/valuesets/eventtypes\",\n          \"code\": \"CHECKIN\",\n          \"display\": \"Patient checkin at Haupteingang\"\n        },\n        \"action\": \"E\",\n        \"recorded\": \"2026-12-03T06:58:11.996+00:00\",\n        \"outcome\": \"0\",\n        \"agent\": [\n          {\n            \"who\": {\n              \"reference\": \"Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\"\n            }\n          }\n        ],\n        \"source\": {\n          \"site\": \"DEMO\",\n          \"observer\": {\n            \"reference\": \"Patient/4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8\"\n          },\n          \"type\": [\n            {\n              \"system\": \"http://fhir.heypatient.com/valuesets/source\",\n              \"code\": \"MOBILE\"\n            }\n          ]\n        },\n        \"entity\": [\n          {\n            \"what\": {\n              \"reference\": \"Appointment/A-2026-004711\"\n            },\n            \"type\": {\n              \"system\": \"http://terminology.hl7.org/CodeSystem/audit-entity-type\",\n              \"code\": \"2\",\n              \"display\": \"System Object\"\n            },\n            \"role\": {\n              \"system\": \"http://terminology.hl7.org/CodeSystem/object-role\",\n              \"code\": \"4\",\n              \"display\": \"Domain Resource\"\n            }\n          }\n        ]\n      },\n      \"search\": {\n        \"mode\": \"match\"\n      }\n    }\n  ]\n}"}],"_postman_id":"cd22338f-e0bb-4894-a299-6fbd9328b7ea"}],"id":"e7908263-bab1-4826-b554-12c9f199511b","description":"<p>When a patient checks in for an appointment or an admission, in the app or on the web, heyPatient</p>\n<ul>\n<li>sets <code>status: arrived</code> on the <code>Appointment</code> or the admission <code>Encounter</code>,</li>\n<li>writes an <code>AuditEvent</code>:</li>\n</ul>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Element</th>\n<th>Value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>type</code></td>\n<td>system <code>http://fhir.heypatient.com/valuesets/eventtypes</code>, code <code>CHECKIN</code>, display <code>Patient checkin at &lt;location&gt;</code></td>\n</tr>\n<tr>\n<td><code>recorded</code></td>\n<td>time of the check-in</td>\n</tr>\n<tr>\n<td><code>agent[0].who</code>, <code>source.observer</code></td>\n<td>the patient</td>\n</tr>\n<tr>\n<td><code>source.site</code></td>\n<td><code>DEMO</code></td>\n</tr>\n<tr>\n<td><code>source.type[0]</code></td>\n<td>system <code>http://fhir.heypatient.com/valuesets/source</code>, code <code>MOBILE</code> or <code>WEB</code></td>\n</tr>\n<tr>\n<td><code>entity[].what</code></td>\n<td><code>Appointment/&lt;id&gt;</code> and/or <code>Encounter/&lt;id&gt;</code></td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>When check-in is offered:</strong> the hospital has check-in enabled in heyPatient, and the case number is confirmed in one of these places, with <code>use: official</code>:</p>\n<ul>\n<li>the <code>Patient</code>: <code>http://fhir.heypatient.com/valuesets/DEMO-FID</code></li>\n<li>the admission <code>Encounter</code>: <code>http://fhir.heypatient.com/ig/identifier/DEMO/localFID</code></li>\n<li>the <code>Appointment</code>: <code>http://fhir.heypatient.com/ig/identifier/DEMO/localFID</code></li>\n</ul>\n","_postman_id":"e7908263-bab1-4826-b554-12c9f199511b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"91005237-b0b4-45a9-8390-40f2292e5253","id":"91005237-b0b4-45a9-8390-40f2292e5253","name":"FHIR API Documentation","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"variable":[{"key":"fhirBaseUrl","value":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com"},{"key":"hcp","value":"DEMO"},{"key":"hcpLower","value":"demo"},{"key":"tenantId","value":"f049c21e-43d2-4bf5-9209-dbaa9e9e278e"},{"key":"clientId","value":""},{"key":"username","value":""},{"key":"password","value":""},{"key":"accessToken","value":""},{"key":"patientId","value":"4d3dea4e-7b2a-4aa7-b2b1-308ca73663b8"},{"key":"localPid","value":"21001"},{"key":"localFid","value":"210000001"},{"key":"encounterId","value":"2cefc305-b335-4722-bf50-5203d9271e23"},{"key":"appointmentId","value":"A-2026-004711"},{"key":"taskId","value":"T-2026-000815"},{"key":"taskType","value":"ANAESTHESIE-FORM"},{"key":"documentId","value":"D-2026-000042"},{"key":"communicationId","value":"M-2026-000007"}]}