This Postman collection represents the currently implemented functionality for healthcare providers to interact with the heyPatient ecosystem for the exchange of the relevant administrative data for patient and encounter management, including admission, appointments, care related tasks and documents, and more.
\n","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":"Authorisation & Authentication","item":[{"name":"Get Token","event":[{"listen":"test","script":{"id":"af90437b-dce6-4f6e-8825-5cf41aae5d0c","exec":["pm.test(\"Status code is 200\", function () {\r","//pm.collectionVariables.get(\"variable_key\");\r","let response = pm.response.json();\r","pm.environment.set(\"access_token\", response.access_token);\r","pm.response.to.have.status(200);\r","});"],"type":"text/javascript"}}],"id":"ccc1f59a-d063-46d6-bec2-950e6563116d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"grant_type","value":"password\n","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"},{"key":"client_secret","value":"{{client_secret}}","type":"text"},{"key":"scope","value":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/user_impersonation offline_access","type":"text"},{"key":"username","value":"{{username}}","type":"text"},{"key":"password","value":"{{password}}","type":"text"}]},"url":"https://login.microsoftonline.com/f049c21e-43d2-4bf5-9209-dbaa9e9e278e/oauth2/v2.0/token","urlObject":{"protocol":"https","path":["f049c21e-43d2-4bf5-9209-dbaa9e9e278e","oauth2","v2.0","token"],"host":["login","microsoftonline","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ccc1f59a-d063-46d6-bec2-950e6563116d"}],"id":"44b630cc-4017-4c19-a807-cfa7f3d508f9","description":"Authentication and access authorisation are provided in the OAUTH2 framework, with the requirement to acquire a federated access token before accessing the target data.
\n","_postman_id":"44b630cc-4017-4c19-a807-cfa7f3d508f9"},{"name":"Basic Patient Use Case","item":[{"name":"Query new unassigned patients","id":"8f097d75-c983-46d8-a5d2-66f470555112","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient?identifier=http://fhir.heypatient.com/valuesets/DEMO-PID|unassigned","description":"Query for the complete admission data set of patients that request admission at the health care site DEMO, by searching for patient data sets that show a PID/FID identifier element for the HCP, with the corresponding value \"unassigned\".
\nAn entry in the list is effected by a patient using the \"anmeldung\" functionality in the app:
\nResponse message for a patient for successful admission, containing the local PID (and FID - if available) in the identifier segment of the message
\nThe response is displayed in the app:
\nThis API call is used if only local PID and/or local FID must be transmitted to the API, without resending the complete Patient resource. Make sure that the correct array index for the desired identifier is usesd in the PATCH call.
\n","urlObject":{"protocol":"https","path":["Patient","demo-{{localPid}}"],"host":["heypatienthdsstaging-demo","fhir","azurehealthcareapis","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0ed3759b-4301-4668-aeae-77240cc92c45"}],"id":"37d137e1-e6b8-4854-8997-8d524b4e0fa3","description":"This API query group allows the HCP to manage admission of heyPatient users who apply for registration and admission using the heyPatient app.
\n","_postman_id":"37d137e1-e6b8-4854-8997-8d524b4e0fa3"},{"name":"Include Additional Patient Attributes","item":[{"name":"Added attributes for name, epr, disability","id":"053cb9b1-3940-40db-a06b-5a417e1a8115","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Patient\",\r\n \"id\": \"demo-{{localPid}}\",\r\n \"meta\": {\r\n \"versionId\": \"4\",\r\n \"lastUpdated\": \"2023-01-26T14:43:31.575+00:00\"\r\n },\r\n \"extension\": [\r\n {\r\n \"extension\": [\r\n {\r\n \"url\": \"http://fhir.heypatient.com/valuesets/Profession\",\r\n \"valueString\": \"Interaction Designer\"\r\n }\r\n ]\r\n },\r\n {\r\n \"extension\": [\r\n {\r\n \"url\": \"http://fhir.heypatient.com/valuesets/heyUsertype\",\r\n \"valueString\": \"heyAppUser\"\r\n }\r\n ]\r\n },\r\n {\r\n \"extension\": [\r\n {\r\n \"url\": \"http://fhir.heypatient.com/valuesets/eprUser\",\r\n \"valueBoolean\": \"true\"\r\n }\r\n ]\r\n },\r\n {\r\n \"extension\": [\r\n {\r\n \"url\": \"code\",\r\n \"valueCodeableConcept\": {\r\n \"coding\": [\r\n {\r\n \"system\": \"urn:iso:std:iso:3166\",\r\n \"code\": \"CH\"\r\n }\r\n ]\r\n }\r\n }\r\n ],\r\n \"url\": \"http://hl7.org/fhir/StructureDefinition/patient-citizenship\"\r\n },\r\n {\r\n \"extension\": [\r\n { \r\n \"url\": \"http://fhir.heypatient.com/valuesets/disabled\",\r\n \"valueBoolean\": \"true\"\r\n }\r\n ]\r\n },\r\n {\r\n \"extension\": [\r\n {\r\n \"url\": \"http://fhir.heypatient.com/valuesets/VEKAnummerBasicInsurance\",\r\n \"valueString\": \"80756015420226137217\"\r\n },\r\n {\r\n \"url\": \"http://fhir.heypatient.com/valuesets/NameBasicInsurance\",\r\n \"valueString\": \"Assura\"\r\n },\r\n {\r\n \"url\": \"http://fhir.heypatient.com/valuesets/PlaceBasicInsurance\",\r\n \"valueString\": \"Zürich\"\r\n },\r\n {\r\n \"url\": \"http://fhir.heypatient.com/valuesets/VersichertennummerBasicInsurance\",\r\n \"valueString\": \"01542\"\r\n },\r\n {\r\n \"url\": \"http://fhir.heypatient.com/valuesets/ExpirationBasicInsurance\",\r\n \"valueDate\": \"2024-03-31\"\r\n },\r\n {\r\n \"url\": \"http://fhir.heypatient.com/valuesets/CoverageBasicInsurance\",\r\n \"valueString\": \"general\"\r\n },\r\n {\r\n \"url\": \"http://fhir.heypatient.com/valuesets/ModelBasicInsurance\",\r\n \"valueString\": \"family_doctor\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"identifier\": [\r\n {\r\n \"use\": \"official\",\r\n \"system\": \"http://fhir.heypatient.com/valuesets/heyID\",\r\n \"value\": \"165dcf46-a994-4f9b-b9f5-10443817213f\"\r\n },\r\n {\r\n \"use\": \"official\",\r\n \"system\": \"http://fhir.heypatient.com/valuesets/DEMO-PID\",\r\n \"value\": \"{{localPid}}\"\r\n },\r\n {\r\n \"use\": \"official\",\r\n \"system\": \"http://fhir.heypatient.com/valuesets/DEMO-AdmissionRequestId\",\r\n \"value\": \"{{AdmitReqId}}\"\r\n },\r\n {\r\n \"use\": \"official\",\r\n \"system\": \"http://fhir.heypatient.com/valuesets/DEMO-FID\",\r\n \"value\": \"{{localFid}}\"\r\n },\r\n {\r\n \"use\": \"official\",\r\n \"system\": \"urn:oid:2.16.756.5.30.1.127.3.10.3\",\r\n \"value\": \"7560405301810\"\r\n },\r\n {\r\n \"use\": \"official\",\r\n \"system\": \"urn:oid:2.16.756.5.32\",\r\n \"value\": \"7560405301810\"\r\n }\r\n ],\r\n \"active\": true,\r\n \"name\": [\r\n {\r\n \"use\": \"official\",\r\n \"family\": \"Demopatient\",\r\n \"given\": [\r\n \"Heidi\",\r\n \"Annabelle\"\r\n ]\r\n },\r\n {\r\n \"use\": \"maiden\",\r\n \"family\": \"Musterpatient\"\r\n }\r\n ],\r\n \"telecom\": [\r\n {\r\n \"system\": \"phone\",\r\n \"value\": \"+41761234567\",\r\n \"use\": \"mobile\"\r\n },\r\n {\r\n \"system\": \"email\",\r\n \"value\": \"heidi.demopatient@hotmail.com\"\r\n }\r\n ],\r\n \"gender\": \"female\",\r\n \"birthDate\": \"1990-07-21\",\r\n \"address\": [\r\n {\r\n \"use\": \"home\",\r\n \"line\": [\r\n \"Musterstrasse 43\"\r\n ],\r\n \"city\": \"Zürich\",\r\n \"postalCode\": \"8132\",\r\n \"country\": \"CH\"\r\n }\r\n ],\r\n \"maritalStatus\": {\r\n \"coding\": [\r\n {\r\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-MaritalStatus\",\r\n \"code\": \"U\"\r\n },\r\n {\r\n \"system\": \"https://fhir.ch/ig/ch-core/CodeSystem-ech-11-maritalstatus.html\",\r\n \"code\": \"5\"\r\n }\r\n ]\r\n },\r\n \"contact\": [\r\n {\r\n \"relationship\": [\r\n {\r\n \"coding\": [\r\n {\r\n \"system\": \"http://www.hl7.org/FHIR/v3/RoleCode/cs.html\",\r\n \"code\": \"C\"\r\n }\r\n ]\r\n },\r\n {\r\n \"coding\": [\r\n {\r\n \"system\": \"http://www.hl7.org/FHIR/v3/RoleCode/cs.html\",\r\n \"code\": \"O\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"name\": {\r\n \"family\": \"Familie\",\r\n \"given\": [\r\n \"Kontakt\"\r\n ]\r\n },\r\n \"telecom\": [\r\n {\r\n \"system\": \"phone\",\r\n \"value\": \"+41791234567\"\r\n }\r\n ],\r\n \"address\": {\r\n \"use\": \"home\",\r\n \"line\": [\r\n \"Nebenstrasse 1\"\r\n ],\r\n \"city\": \"Zürich\",\r\n \"postalCode\": \"8057\",\r\n \"country\": \"CH\"\r\n }\r\n }\r\n ],\r\n \"communication\": [\r\n {\r\n \"language\": {\r\n \"coding\": [\r\n {\r\n \"system\": \"urn:ietf:bcp:47\",\r\n \"code\": \"de-CH\"\r\n }\r\n ]\r\n },\r\n \"preferred\": true\r\n }\r\n ],\r\n \"managingOrganization\": {\r\n \"reference\": \"Organization/DEMO\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient/demo-{{localPid}}","description":"Nov 2023: add maiden name, additional first name, flags for disability and for existing electronic patient record \"EPD\".
\n","urlObject":{"protocol":"https","path":["Patient","demo-{{localPid}}"],"host":["heypatienthdsstaging-demo","fhir","azurehealthcareapis","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"053cb9b1-3940-40db-a06b-5a417e1a8115"}],"id":"0ebbe1cb-9af3-4e19-b9e6-5872e16be8cb","description":"The requests in this section include additional Patient resource atrributes that have been added according to customers' requests
\n","_postman_id":"0ebbe1cb-9af3-4e19-b9e6-5872e16be8cb"},{"name":"Basic Appointment Use Case","item":[{"name":"Query Patient with given localPID","id":"1417f2d2-85ba-44a6-84f8-70c4430a5647","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient?identifier=http://fhir.heypatient.com/valuesets/DEMO-PID|{{localPid}}","description":"This pre-query receives the Patient resourceId for a given local PID, to be included as a patient reference in appointment participant sections.
\nIf the Patient resourceId was previously stored locally, this query can be omitted.
\n","urlObject":{"protocol":"https","path":["Patient"],"host":["heypatienthdsstaging-demo","fhir","azurehealthcareapis","com"],"query":[{"key":"identifier","value":"http://fhir.heypatient.com/valuesets/DEMO-PID|{{localPid}}"}],"variable":[]}},"response":[{"id":"2459eb52-c201-4a6d-bc69-f45c0951245f","name":"Query Patient with given localPID","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient?identifier=http://fhir.heypatient.com/valuesets/DEMO-PID|{{localPid}}","protocol":"https","host":["heypatienthdsstaging-demo","fhir","azurehealthcareapis","com"],"path":["Patient"],"query":[{"key":"identifier","value":"http://fhir.heypatient.com/valuesets/DEMO-PID|{{localPid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/fhir+json; charset=utf-8"},{"key":"Date","value":"Mon, 27 Feb 2023 07:51:23 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-Request-ID","value":"c61316ba95fdca1d4fbd021c2f878c96"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Security-Policy","value":"frame-src 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"resourceType\": \"Bundle\",\n \"id\": \"c61316ba95fdca1d4fbd021c2f878c96\",\n \"meta\": {\n \"lastUpdated\": \"2023-02-27T07:51:23.8551645+00:00\"\n },\n \"type\": \"searchset\",\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient?identifier=http%3A%2F%2Ffhir.heypatient.com%2Fvaluesets%2FDEMO-PID%7C999999\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Patient/demo-999999\",\n \"resource\": {\n \"resourceType\": \"Patient\",\n \"id\": \"demo-999999\",\n \"meta\": {\n \"versionId\": \"8\",\n \"lastUpdated\": \"2023-02-27T07:50:18.341+00:00\"\n },\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"http://fhir.heypatient.com/valuesets/Profession\",\n \"valueString\": \"Interaction Designer\"\n }\n ]\n },\n {\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 \"url\": \"http://hl7.org/fhir/StructureDefinition/patient-citizenship\"\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\": \"2024-03-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 }\n ],\n \"identifier\": [\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\": \"http://fhir.heypatient.com/valuesets/DEMO-PID\",\n \"value\": \"999999\"\n },\n {\n \"use\": \"official\",\n \"system\": \"http://fhir.heypatient.com/valuesets/DEMO-FID\",\n \"value\": \"1077729\"\n },\n {\n \"use\": \"official\",\n \"system\": \"urn:oid:2.16.756.5.30.1.127.3.10.3\",\n \"value\": \"7560405301810\"\n }\n ],\n \"active\": true,\n \"name\": [\n {\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@hotmail.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\": \"8132\",\n \"country\": \"CH\"\n }\n ],\n \"maritalStatus\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-MaritalStatus\",\n \"code\": \"U\"\n },\n {\n \"system\": \"https://fhir.ch/ig/ch-core/CodeSystem-ech-11-maritalstatus.html\",\n \"code\": \"5\"\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\": \"O\"\n }\n ]\n }\n ],\n \"name\": {\n \"family\": \"Familie\",\n \"given\": [\n \"Kontakt\"\n ]\n },\n \"telecom\": [\n {\n \"system\": \"phone\",\n \"value\": \"+41791234567\"\n }\n ],\n \"address\": {\n \"use\": \"home\",\n \"line\": [\n \"Nebenstrasse 1\"\n ],\n \"city\": \"Zürich\",\n \"postalCode\": \"8057\",\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 \"managingOrganization\": {\n \"reference\": \"Organization/DEMO\"\n }\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ]\n}"}],"_postman_id":"1417f2d2-85ba-44a6-84f8-70c4430a5647"},{"name":"Send Appointment for specific local patient (required basic attributes)","id":"b7f37e8e-9aa2-4acf-a0f3-b1fe304bbd86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Appointment\",\r\n \"id\": \"{{appointmentId}}\",\r\n \"identifier\": [\r\n {\r\n \"use\": \"official\",\r\n \"system\": \"http://fhir.HE.com/MIK/R4/Appointment/id\",\r\n \"value\": \"DemoTermin\",\r\n \"assigner\": {\r\n \"reference\": \"Organization/DEMO\"\r\n }\r\n }\r\n ],\r\n \"status\": \"proposed\",\r\n \"serviceType\": [\r\n {\r\n \"coding\": [\r\n {\r\n \"system\": \"urn:oid:2.16.756.5.30.1.279.4.1.10\",\r\n \"code\": \"OP\",\r\n \"display\": \"OP\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"description\": \"DemoTermin\",\r\n \"start\": \"2023-01-28T00:00:20+00:00\",\r\n \"end\": \"2023-01-28T00:00:20+00:00\",\r\n \"participant\": [\r\n {\r\n \"actor\": {\r\n \"reference\": \"Patient/1e73581b-cc65-4505-90f5-8b833e452f85\",\r\n \"display\": \"Testpatient\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Appointment/{{appointmentId}}","description":"This variant sends a minimally configured appointment to the heyPatient user.
Mandatory information includes:
The appointment is displayed in the timeline of the app:
\nThis variant sends a completely configured appointment to the heyPatient user.
Additional information includes:
This API query group allows the HCP to send an appointment proposal to the heyPatient app of the referenced heyPatient user, to be displayed on the app timeline and to be confirmed in the heyPatient app.
\nDepending on the configuration of the appointment type in the HCP portal, additional information is displayed, and appointment-specific tasks, location information and navigation guidance are provided.
\n","_postman_id":"e6e917de-da4a-45da-9e58-1dca4addb5dc"},{"name":"Basic Task Management","item":[{"name":"Send simple sublimd form task","id":"b21d5671-5e36-4de6-bb5c-90107e6ef132","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Task\",\r\n \"id\": \"{{taskId}}\",\r\n \"identifier\": [\r\n {\r\n \"system\": \"http://fhir.heypatient.com/valuesets/sublimd-form-id\",\r\n \"value\": \"{{organizationId}}.{{caseId}}.{{taskType}}.{{versionNr}}\"\r\n }\r\n ],\r\n \"status\": \"ready\",\r\n \"intent\": \"order\",\r\n \"description\": \"Bitte Anästhesieformular ausfüllen\",\r\n \"owner\": {\r\n \"reference\": \"Patient/{{patientId}}\"\r\n },\r\n \"input\": [\r\n {\r\n \"type\": {\r\n \"text\": \"https://www.sublimd.com/app/login/token?organizationId={{organizationId}}&secret=4b5af60598a2&loginToken={{patientToken}}\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Task/{{taskId}}","description":"The following API call sends a task to fill a preparative form to a patient.
The identifier segment contaions information about the type of task to be performed by the heyPatient user.
The URL reference to the form is provided in the \"input\" element of the task.
The task is displayed in the users inbox:
\nOptional information to be added to more enhanced tasks comprise:
\nTasks tthat are connected to certain appontments can be issued within the heyPatient environment.
Tasks that are not dependent on given events can be sent to heyPatient users using a task message.
The patient is referenced as the task owner in the messages.
Query to the sublimd API for the patient credentials to be able to automatically generate and present the URL for a predefined appointment-related task
\n","urlObject":{"protocol":"https","port":"9443","path":["api","v1","patients","access-tokens"],"host":["{{sublimdEndpoint}}"],"query":[{"key":"externalId","value":"{{localFID}}"},{"key":"locationId","value":"{{taskType}}"},{"key":"userProfileId","value":"generalPatientInternet"}],"variable":[]}},"response":[],"_postman_id":"4e8b722a-0fa4-4d2c-a8bb-24156b39e6a4"},{"name":"Get Patient form from URL","id":"dc3b5628-234f-43ee-9a30-05484a1dd85f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{sublimdEndpoint}}/app/login/token?organizationId={{organizationId}}&secret={{organizationSecret}}&loginToken={{patientToken}}","description":"This URL represents the automatic composition of the sublimd form URL to be accessed from the heyPatient app via embedded iframe or external browser.
\n","urlObject":{"protocol":"https","path":["app","login","token"],"host":["{{sublimdEndpoint}}"],"query":[{"key":"organizationId","value":"{{organizationId}}"},{"key":"secret","value":"{{organizationSecret}}"},{"key":"loginToken","value":"{{patientToken}}"}],"variable":[]}},"response":[],"_postman_id":"dc3b5628-234f-43ee-9a30-05484a1dd85f"}],"id":"dcf76402-c246-4326-b366-0f4ad2185d65","description":"The queries in this group describe functionality implemented in the heyPatient system to obtain authorisation information from the sublimd API to automatically assemble form reference URLs for forms that are connected to appointments.
\n","_postman_id":"dcf76402-c246-4326-b366-0f4ad2185d65"},{"name":"Basic Document Transfer","item":[{"name":"Send simple document","id":"5e41f8c2-c8a4-4367-aee2-80c5b2d3d87b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"DocumentReference\",\r\n \"id\": \"{{docrefId}}\",\r\n \"status\": \"current\",\r\n \"category\": [\r\n {\r\n \"coding\": [\r\n {\r\n \"system\": \"http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.classCode\",\r\n \"code\": \"405624007\",\r\n \"display\": \"Administratives Dokument\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"subject\": {\r\n \"reference\": \"Patient/{{patientId}}\"\r\n },\r\n \"date\": \"2005-12-24T09:43:41+11:00\",\r\n \"description\": \"Rechnungskopie für FID 20012345\",\r\n \"content\": [\r\n {\r\n \"attachment\": {\r\n \"contentType\": \"application/pdf\",\r\n \"data\": \"JVBERi0xLjUNJeLjz9MNCjEwIDAgb2JqDTw8L0xpbmVhcml6ZWQgMS9MIDEzMDA2OC9PIDEyL0UgMTI1NzM1L04gMS9UIDEyOTc2NC9IIFsgNTQ2IDIwNF0+Pg1lbmRvYmoNICAgICAgICAgICAgICAgMSAzIDFdPj5zdHJlYW0NCmjeYmIAASZGxtfqDExAVhuI5FsIZveCSEYuoOx/NhmwCAMjiGT6DyIZGQACDACdPgUbDQplbmRzdHJlYW0NZW5kb2JqDXN0YXJ0eHJlZg0KMTE2DQolJUVPRg0K\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/DocumentReference/{{docrefId}}","description":"This request uploads a simple pdf document in base64 encoding, with only basic information about the recipient and the document title.
\n","urlObject":{"protocol":"https","path":["DocumentReference","{{docrefId}}"],"host":["heypatienthdsstaging-demo","fhir","azurehealthcareapis","com"],"query":[],"variable":[]}},"response":[{"id":"80d35be1-9fdc-4254-9f14-5b6350e5e134","name":"Send simple document","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"DocumentReference\",\r\n \"id\": \"{{docrefId}}\",\r\n \"status\": \"current\",\r\n \"category\": [\r\n {\r\n \"coding\": [\r\n {\r\n \"system\": \"http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.classCode\",\r\n \"code\": \"405624007\",\r\n \"display\": \"Administratives Dokument\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"subject\": {\r\n \"reference\": \"Patient/{{patientId}}\"\r\n },\r\n \"date\": \"2005-12-24T09:43:41+11:00\",\r\n \"description\": \"Rechnungskopie für FID 20012345\",\r\n \"content\": [\r\n {\r\n \"attachment\": {\r\n \"contentType\": \"application/pdf\",\r\n \"data\": \"JVBERi0xLjUNJeLjz9MNCjEwIDAgb2JqDTw8L0xpbmVhcml6ZWQgMS9MIDEzMDA2OC9PIDEyL0UgMTI1NzM1L04gMS9UIDEyOTc2NC9IIFsgNTQ2IDIwNF0+Pg1lbmRvYmoNICAgICAgICAgICAgICAgMSAzIDFdPj5zdHJlYW0NCmjeYmIAASZGxtfqDExAVhuI5FsIZveCSEYuoOx/NhmwCAMjiGT6DyIZGQACDACdPgUbDQplbmRzdHJlYW0NZW5kb2JqDXN0YXJ0eHJlZg0KMTE2DQolJUVPRg0K\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/DocumentReference/{{docrefId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/fhir+json; charset=utf-8"},{"key":"Date","value":"Thu, 30 Mar 2023 13:22:16 GMT"},{"key":"Server","value":"Kestrel"},{"key":"ETag","value":"W/\"14\""},{"key":"Last-Modified","value":"Thu, 30 Mar 2023 13:22:17 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-Request-ID","value":"d7269dce24c5d82392cb9bd7da7adc54"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Security-Policy","value":"frame-src 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"resourceType\": \"DocumentReference\",\n \"id\": \"document001\",\n \"meta\": {\n \"versionId\": \"14\",\n \"lastUpdated\": \"2023-03-30T13:22:17.227+00:00\"\n },\n \"status\": \"current\",\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.classCode\",\n \"code\": \"405624007\",\n \"display\": \"Administratives Dokument\"\n }\n ]\n }\n ],\n \"subject\": {\n \"reference\": \"Patient/a8d731a6-d638-4781-a8b0-7a6cfa323f7b\"\n },\n \"date\": \"2005-12-24T09:43:41+11:00\",\n \"description\": \"Rechnungskopie für FID 20012345\",\n \"content\": [\n {\n \"attachment\": {\n \"contentType\": \"application/pdf\",\n \"data\": \"JVBERi0xLjUNJeLjz9MNCjEwIDAgb2JqDTw8L0xpbmVhcml6ZWQgMS9MIDEzMDA2OC9PIDEyL0UgMTI1NzM1L04gMS9UIDEyOTc2NC9IIFsgNTQ2IDIwNF0+Pg1lbmRvYmoNICAgICAgICAgICAgICAgMSAzIDFdPj5zdHJlYW0NCmjeYmIAASZGxtfqDExAVhuI5FsIZveCSEYuoOx/NhmwCAMjiGT6DyIZGQACDACdPgUbDQplbmRzdHJlYW0NZW5kb2JqDXN0YXJ0eHJlZg0KMTE2DQolJUVPRg0K\"\n }\n }\n ]\n}"}],"_postman_id":"5e41f8c2-c8a4-4367-aee2-80c5b2d3d87b"},{"name":"Send enhanced DocumentReference","id":"edf57ce6-5c2c-4485-97ba-162d776ae491","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"DocumentReference\",\r\n \"id\": \"{{docrefId}}\",\r\n \"status\": \"current\",\r\n \"type\": {\r\n \"coding\": [\r\n {\r\n \"system\": \"http://fhir.heypatient.com/valuesets/spz/documentType\",\r\n \"code\": \"invoice\",\r\n \"display\": \"Rechnungskopie\"\r\n }\r\n ]\r\n },\r\n \"category\": [\r\n {\r\n \"coding\": [\r\n {\r\n \"system\": \"http://fhir.heypatient.com/valuesets/spz/documentCategory\",\r\n \"code\": \"AdminDoc\",\r\n \"display\": \"Administratives Dokument\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"subject\": {\r\n \"reference\": \"Patient/{{patientId}}\"\r\n },\r\n \"date\": \"2005-12-24T09:43:41+11:00\",\r\n \"description\": \"Rechnungskopie für FID 20012345\",\r\n \"content\": [\r\n {\r\n \"attachment\": {\r\n \"contentType\": \"application/pdf\",\r\n \"data\": \"JVBERi0xLjUNJeLjz9MNCjEwIDAgb2JqDTw8L0xpbmVhcml6ZWQgMS9MIDEzMDA2OC9PIDEyL0UgMTI1NzM1L04gMS9UIDEyOTc2NC9IIFsgNTQ2IDIwNF0+Pg1lbmRvYmoNICAgICAgICAgICAgICAgMSAzIDFdPj5zdHJlYW0NCmjeYmIAASZGxtfqDExAVhuI5FsIZveCSEYuoOx/NhmwCAMjiGT6DyIZGQACDACdPgUbDQplbmRzdHJlYW0NZW5kb2JqDXN0YXJ0eHJlZg0KMTE2DQolJUVPRg0K\"\r\n }\r\n }\r\n ],\r\n \"context\": {\r\n \"encounter\": [\r\n {\r\n \"reference\": \"Encounter/{{localFid}}\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/DocumentReference/{{docrefId}}","description":"This request uploads a pdf document in base64 encoding, with additional information about document type and category, as well as an option to include the local patient case identifier (FID).
\n","urlObject":{"protocol":"https","path":["DocumentReference","{{docrefId}}"],"host":["heypatienthdsstaging-demo","fhir","azurehealthcareapis","com"],"query":[],"variable":[]}},"response":[{"id":"d5d16636-2ab3-4a5e-beef-aab172099d79","name":"Send enhanced DocumentReference","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"DocumentReference\",\r\n \"id\": \"{{docrefId}}\",\r\n \"status\": \"current\",\r\n \"type\": {\r\n \"coding\": [\r\n {\r\n \"system\": \"http://fhir.heypatient.com/valuesets/spz/documentType\",\r\n \"code\": \"Patientenfaktura\",\r\n \"display\": \"Patientenfaktura\"\r\n }\r\n ]\r\n },\r\n \"category\": [\r\n {\r\n \"coding\": [\r\n {\r\n \"system\": \"http://fhir.heypatient.com/valuesets/spz/documentCategory\",\r\n \"code\": \"AdministrativesDokument\",\r\n \"display\": \"Administratives Dokument\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"subject\": {\r\n \"reference\": \"Patient/{{patientId}}\"\r\n },\r\n \"date\": \"2005-12-24T09:43:41+11:00\",\r\n \"description\": \"Rechnungskopie für FID 20012345\",\r\n \"content\": [\r\n {\r\n \"attachment\": {\r\n \"contentType\": \"application/pdf\",\r\n \"data\": \"JVBERi0xLjUNJeLjz9MNCjEwIDAgb2JqDTw8L0xpbmVhcml6ZWQgMS9MIDEzMDA2OC9PIDEyL0UgMTI1NzM1L04gMS9UIDEyOTc2NC9IIFsgNTQ2IDIwNF0+Pg1lbmRvYmoNICAgICAgICAgICAgICAgMSAzIDFdPj5zdHJlYW0NCmjeYmIAASZGxtfqDExAVhuI5FsIZveCSEYuoOx/NhmwCAMjiGT6DyIZGQACDACdPgUbDQplbmRzdHJlYW0NZW5kb2JqDXN0YXJ0eHJlZg0KMTE2DQolJUVPRg0K\"\r\n }\r\n }\r\n ],\r\n \"context\": {\r\n \"encounter\": [\r\n {\r\n \"reference\": \"Encounter/{{localFid}}\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/DocumentReference/{{docrefId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/fhir+json; charset=utf-8"},{"key":"Date","value":"Fri, 31 Mar 2023 08:25:19 GMT"},{"key":"Server","value":"Kestrel"},{"key":"ETag","value":"W/\"2\""},{"key":"Last-Modified","value":"Fri, 31 Mar 2023 08:25:20 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-Request-ID","value":"f9f09a97ca20063ad2128dbc9ab30624"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Security-Policy","value":"frame-src 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"resourceType\": \"DocumentReference\",\n \"id\": \"document002\",\n \"meta\": {\n \"versionId\": \"2\",\n \"lastUpdated\": \"2023-03-31T08:25:20.123+00:00\"\n },\n \"status\": \"current\",\n \"type\": {\n \"coding\": [\n {\n \"system\": \"http://fhir.heypatient.com/valuesets/spz/documentType\",\n \"code\": \"Patientenfaktura\",\n \"display\": \"Patientenfaktura\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"http://fhir.heypatient.com/valuesets/spz/documentCategory\",\n \"code\": \"AdministrativesDokument\",\n \"display\": \"Administratives Dokument\"\n }\n ]\n }\n ],\n \"subject\": {\n \"reference\": \"Patient/a8d731a6-d638-4781-a8b0-7a6cfa323f7b\"\n },\n \"date\": \"2005-12-24T09:43:41+11:00\",\n \"description\": \"Rechnungskopie für FID 20012345\",\n \"content\": [\n {\n \"attachment\": {\n \"contentType\": \"application/pdf\",\n \"data\": \"JVBERi0xLjUNJeLjz9MNCjEwIDAgb2JqDTw8L0xpbmVhcml6ZWQgMS9MIDEzMDA2OC9PIDEyL0UgMTI1NzM1L04gMS9UIDEyOTc2NC9IIFsgNTQ2IDIwNF0+Pg1lbmRvYmoNICAgICAgICAgICAgICAgMSAzIDFdPj5zdHJlYW0NCmjeYmIAASZGxtfqDExAVhuI5FsIZveCSEYuoOx/NhmwCAMjiGT6DyIZGQACDACdPgUbDQplbmRzdHJlYW0NZW5kb2JqDXN0YXJ0eHJlZg0KMTE2DQolJUVPRg0K\"\n }\n }\n ],\n \"context\": {\n \"encounter\": [\n {\n \"reference\": \"Encounter/1077729\"\n }\n ]\n }\n}"}],"_postman_id":"edf57ce6-5c2c-4485-97ba-162d776ae491"}],"id":"2d70bb21-63e9-4b64-994b-6f00bd20372a","_postman_id":"2d70bb21-63e9-4b64-994b-6f00bd20372a","description":""},{"name":"Basic Encounter management","item":[{"name":"Get Encounters with unassigned local FID","id":"26e22bf8-eed8-4d04-a7dd-e7fa1db7a691","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Encounter?identifier=http://fhir.heypatient.com/ig/identifier/DEMO/localFID|unassigned","description":"This request queries for admission requests that have not been processed by the patient admin system and have not been assigned an appropriate local FID value.
\n","urlObject":{"protocol":"https","path":["Encounter"],"host":["heypatienthdsstaging-demo","fhir","azurehealthcareapis","com"],"query":[{"key":"identifier","value":"http://fhir.heypatient.com/ig/identifier/DEMO/localFID|unassigned"}],"variable":[]}},"response":[],"_postman_id":"26e22bf8-eed8-4d04-a7dd-e7fa1db7a691"},{"name":"Get Encounter to add local FID Copy","id":"6fc7e8c3-5d24-4de8-b7f6-187f715bd7f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Encounter\",\r\n \"id\": \"{{encounterId}}\",\r\n \"extension\": [\r\n {\r\n \"url\": \"http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-desiredaccommodation\",\r\n \"valueCoding\": {\r\n \"system\": \"http://fhir.ch/ig/ch-core/CodeSystem/bfs-medstats-21-encountertype\",\r\n \"code\": \"privat\",\r\n \"display\": \"Premium Gold\"\r\n }\r\n }\r\n ],\r\n \"identifier\": [\r\n {\r\n \"use\": \"official\",\r\n \"system\": \"http://fhir.heypatient.com/ig/identifier/DEMO/EncounterId\",\r\n \"value\": \"{{encounterId}}}\"\r\n },\r\n {\r\n \"use\": \"official\",\r\n \"system\": \"http://fhir.heypatient.com/ig/identifier/DEMO/localFID\",\r\n \"value\": \"123456789\"\r\n }\r\n ],\r\n \"status\": \"planned\",\r\n \"class\": {\r\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\r\n \"code\": \"AMB\",\r\n \"display\": \"ambulatory\"\r\n },\r\n \"subject\": {\r\n \"reference\": \"Patient/2206e649-2bed-421c-b4ab-6f95a73d1fa0\",\r\n \"display\": \"Heidi Demopatient\"\r\n },\r\n \"serviceProvider\": {\r\n \"reference\": \"Organization/DEMO\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://heypatienthdsstaging-demo.fhir.azurehealthcareapis.com/Encounter/{{encounterId}}","description":"This message assigns a local FID to the previously received Encounter info accompanying an admission request.
\n","urlObject":{"protocol":"https","path":["Encounter","{{encounterId}}"],"host":["heypatienthdsstaging-demo","fhir","azurehealthcareapis","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6fc7e8c3-5d24-4de8-b7f6-187f715bd7f0"}],"id":"a83ced74-2458-4d4c-a6b8-fa0e1a9860f8","description":"The Encounter resource has been added to the primary Patient resource to support exchange of case-specific attributes, such as local FID and other treatment-specific administrative options.
\nInitially Encounter messages are used for internal representation of admission requests.
However, the overall purpose is to communicate case specific information to connected patient administration systems, and to receive information about the partner system's corresponding local FID in the updated \"identifier/system/...EncounterId\" element.
The heypatient user to be informed is referenced using the corresponding Patient resourceId in the element \"subject/reference/Patient/...\"
\n","urlObject":{"protocol":"https","path":["Communication","Testcommunication01"],"host":["heypatienthdsstaging-demo","fhir","azurehealthcareapis","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"57c69816-f780-4fae-bd94-4a25a21687bf"}],"id":"8eb3418e-bcc4-4322-a57e-3610b3415e2d","description":"To send information that is not connected to an admission, appointment or other superior item the \"Communication\" resource can be used. Currently the transmission of simple text messages in the \"payload\" section of a Communication resource is supported.
\n","_postman_id":"8eb3418e-bcc4-4322-a57e-3610b3415e2d"}]}