{"info":{"_postman_id":"98c51f0e-830c-40e7-bb5c-be53e314c500","name":"Bingli documentation","description":"<html><head></head><body><p>Welcome to the Bingli API Integration Guide.</p>\n<p>This document is designed to provide a comprehensive guide for individuals and organizations seeking to integrate with Bingli's advanced API services. Bingli offers a seamless and efficient way for healthcare providers and systems to enhance patient engagement and streamline medical consultations through digital surveys and patient information management</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"12052645","collectionId":"98c51f0e-830c-40e7-bb5c-be53e314c500","publishedId":"2s9YeK2pZv","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-04-24T14:52:04.000Z"},"item":[{"name":"API","item":[{"name":"Authentication","item":[{"name":"Fetch bearer token","id":"a34020e2-e2ec-4244-9516-1c735bdd917c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"credentialType\": 10,\n  \"account\": \"<EMAIL>\",\n  \"credential\": \"<PASSWORD>\",\n  \"tenantId\": \"<TENANTID>\"\n}","options":{"raw":{"language":"json"}}},"url":"https://boss.api.bingli.eu/security-api/token","description":"<h4 id=\"description\">Description</h4>\n<p>This endpoint is used for authentication, allowing a system to obtain a token by providing their account credentials. The token is required for subsequent API requests that need authentication.</p>\n<h4 id=\"request\">Request</h4>\n<ul>\n<li><p><strong>credentialType</strong>: An integer representing the type of credential, e.g., <code>10</code>. is password</p>\n</li>\n<li><p><strong>account</strong>: The email address. Replace with the actual email.</p>\n</li>\n<li><p><strong>credential</strong>: The password. Replace with the actual password.</p>\n</li>\n<li><p><strong>tenantId</strong>: The tenant ID retreived from the Bingli system. Replace with the actual tenant ID.</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["security-api","token"],"host":["boss","api","bingli","eu"],"query":[],"variable":[]}},"response":[{"id":"203c8a80-f714-43f8-85d0-1b96cadf676e","name":"Success JWT","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"credentialType\": 10,\n  \"account\": <EMAIL>,\n  \"credential\": <PASSWORD>,\n  \"tenantId\": <TENANTID>\n}","options":{"raw":{"language":"json"}}},"url":"https://boss.api.bingli.eu/security-api/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 23 May 2023 09:45:23 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Request-Context","value":"appId=cid-v1:5f968d63-16b7-4b62-80da-910bf8dc4f4e"}],"cookie":[],"responseTime":null,"body":"{\n    \"data\": {\n        \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJCaW5nbGkiLCJpYXQiOiIxNjg0ODM1MTIzLjU5ODA3MjgiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IldpemFyZCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJXaXphcmQiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9lbWFpbGFkZHJlc3MiOiJXaXphcmQiLCJVc2VySWQiOiIwOTY0NWMwNC1lZjRmLTQwMDQtYWQ4MS0xZTA1OTM4NTA2MTkiLCJVc2VyUmlnaHRzIjoiMDEwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMTAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwIiwiVGVuYW50SWQiOiIiLCJIZWFsdGhDYXJlU2VydmljZUlkIjoiIiwiQ2xpZW50SWQiOiJCaW5nbGlVbml2ZXJzZSIsImV4cCI6MTY4NDg3ODMyMywiaXNzIjoiaHR0cHM6Ly9hcHAtYm9zcy10ZXN0LmF6dXJld2Vic2l0ZXMubmV0IiwiYXVkIjoiTXlCaW5nbGkifQ.Ob95u_0cA_cwoM5_h_JDbyaTJUo2ujIYYJROewarY7Q\",\n        \"refreshToken\": \"IuTLeBgFB3IxnZPmpsVP0KtK5grlsuLWNSwBtmeTRVIQf12BxsTZdGuYOzRyIfjvvTsKCOzyYWKXrtbMNvZLA\"\n    },\n    \"responseType\": 200,\n    \"responseMessages\": [\n        \"Sucessfully created Bingli.Core.Data.Security.JwtToken\"\n    ]\n}"}],"_postman_id":"a34020e2-e2ec-4244-9516-1c735bdd917c"}],"id":"164326a3-26e1-4190-bca0-126588de34e7","description":"<h2 id=\"how-to-start-with-this-document\">How to start with this document?</h2>\n<p>The best way to start with this integration is by clicking the right top and selecting \"Run in postman\", this makes a clone of the complete collection where you should only adapt the values.</p>\n<h3 id=\"key-parameters-overview\">Key Parameters Overview</h3>\n<p>Integrating with the Bingli API involves a series of parameters that must be correctly configured to ensure a successful and seamless integration. This section provides an overview of all the essential parameters you will need to set up and utilize the Bingli API effectively.</p>\n<h2 id=\"essential-parameters-for-integration\">Essential Parameters for Integration</h2>\n<ol>\n<li><strong>Tenant Reference (Tenant_ID):</strong><ul>\n<li>Description: A unique identifier provided by Bingli for each tenant.</li>\n<li>Usage: Used in API requests to link the data to the specific tenant.</li>\n<li>Example: <code>3955a7c5-5804-4bab-bfb0-c1aac4f12f5a</code></li>\n</ul>\n</li>\n<li><strong>User/password:</strong><ul>\n<li>Description: A user account with password for request a valid JWT token</li>\n<li>Usage: Required for authentication in API requests.</li>\n</ul>\n</li>\n<li><strong>Healthcare Service ID (HCS_ID):</strong><ul>\n<li>Description: A unique identifier for each healthcare service or category provided by an organization.</li>\n<li>Usage: Used to specify the particular service in API requests.</li>\n<li>Note: This is unique per tenant</li>\n</ul>\n</li>\n</ol>\n","_postman_id":"164326a3-26e1-4190-bca0-126588de34e7"},{"name":"Patient","item":[{"name":"Create patient","id":"6184e91f-3c62-448d-a6e4-569af8cad993","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/fhir+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"resourceType\": \"Patient\",\r\n    \"id\": \"<YOUR-PATIENT-ID>\", // add identifier that your organization understand eg patient_zero\r\n    \"communication\":[{\"language\":{\r\n        \"coding\":[{\r\n            \"system\": \"http://hl7.org/fhir/ValueSet/languages\",\r\n            \"code\": \"<PATIENT-LANGUAGE>\"\r\n            }]\r\n        }}],\r\n    \"identifier\": [\r\n        {\r\n            \"system\": \"http://rrn.fgov.be/be-rrn\",\r\n            \"value\": \"<PATIENT-RRN>\"\r\n        },\r\n        {\r\n            \"system\": \"https://fhir.tenant.com/ns/hospital-patient-number\",\r\n            \"value\": \"<PATIENT-HOSPITAL-NR>\"\r\n        }\r\n    ], //provide additional identifiers if possible\r\n    \"name\": [\r\n        {\r\n            \"family\": \"<PATIENT-FAMILY-NAME>\", //required\r\n            \"given\": [\r\n                \"<PATIENT-GIVEN-NAME>\"\r\n            ]\r\n        }\r\n    ],\r\n    \"telecom\": [\r\n        {\r\n            \"system\": \"email\",\r\n            \"value\": \"<PATIENT-EMAIL>\" //required\r\n        },\r\n        {\r\n            \"system\": \"sms\",\r\n            \"value\": \"<PATIENT-SMS>\" //required\r\n        }\r\n    ],\r\n    \"gender\": \"<PATIENT-GENDER>\", //required male or female,\r\n    \"birthDate\": \"<PATIENT-BIRTHDAY>\" // required YYYY-MM-DD\r\n}","options":{"raw":{"language":"json"}}},"url":"https://fhir-gateway.api.bingli.eu/tenant-api/patient","description":"<blockquote>\n<p>_Because we are following the FHIR standard, please put following line in the headers:_<em>Content-Type: application/fhir+json</em> </p>\n</blockquote>\n<h4 id=\"description\">Description</h4>\n<p>This endpoint is used for creating a link between a patient in the bingli universe and how the patient is recognized in the tenant's system. If the patient does not exist, a patient will be created in the bingli universe.</p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>The request body should contain a JSON object with the following fields:</p>\n<ul>\n<li><p><strong>resourceType</strong>: Must be <code>\"Patient\"</code> to indicate the type of the resource.</p>\n</li>\n<li><p><strong>id</strong>: A unique identifier for the patient. Preferably, this should be a guid representing the patient in your system, otherwise, use a random GUID.</p>\n</li>\n<li><p><strong>language</strong>: The language code representing the patient's preferred language, such as <code>\"nl-BE\"</code> for Dutch as spoken in Belgium.</p>\n<ul>\n<li>Possible language codes:<ul>\n<li><p>\"hi-in\": Hindi as spoken in India</p>\n</li>\n<li><p>\"cr-hr\": Croatian as spoken in Croatia</p>\n</li>\n<li><p>\"ar-ma\": Arabic as spoken in Morocco</p>\n</li>\n<li><p>\"es-es\": Spanish as spoken in Spain</p>\n</li>\n<li><p>\"ro-ro\": Romanian as spoken in Romania</p>\n</li>\n<li><p>\"pt-pt\": Portuguese as spoken in Portugal</p>\n</li>\n<li><p>\"ur-pk\": Urdu as spoken in Pakistan</p>\n</li>\n<li><p>\"pl-pl\": Polish as spoken in Poland</p>\n</li>\n<li><p>\"en-gb\": English as spoken in Great Britain</p>\n</li>\n<li><p>\"de-de\": German as spoken in Germany</p>\n</li>\n<li><p>\"nl-be\": Dutch as spoken in Belgium</p>\n</li>\n<li><p>\"fr-fr\": French as spoken in France</p>\n</li>\n<li><p>\"uk-au\": English as spoken in Australia (Typically represented as \"en-au\")</p>\n</li>\n<li><p>\"tc-cn\": Traditional Chinese as spoken in China</p>\n</li>\n<li><p>\"en-us\": English as spoken in the United States</p>\n</li>\n<li><p>\"fr-be\": French as spoken in Belgium</p>\n</li>\n<li><p>\"nl-nl\": Dutch as spoken in the Netherlands</p>\n</li>\n<li><p>\"tr-tr\": Turkish as spoken in Turkey</p>\n</li>\n<li><p>\"it-it\": Italian as spoken in Italy</p>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n<li><p><strong>identifier</strong>: An array of objects, that can contain identifiers for the patient, we gave 2 examples in our body, representing rrn and the patientID that represents how the patient is known in your system:</p>\n<ul>\n<li><p><strong>system</strong>: A URL that identifies the system that the identifier belongs to. Example systems include <code>\"http://rrn.fgov.be/be-rrn\"</code> for the Belgian National Registry Number and <code>\"https://fhir.tenant.com/ns/hospital-patient-number\"</code> for a hospital-specific patient number.</p>\n</li>\n<li><p><strong>value</strong>: The actual identifier value, such as <code>\"RRN\"</code> or <code>\"HOSPITALNR\"</code>.</p>\n</li>\n</ul>\n</li>\n<li><p><strong>name</strong>: An array containing objects with the patient's name information. Each object includes:</p>\n<ul>\n<li><p><strong>family</strong>: The family or last name of the patient, e.g., <code>\"Rousseau\"</code>.</p>\n</li>\n<li><p><strong>given</strong>: An array of given names, e.g., <code>[\"Francis\"]</code>.</p>\n</li>\n</ul>\n</li>\n<li><p><strong>telecom</strong>: An array of objects each specifying a contact point. Each object includes:</p>\n<ul>\n<li><p><strong>system</strong>: The type of contact point, <code>\"email\"</code> AND <code>\"sms\"</code>. Both are required.</p>\n</li>\n<li><p><strong>value</strong>: The contact detail, such as an email address or phone number, use international phone number standards, +32xxxx</p>\n</li>\n</ul>\n</li>\n<li><p><strong>gender</strong>: The patient's gender, <code>\"male\" or \"female\"</code>.</p>\n</li>\n<li><p><strong>birthDate</strong>: The patient's date of birth in the format <code>\"YYYY-MM-DD\"</code>, e.g., <code>\"2000-01-01\"</code>.</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["tenant-api","patient"],"host":["fhir-gateway","api","bingli","eu"],"query":[],"variable":[]}},"response":[{"id":"f46a1f2d-8de0-47c8-b4de-70764f290348","name":"Create patient","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/fhir+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"resourceType\": \"Patient\",\r\n    \"id\": \"1564103c-7821-4820-928b-72cc07db8580\",\r\n    \"language\": \"nl-BE\",\r\n    \"identifier\": [\r\n        {\r\n            \"system\": \"http://rrn.fgov.be/be-rrn\",\r\n            \"value\": \"RRN\"\r\n        },\r\n        {\r\n            \"system\": \"https://fhir.tenant.com/ns/hospital-patient-number\",\r\n            \"value\": \"HOSPITALNR\"\r\n        }\r\n    ],\r\n    \"name\": [\r\n        {\r\n            \"family\": \"Rousseau\",\r\n            \"given\": [\r\n                \"Francis\"\r\n            ]\r\n        }\r\n    ],\r\n    \"telecom\": [\r\n        {\r\n            \"system\": \"email\",\r\n            \"value\": \"frr@mybingli.com\"\r\n        },\r\n        {\r\n            \"system\": \"sms\",\r\n            \"value\": \"+32 471 810 697\"\r\n        }\r\n    ],\r\n    \"gender\": \"male\",\r\n    \"birthDate\": \"2000-01-01\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://fhir-gateway.api.bingli.eu/tenant-api/patient"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"623"},{"key":"Content-Type","value":"application/fhir+json"},{"key":"Date","value":"Mon, 04 Dec 2023 12:17:12 GMT"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n    \"resourceType\": \"Patient\",\n    \"id\": \"1564103c-7821-4820-928b-72cc07db8580\",\n    \"language\": \"nl-BE\",\n    \"identifier\": [\n        {\n            \"system\": \"http://rrn.fgov.be/be-rrn\",\n            \"value\": \"RRN\"\n        },\n        {\n            \"system\": \"https://fhir.tenant.com/ns/hospital-patient-number\",\n            \"value\": \"HOSPITALNR\"\n        }\n    ],\n    \"name\": [\n        {\n            \"family\": \"Rousseau\",\n            \"given\": [\n                \"Francis\"\n            ]\n        }\n    ],\n    \"telecom\": [\n        {\n            \"system\": \"email\",\n            \"value\": \"frr@mybingli.com\"\n        },\n        {\n            \"system\": \"sms\",\n            \"value\": \"+32 471 810 697\"\n        }\n    ],\n    \"gender\": \"male\",\n    \"birthDate\": \"2000-01-01\"\n}"}],"_postman_id":"6184e91f-3c62-448d-a6e4-569af8cad993"}],"id":"2f9cbfa4-f024-4eb3-ba52-8cf37fd7c19e","_postman_id":"2f9cbfa4-f024-4eb3-ba52-8cf37fd7c19e","description":""},{"name":"Organization","item":[{"name":"Create organization","id":"c2ed23b5-7a7c-4432-908c-08564c60cec3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/fhir+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"resourceType\": \"Organization\",\r\n    \"id\": \"<YOUR-ID-FOR-BINGLI>\",\r\n    \"identifier\": [\r\n        {\r\n            \"system\": \"http://fhirgateway.bingli.com/identifier/TenantId\",\r\n            \"value\": \"<TENANT-ID-FROM-BINGLI>\"\r\n        }\r\n    ],\r\n    \"name\": \"<YOUR-NAME-FOR-BINGLI-INTEGRATION>\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://fhir-gateway.api.bingli.eu/tenant-api/organization","description":"<blockquote>\n<p>_Because we are following the FHIR standard, please put following line in the headers:_<em>Content-Type: application/fhir+json</em> </p>\n</blockquote>\n<h4 id=\"description\">Description</h4>\n<p>This endpoint facilitates the link of a new organization between exchanging systems. It is designed to accept organization details in a structured JSON format and store them in the database.</p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>The request body should consist of a JSON object with the following key fields:</p>\n<ul>\n<li><strong>resourceType</strong>: Should always be <code>\"Organization\"</code> to specify the type of resource being created.</li>\n<li><strong>id</strong>: A unique identifier for the organization. It is advised that this is the GUID specifying Bingli in your system, if you don't have this, please specify a random GUID that you will use in next steps!</li>\n<li><strong>identifier</strong>: An array containing a list of identifiers for the organization. Each object in the array should have:<ul>\n<li><strong>system</strong>: A URL that uniquely identifies the type of identifier system used. For example, <code>\"http://fhirgateway.bingli.com/identifier/TenantId\"</code> is a requirement.</li>\n<li><strong>value</strong>: This should be the tenantID received from Bingli, like a UUID <code>\"809e3cd5-329b-4511-9300-48a3027ecb2b\"</code>.</li>\n</ul>\n</li>\n<li><strong>name</strong>: The name of the organization, such as <code>\"Bingli_Contoso\"</code>.</li>\n</ul>\n","urlObject":{"protocol":"https","path":["tenant-api","organization"],"host":["fhir-gateway","api","bingli","eu"],"query":[],"variable":[]}},"response":[{"id":"960e40b3-1b61-4eba-8dac-8456b295b925","name":"Create organisation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/fhir+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"resourceType\": \"Organization\",\r\n    \"id\": \"b5569958-2fd3-4050-834a-4ca18f0b2c58\",\r\n    \"identifier\": [\r\n        {\r\n            \"system\": \"http://fhirgateway.bingli.com/identifier/TenantId\",\r\n            \"value\": \"13e8e808-a082-4af2-b4b6-7ec63afc4432\"\r\n        }\r\n    ],\r\n    \"name\": \"MyTenant\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://fhir-gateway.api.bingli.eu/tenant-api/organization"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"264"},{"key":"Content-Type","value":"application/fhir+json"},{"key":"Date","value":"Mon, 04 Dec 2023 12:18:54 GMT"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n    \"resourceType\": \"Organization\",\n    \"id\": \"b5569958-2fd3-4050-834a-4ca18f0b2c58\",\n    \"identifier\": [\n        {\n            \"system\": \"http://fhirgateway.bingli.com/identifier/TenantId\",\n            \"value\": \"13e8e808-a082-4af2-b4b6-7ec63afc4432\"\n        }\n    ],\n    \"name\": \"MyTenant\"\n}"}],"_postman_id":"c2ed23b5-7a7c-4432-908c-08564c60cec3"}],"id":"e1362d39-c0bb-4e06-905d-23bd9387173a","_postman_id":"e1362d39-c0bb-4e06-905d-23bd9387173a","description":""},{"name":"Create survey","item":[{"name":"Create survey","id":"dd0f4c5b-586d-4c13-bb8b-d7c8af8890ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/fhir+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"resourceType\": \"Task\",\r\n    \"id\": \"<YOUR-SURVEY-ID>\",\r\n    \"status\": \"draft\",\r\n    \"intent\": \"unknown\",\r\n    \"code\": {\r\n        \"coding\": [\r\n            {\r\n                \"system\": \"http://fhirgateway.bingli.com/coding/task-type\",\r\n                \"code\": \"create-survey\"\r\n            }\r\n        ]\r\n    },\r\n    \"for\": {\r\n        \"reference\": \"patient/<PATIENT-ID-FROM-STEP-CREATE-PATIENT>\"\r\n    },\r\n    \"requester\": {\r\n        \"reference\": \"organization/<ORGANIZATION-ID-FROM-STEP-CREATE-ORGANIZATION>\"\r\n    },\r\n    \"input\": [\r\n        {\r\n            \"type\": {\r\n                \"coding\": [\r\n                    {\r\n                        \"system\": \"http://fhirgateway.bingli.com/coding/identifier\",\r\n                        \"code\": \"HealthCareServiceId\"\r\n                    }\r\n                ]\r\n            },\r\n            \"valueString\": \"<HEALTHCARESERVICE-ID-FROM-BINGLI>\"\r\n        }\r\n    ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://fhir-gateway.api.bingli.eu/tenant-api/task","description":"<blockquote>\n<p>_Because we are following the FHIR standard, please put following line in the headers:_<em>Content-Type: application/fhir+json</em> </p>\n</blockquote>\n<h4 id=\"description\">Description</h4>\n<p>This endpoint is for creating a new task, specifically for initiating tasks such as surveys related to patients and healthcare services. The task is defined by several parameters detailing its nature, target, and requester.</p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>The request body should be a JSON object with the following key fields:</p>\n<ul>\n<li><strong>resourceType</strong>: Should be <code>\"Task\"</code> to specify the type of resource being created.</li>\n<li><strong>id</strong>: A unique identifier for the task, it is recommended to put the ID of the survey in your system here. If you don't have this, specify a random GUID</li>\n<li><strong>status</strong>: The current status of the task, when creating a survey, this should be \"draft\"</li>\n<li><strong>intent</strong>: The intent of the task, should be <code>\"order\"</code>.</li>\n<li><strong>code</strong>: An object specifying the coding for the task type. It includes:<ul>\n<li><strong>coding</strong>: An array with objects detailing the coding system and code. For example, a system URL <code>\"http://fhirgateway.bingli.com/coding/task\"</code> and a code such as <code>\"create-survey\"</code>.</li>\n</ul>\n</li>\n<li><strong>for</strong>: An object pointing to the patient your created in a previous step, put the id here that you specified:<ul>\n<li><strong>reference</strong>: A reference to the related patient, e.g., <code>\"patient/GUID-STEP-PATIENT-CREATE\"</code>.</li>\n</ul>\n</li>\n<li><strong>requester</strong>: An object indicating who is requesting the task, this should be the ID you used for creating the organisation in a previous step:<ul>\n<li><strong>reference</strong>: A reference to the organization initiating the task, e.g., <code>\"organization/GUID-STEP-CREATE-ORGANISATION\"</code>.</li>\n</ul>\n</li>\n<li><strong>input</strong>: An array of input parameters for the task, each containing:<ul>\n<li><strong>type</strong>: Codeable concept for the healthcareService (leave as it is)</li>\n<li><strong>valueString</strong>: The ID for the healthcareService provided by Bingli</li>\n</ul>\n</li>\n<li>Optional inputs:<ul>\n<li><ol>\n<li>Send Invitation</li>\n</ol>\n<ul>\n<li>System: <a href=\"http://fhirgateway.bingli.com/coding/task-param\">http://fhirgateway.bingli.com/coding/task-param</a></li>\n<li>Code: SendInvitation</li>\n<li>Value: bool</li>\n</ul>\n</li>\n<li><ol>\n<li>Include pin in invitation</li>\n</ol>\n<ul>\n<li>System: <a href=\"http://fhirgateway.bingli.com/coding/task-param\">http://fhirgateway.bingli.com/coding/task-param</a></li>\n<li>Code: IncludePinInInvitation</li>\n<li>Value: bool</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["tenant-api","task"],"host":["fhir-gateway","api","bingli","eu"],"query":[],"variable":[]}},"response":[{"id":"d4d6f544-1bd9-4ec1-a9b4-6eeadddf64ff","name":"Create survey","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/fhir+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"resourceType\": \"Task\",\r\n    \"id\": \"survey-20240617095703\",\r\n    \"status\": \"draft\",\r\n    \"intent\": \"unknown\",\r\n    \"code\": {\r\n        \"coding\": [\r\n            {\r\n                \"system\": \"http://fhirgateway.bingli.com/coding/task-type\",\r\n                \"code\": \"create-survey\"\r\n            }\r\n        ]\r\n    },\r\n    \"for\": {\r\n        \"reference\": \"patient/FHIR-automated-test-20240617095702\"\r\n    },\r\n    \"requester\": {\r\n        \"reference\": \"organization/b5569958-2fd3-4050-834a-4ca18f0b2c58\"\r\n    },\r\n    \"input\": [\r\n        {\r\n            \"type\": {\r\n                \"coding\": [\r\n                    {\r\n                        \"system\": \"http://fhirgateway.bingli.com/coding/identifier\",\r\n                        \"code\": \"HealthCareServiceId\"\r\n                    }\r\n                ]\r\n            },\r\n            \"valueString\": \"3471edd9-a36d-4bd0-b07a-208c5d786d76\"\r\n        },\r\n        {\r\n            \"type\": {\r\n                \"coding\": [\r\n                    {\r\n                        \"system\": \"http://fhirgateway.bingli.com/coding/task-param\",\r\n                        \"code\": \"sendInvitation\"\r\n                    }\r\n                ]\r\n            },\r\n            \"valueBoolean\": false\r\n        },\r\n        {\r\n            \"type\": {\r\n                \"coding\": [\r\n                    {\r\n                        \"system\": \"http://fhirgateway.bingli.com/coding/task-param\",\r\n                        \"code\": \"IncludePinInUrl\"\r\n                    }\r\n                ]\r\n            },\r\n            \"valueBoolean\": true\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://fhir-gateway.api.bingli.eu/tenant-api/task"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 17 Jun 2024 08:02:00 GMT"},{"key":"Content-Type","value":"application/fhir+json"},{"key":"Content-Length","value":"2260"},{"key":"Connection","value":"keep-alive"},{"key":"server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n    \"resourceType\": \"Task\",\n    \"id\": \"survey-20240617095703\",\n    \"status\": \"accepted\",\n    \"intent\": \"unknown\",\n    \"code\": {\n        \"coding\": [\n            {\n                \"system\": \"http://fhirgateway.bingli.com/coding/task-type\",\n                \"code\": \"create-survey\"\n            }\n        ]\n    },\n    \"for\": {\n        \"reference\": \"patient/FHIR-automated-test-20240617095702\"\n    },\n    \"requester\": {\n        \"reference\": \"organization/b5569958-2fd3-4050-834a-4ca18f0b2c58\"\n    },\n    \"input\": [\n        {\n            \"type\": {\n                \"coding\": [\n                    {\n                        \"system\": \"http://fhirgateway.bingli.com/coding/identifier\",\n                        \"code\": \"HealthCareServiceId\"\n                    }\n                ]\n            },\n            \"valueString\": \"3471edd9-a36d-4bd0-b07a-208c5d786d76\"\n        },\n        {\n            \"type\": {\n                \"coding\": [\n                    {\n                        \"system\": \"http://fhirgateway.bingli.com/coding/task-param\",\n                        \"code\": \"sendInvitation\"\n                    }\n                ]\n            },\n            \"valueBoolean\": false\n        },\n        {\n            \"type\": {\n                \"coding\": [\n                    {\n                        \"system\": \"http://fhirgateway.bingli.com/coding/task-param\",\n                        \"code\": \"IncludePinInUrl\"\n                    }\n                ]\n            },\n            \"valueBoolean\": true\n        }\n    ],\n    \"output\": [\n        {\n            \"type\": {\n                \"coding\": [\n                    {\n                        \"system\": \"http://fhirgateway.bingli.com/coding/identifier\",\n                        \"code\": \"http://fhirgateway.bingli.com/identifier/SurveyId\"\n                    }\n                ]\n            },\n            \"valueString\": \"b0e5b49b-abef-431a-b763-c12a22b29fd7\"\n        },\n        {\n            \"type\": {\n                \"coding\": [\n                    {\n                        \"system\": \"http://fhirgateway.bingli.com/coding/task-param\",\n                        \"code\": \"SurveyUrl\"\n                    }\n                ]\n            },\n            \"valueString\": \"http://s.bingli.io/enwc9\"\n        },\n        {\n            \"type\": {\n                \"coding\": [\n                    {\n                        \"system\": \"http://fhirgateway.bingli.com/coding/task-param\",\n                        \"code\": \"SurveyPin\"\n                    }\n                ]\n            },\n            \"valueString\": \"06562\"\n        },\n        {\n            \"type\": {\n                \"coding\": [\n                    {\n                        \"system\": \"http://fhirgateway.bingli.com/coding/identifier\",\n                        \"code\": \"http://fhirgateway.bingli.com/identifier/PatientId\"\n                    }\n                ]\n            },\n            \"valueString\": \"a1e80bdb-ea75-43d2-b582-944f42df6b7f\"\n        }\n    ]\n}"}],"_postman_id":"dd0f4c5b-586d-4c13-bb8b-d7c8af8890ca"}],"id":"6c538987-89ef-4623-92c3-410d865db113","_postman_id":"6c538987-89ef-4623-92c3-410d865db113","description":""},{"name":"Questionnaire","item":[{"name":"Fetch questionnaire","id":"1c27ca45-87c1-4400-8281-e50dcc7d9054","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":false},"method":"GET","header":[],"url":"https://fhir-gateway.api.bingli.eu/tenant-api/questionnaire?identifier=http://fhirgateway.bingli.com/identifier/TaskId|<YOUR-TASK-ID>","description":"<p>This will return all questions asked in the survey</p>\n","urlObject":{"protocol":"https","path":["tenant-api","questionnaire"],"host":["fhir-gateway","api","bingli","eu"],"query":[{"key":"identifier","value":"http://fhirgateway.bingli.com/identifier/TaskId|<YOUR-TASK-ID>"}],"variable":[]}},"response":[],"_postman_id":"1c27ca45-87c1-4400-8281-e50dcc7d9054"},{"name":"Fetch questionnaireResponse","id":"034833a9-8e38-4173-8fa0-b9e147279ee1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/fhir+json","type":"text"}],"url":"https://fhir-gateway.api.bingli.eu/tenant-api/questionnaireResponse?identifier=http://fhirgateway.bingli.com/identifier/TaskId|<YOUR-TASK-ID>","description":"<p>This returns all answers for given survey</p>\n","urlObject":{"protocol":"https","path":["tenant-api","questionnaireResponse"],"host":["fhir-gateway","api","bingli","eu"],"query":[{"key":"identifier","value":"http://fhirgateway.bingli.com/identifier/TaskId|<YOUR-TASK-ID>"}],"variable":[]}},"response":[],"_postman_id":"034833a9-8e38-4173-8fa0-b9e147279ee1"}],"id":"52419404-da34-4d6c-9e28-6bc42a08f12c","_postman_id":"52419404-da34-4d6c-9e28-6bc42a08f12c","description":""}],"id":"98d0fcd7-2625-4400-babe-91248200930e","_postman_id":"98d0fcd7-2625-4400-babe-91248200930e","description":""},{"name":"Release notes","item":[{"name":"Release 06.05.2024","item":[],"id":"dfcece22-3b9f-4eb8-b54b-d9338cff51a4","description":"<ul>\n<li>Fix 1</li>\n<li>Fix 2</li>\n<li>Fix 3</li>\n</ul>\n","_postman_id":"dfcece22-3b9f-4eb8-b54b-d9338cff51a4"}],"id":"bbf9a58e-36f0-4d29-821b-12acd8a172ee","_postman_id":"bbf9a58e-36f0-4d29-821b-12acd8a172ee","description":""}],"event":[{"listen":"prerequest","script":{"id":"588b4a47-5c20-45f3-92eb-941598967fd0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0431cdaf-0abf-4a63-815d-afa3c0333962","type":"text/javascript","exec":[""]}}],"variable":[{"key":"patient_id","value":"patient_zero","type":"string"},{"key":"patient_language","value":"en-gb","type":"string"},{"key":"patient_RRN","value":"nummertje","type":"string"},{"key":"patient_hospitaal_nr","value":"nummertjetwee","type":"string"},{"key":"patient_family_name","value":"John","type":"string"},{"key":"patient_given_name_1","value":"Doe","type":"string"},{"key":"patient_email","value":"doeken@mygmail.com","type":"string"},{"key":"patient_sms","value":"0499000000","type":"string"},{"key":"patient_gender","value":"male","type":"string"},{"key":"patient_birthday","value":"2000/01/20","type":"string"}]}