{ "item": [ { "id": "26c8af43-d0a3-41b0-895b-10b4c16cf834", "name": "System", "description": { "content": "Health and connectivity checks", "type": "text/plain" }, "item": [ { "id": "32cd074d-a56d-4561-99cf-ac2ed239452a", "name": "Get Organisation Details", "request": { "name": "Get Organisation Details", "description": { "content": "Returns organisation-level details for the requesting practice, including its correspondence address.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "organisation-details" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/organisation-details" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "82b9339b-69eb-4132-bd38-ea71f1a05263", "name": "Details of the local organisation.", "originalRequest": { "url": { "path": [ "transactional-api", "organisation-details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"string\",\n \"shortName\": \"string\",\n \"emailAddress\": \"string\",\n \"telephoneNumber\": \"string\",\n \"odsCode\": \"string\",\n \"tenantId\": \"string\",\n \"correspondenceAddress\": {\n \"line1\": \"string\",\n \"line2\": \"string\",\n \"line3\": \"string\",\n \"locality\": \"string\",\n \"administrativeArea\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2168ea50-2c89-4d2d-bc60-d97359c88ef2", "name": "Ping", "request": { "name": "Ping", "description": { "content": "Connectivity and authentication check. Returns the calling application together with the requesting organisation and practitioner context.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "ping" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/ping" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4944850e-3203-4ce3-b183-73370c638b09", "name": "API is reachable and the caller is authenticated.", "originalRequest": { "url": { "path": [ "transactional-api", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\",\n \"timestamp\": \"1949-12-24T22:17:13.272Z\",\n \"application\": {\n \"identifier\": \"string\",\n \"name\": \"string\"\n },\n \"requestingOrganisation\": {},\n \"requestingPractitioner\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb650fe8-65f4-4084-b4ea-7f65243c7cb3", "name": "Terminology Versions", "request": { "name": "Terminology Versions", "description": { "content": "Returns the SNOMED CT and dm+d (NHS Dictionary of Medicines and Devices) terminology database versions currently loaded on this Medicus instance.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "terminology-versions" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/terminology-versions" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "82b5b3ae-8159-42f1-96e9-416a53f907d3", "name": "Currently loaded terminology database versions.", "originalRequest": { "url": { "path": [ "transactional-api", "terminology-versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"snomedCT\": \"42_3_0\",\n \"dmd\": \"7_1_0\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "aba12313-36d9-4239-947f-efddade59468", "name": "Patients", "description": { "content": "Find, match and read patients", "type": "text/plain" }, "item": [ { "id": "d582f596-322f-4956-b6fa-3187f613b37a", "name": "Find Patient", "request": { "name": "Find Patient", "description": { "content": "Free-text search for patients by name, NHS number, date of birth, or other demographics. Returns a list of matching patients.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "find-patient" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/find-patient" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"query\": \"Smith\",\n \"includeInactivePatients\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ec4f1dd4-ee6a-4911-b091-c0e0e97fee98", "name": "Matching patients.", "originalRequest": { "url": { "path": [ "transactional-api", "find-patient" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"Smith\",\n \"includeInactivePatients\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"patientId\": \"7c87ada2-1db8-1aea-26aa-ee63812a340a\",\n \"displayName\": \"string\",\n \"nhsNumber\": \"string\",\n \"dateOfBirth\": \"1947-05-27\",\n \"address\": {\n \"line1\": \"string\",\n \"line2\": \"string\",\n \"line3\": \"string\",\n \"locality\": \"string\",\n \"administrativeArea\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"string\"\n },\n \"genderIdentity\": \"string\",\n \"active\": true\n },\n {\n \"patientId\": \"ec859f77-b562-6082-4820-235f41b8f251\",\n \"displayName\": \"string\",\n \"nhsNumber\": \"string\",\n \"dateOfBirth\": \"1964-06-14\",\n \"address\": {\n \"line1\": \"string\",\n \"line2\": \"string\",\n \"line3\": \"string\",\n \"locality\": \"string\",\n \"administrativeArea\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"string\"\n },\n \"genderIdentity\": \"string\",\n \"active\": false\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7af64094-6a81-4ed8-8338-73e0b42f87d9", "name": "Validation error: `query` is missing.", "originalRequest": { "url": { "path": [ "transactional-api", "find-patient" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"Smith\",\n \"includeInactivePatients\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-query\",\n \"description\": \"No search query is specified\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "55eb0ccf-3903-4eae-8a87-5134910f9a03", "name": "Get Patient Demographics", "request": { "name": "Get Patient Demographics", "description": { "content": "Returns the demographic details for a single patient. Empty fields are omitted from the response.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "patient", ":patientId", "demographics" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a", "key": "patientId", "description": "(Required) Medicus patient identifier." }, { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/patient/:patientId/demographics" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "60aea61f-0e5f-4db6-8a35-2ad77e300e75", "name": "Patient demographics.", "originalRequest": { "url": { "path": [ "transactional-api", "patient", ":patientId", "demographics" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a", "key": "patientId", "description": "(Required) Medicus patient identifier." }, { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"patientId\": \"e2af7b0d-b4b8-f98b-84db-22deea414281\",\n \"officialName\": {\n \"prefix\": \"string\",\n \"givenName\": \"string\",\n \"middleNames\": \"string\",\n \"familyName\": \"string\",\n \"suffix\": \"string\"\n },\n \"homeAddress\": {\n \"line1\": \"string\",\n \"line2\": \"string\",\n \"line3\": \"string\",\n \"locality\": \"string\",\n \"administrativeArea\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"string\"\n },\n \"dateOfBirth\": \"1963-09-08\",\n \"gender\": \"string\",\n \"nhsNumber\": \"string\",\n \"homeTelephoneNumber\": \"string\",\n \"mobileTelephoneNumber\": \"string\",\n \"workTelephoneNumber\": \"string\",\n \"emailAddress\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85354a7a-4d1e-4700-8a87-62b1c81c2508", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "patient", ":patientId", "demographics" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a", "key": "patientId", "description": "(Required) Medicus patient identifier." }, { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-patient-id\",\n \"description\": \"The patientId is not a UUID\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77b7d1ba-266e-489c-943e-92ba59ed1995", "name": "Match Patient", "request": { "name": "Match Patient", "description": { "content": "Resolves a single patient from supplied demographics. Provide one of: NHS number; NHS number plus demographics (date of birth, family name, postcode) to verify; or date of birth plus given name and family name. Returns the matched patientId only when exactly one record matches.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "match-patient" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/match-patient" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"nhsNumber\": \"9990000018\",\n \"dateOfBirth\": \"1990-05-12\",\n \"givenName\": \"Jane\",\n \"familyName\": \"Smith\",\n \"postcode\": \"LS1 4AB\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "725774d5-4ff2-4425-9377-a633f1904ca4", "name": "Matched patient.", "originalRequest": { "url": { "path": [ "transactional-api", "match-patient" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"nhsNumber\": \"9990000018\",\n \"dateOfBirth\": \"1990-05-12\",\n \"givenName\": \"Jane\",\n \"familyName\": \"Smith\",\n \"postcode\": \"LS1 4AB\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"patientId\": \"6650d09e-4550-2a9f-8e14-530fb4b8e56e\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0abc3afd-ad20-4967-9045-0e1135f3974e", "name": "Unable to match.", "originalRequest": { "url": { "path": [ "transactional-api", "match-patient" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"nhsNumber\": \"9990000018\",\n \"dateOfBirth\": \"1990-05-12\",\n \"givenName\": \"Jane\",\n \"familyName\": \"Smith\",\n \"postcode\": \"LS1 4AB\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-parameters\",\n \"description\": \"Must specify either NHS Number, NHS Number + demographics, or DOB + Given Name + Family Name\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a2ff0258-44af-4756-a631-33e723c6cd76", "name": "Care record", "description": { "content": "Notes, encounters, observations, documents and referrals", "type": "text/plain" }, "item": [ { "id": "bce15420-2e67-4c61-b02d-526dfc9ca9ed", "name": "Create Document", "request": { "name": "Create Document", "description": { "content": "Files a document against a patient record. The file content is supplied base64-encoded in `data`. Optionally tag the document with a SNOMED CT `code` and/or `clinicalSpecialty`, both resolved against the NHS term browser.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-document" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-document" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"patientId\": \"83bfd95a-5c82-9d08-4d45-2a1bb3afe220\",\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"clinicalSpecialty\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"authorDepartment\": \"string\",\n \"additionalInformation\": \"string\",\n \"title\": \"string\",\n \"data\": \"string\",\n \"fileName\": \"string\",\n \"contentType\": \"string\",\n \"consultationTopicHeadingId\": \"01ee40a5-aee5-d550-a336-b131525d931c\",\n \"hiddenFromPatientFacingServices\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8d9973b7-e042-4085-97bd-14d0a564b42c", "name": "Document created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"83bfd95a-5c82-9d08-4d45-2a1bb3afe220\",\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"clinicalSpecialty\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"authorDepartment\": \"string\",\n \"additionalInformation\": \"string\",\n \"title\": \"string\",\n \"data\": \"string\",\n \"fileName\": \"string\",\n \"contentType\": \"string\",\n \"consultationTopicHeadingId\": \"01ee40a5-aee5-d550-a336-b131525d931c\",\n \"hiddenFromPatientFacingServices\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"e83a2022-398e-6013-b818-128d4f61268a\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a7ee282-3f37-40ad-97c5-b92f21146840", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "create-document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"83bfd95a-5c82-9d08-4d45-2a1bb3afe220\",\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"clinicalSpecialty\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"authorDepartment\": \"string\",\n \"additionalInformation\": \"string\",\n \"title\": \"string\",\n \"data\": \"string\",\n \"fileName\": \"string\",\n \"contentType\": \"string\",\n \"consultationTopicHeadingId\": \"01ee40a5-aee5-d550-a336-b131525d931c\",\n \"hiddenFromPatientFacingServices\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-patient-id\",\n \"description\": \"The patientId is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "506059ea-28c8-4152-80b5-fdb56e57d6c0", "name": "No patient found for the given patientId.", "originalRequest": { "url": { "path": [ "transactional-api", "create-document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"83bfd95a-5c82-9d08-4d45-2a1bb3afe220\",\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"clinicalSpecialty\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"authorDepartment\": \"string\",\n \"additionalInformation\": \"string\",\n \"title\": \"string\",\n \"data\": \"string\",\n \"fileName\": \"string\",\n \"contentType\": \"string\",\n \"consultationTopicHeadingId\": \"01ee40a5-aee5-d550-a336-b131525d931c\",\n \"hiddenFromPatientFacingServices\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"patient-not-found\",\n \"description\": \"Patient not found for the id: 3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b08077ac-efa9-49d2-882c-135ad0d6a550", "name": "Create Encounter", "request": { "name": "Create Encounter", "description": { "content": "Creates a finalised encounter (consultation) against a patient record, with one or more topics, each carrying one or more headings. Coded entries are SNOMED CT `conceptId` + `description` pairs resolved against the NHS term browser.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-encounter" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-encounter" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"patientId\": \"fa03cc7e-fd38-2ec5-ca49-81a3dfa1fd0e\",\n \"encounterType\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"topics\": [\n {\n \"headings\": [\n {\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n },\n {\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n }\n ],\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n },\n {\n \"headings\": [\n {\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n },\n {\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n }\n ],\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n }\n ],\n \"startDate\": \"1949-10-04\",\n \"startTime\": \"string\",\n \"hiddenFromPatientFacingServices\": false,\n \"confidentialFromThirdParties\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ca0a54bd-e354-4546-ac56-532f80353401", "name": "Encounter created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-encounter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"d2380020-1c8b-5be8-891c-6f7e8f42bc6d\",\n \"encounterType\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"topics\": [\n {\n \"headings\": [\n {\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n },\n {\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n }\n ],\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n },\n {\n \"headings\": [\n {\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n },\n {\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n }\n ],\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n }\n ],\n \"startDate\": \"1990-04-14\",\n \"startTime\": \"string\",\n \"hiddenFromPatientFacingServices\": false,\n \"confidentialFromThirdParties\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"edf2485b-5247-c631-5ae1-362d5047568d\",\n \"topics\": [\n {\n \"id\": \"baef8932-ebd6-6c01-cf03-b2e530752e64\",\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"headings\": [\n {\n \"id\": \"5b08f585-f2e8-070a-89bc-df3e1ef9189b\",\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n },\n {\n \"id\": \"9dbc9447-1150-0da1-ae1d-2b440804728f\",\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n }\n ]\n },\n {\n \"id\": \"7d7db288-54ec-2a26-86fa-abc1df0289e1\",\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"headings\": [\n {\n \"id\": \"206725f0-dcde-717e-0f9c-9f300bc76ad1\",\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n },\n {\n \"id\": \"7005a4b7-6cee-537b-2b14-fcef04a27d0f\",\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50d2211d-47b2-4b5d-9ba6-38fa71d227e6", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "create-encounter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"d2380020-1c8b-5be8-891c-6f7e8f42bc6d\",\n \"encounterType\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"topics\": [\n {\n \"headings\": [\n {\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n },\n {\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n }\n ],\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n },\n {\n \"headings\": [\n {\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n },\n {\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n }\n ],\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n }\n ],\n \"startDate\": \"1990-04-14\",\n \"startTime\": \"string\",\n \"hiddenFromPatientFacingServices\": false,\n \"confidentialFromThirdParties\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-patient-id\",\n \"description\": \"The patientId is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "64e64dd8-724e-4a38-b10c-9ef124dd4a80", "name": "Create Note", "request": { "name": "Create Note", "description": { "content": "Creates a clinical note against a patient record. Provide free-text `text`, a SNOMED CT coded entry via `code`, or both; at least one is required.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-note" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-note" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"patientId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"text\": \"Patient called to confirm medication review.\",\n \"code\": {\n \"conceptId\": \"185389009\",\n \"description\": \"Telephone encounter\"\n },\n \"recordDate\": \"2026-01-15\",\n \"consultationTopicHeadingId\": \"fd3a2592-00d0-6a62-129b-221c2ac6fe0f\",\n \"hiddenFromPatientFacingServices\": false,\n \"confidentialFromThirdParties\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ff8f15ac-8e62-4f65-b579-5d6fa48a6e4c", "name": "Note created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"text\": \"Patient called to confirm medication review.\",\n \"code\": {\n \"conceptId\": \"185389009\",\n \"description\": \"Telephone encounter\"\n },\n \"recordDate\": \"2026-01-15\",\n \"consultationTopicHeadingId\": \"fd3a2592-00d0-6a62-129b-221c2ac6fe0f\",\n \"hiddenFromPatientFacingServices\": false,\n \"confidentialFromThirdParties\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"549d8ab0-f739-41c6-9a75-5ddd13592450\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ef79bfe-df7a-4117-ba15-656540e281e4", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "create-note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"text\": \"Patient called to confirm medication review.\",\n \"code\": {\n \"conceptId\": \"185389009\",\n \"description\": \"Telephone encounter\"\n },\n \"recordDate\": \"2026-01-15\",\n \"consultationTopicHeadingId\": \"fd3a2592-00d0-6a62-129b-221c2ac6fe0f\",\n \"hiddenFromPatientFacingServices\": false,\n \"confidentialFromThirdParties\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-patient-id\",\n \"description\": \"The patientId is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "035c88b6-0e64-4fce-8784-9b1698c1eaa3", "name": "Create Observation", "request": { "name": "Create Observation", "description": { "content": "Records a finalised observation against a patient record. `observationType` (a SNOMED CT coded entry) is required; supply at most one of the `value*` properties to carry the observation result. Coded entries are `conceptId` + `description` pairs resolved against the NHS term browser.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-observation" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-observation" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"patientId\": \"c4fb9767-15db-409d-dc6f-924d0c7e512a\",\n \"observationType\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"bodySite\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"interpretation\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"recordDate\": \"1986-09-20\",\n \"observationDate\": \"2005-08-13\",\n \"observationTime\": \"string\",\n \"valueCode\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"valueString\": \"string\",\n \"valueDate\": \"1949-12-04\",\n \"valueDateTime\": \"1969-02-24T10:26:36.090Z\",\n \"valueQuantity\": {\n \"value\": 1346.747209542687,\n \"unit\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n },\n \"valueBloodPressure\": {\n \"systolic\": 1372.1821836902027,\n \"diastolic\": 4349.285216765206\n },\n \"additionalInformation\": \"string\",\n \"consultationTopicHeadingId\": \"4195b83d-3111-096f-b86c-7ffbf488201c\",\n \"hiddenFromPatientFacingServices\": false,\n \"confidentialFromThirdParties\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a5b2005b-bd8c-473d-87a3-e4397119cc4a", "name": "Observation created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-observation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"c4fb9767-15db-409d-dc6f-924d0c7e512a\",\n \"observationType\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"bodySite\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"interpretation\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"recordDate\": \"1986-09-20\",\n \"observationDate\": \"2005-08-13\",\n \"observationTime\": \"string\",\n \"valueCode\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"valueString\": \"string\",\n \"valueDate\": \"1949-12-04\",\n \"valueDateTime\": \"1969-02-24T10:26:36.090Z\",\n \"valueQuantity\": {\n \"value\": 1346.747209542687,\n \"unit\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n },\n \"valueBloodPressure\": {\n \"systolic\": 1372.1821836902027,\n \"diastolic\": 4349.285216765206\n },\n \"additionalInformation\": \"string\",\n \"consultationTopicHeadingId\": \"4195b83d-3111-096f-b86c-7ffbf488201c\",\n \"hiddenFromPatientFacingServices\": false,\n \"confidentialFromThirdParties\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"41d3ccb8-c81d-0c2f-de42-6910caa41b49\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf683c31-ce6e-4e5b-b746-8ff4a8adabe9", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "create-observation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"c4fb9767-15db-409d-dc6f-924d0c7e512a\",\n \"observationType\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"bodySite\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"interpretation\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"recordDate\": \"1986-09-20\",\n \"observationDate\": \"2005-08-13\",\n \"observationTime\": \"string\",\n \"valueCode\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"valueString\": \"string\",\n \"valueDate\": \"1949-12-04\",\n \"valueDateTime\": \"1969-02-24T10:26:36.090Z\",\n \"valueQuantity\": {\n \"value\": 1346.747209542687,\n \"unit\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n },\n \"valueBloodPressure\": {\n \"systolic\": 1372.1821836902027,\n \"diastolic\": 4349.285216765206\n },\n \"additionalInformation\": \"string\",\n \"consultationTopicHeadingId\": \"4195b83d-3111-096f-b86c-7ffbf488201c\",\n \"hiddenFromPatientFacingServices\": false,\n \"confidentialFromThirdParties\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-patient-id\",\n \"description\": \"The patientId is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "477b16ac-453f-495b-b55d-b7c74e491a7d", "name": "Create Outbound Referral", "request": { "name": "Create Outbound Referral", "description": { "content": "Creates an outbound referral against a patient record. Supply a SNOMED CT coded reason via `code` (required). If a `ubrn` is provided the referral is created as an NHS e-RS referral; otherwise a manual referral is created. Optional file `attachments` are base64-encoded.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-outbound-referral" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-outbound-referral" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"patientId\": \"e053c7a1-e2fc-b174-56bc-234c13583932\",\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"referralDate\": \"2007-01-28\",\n \"priority\": \"string\",\n \"ubrn\": \"string\",\n \"referredToOrganisation\": {\n \"name\": \"string\"\n },\n \"referredToPractitioner\": {\n \"name\": \"string\"\n },\n \"additionalInformation\": \"string\",\n \"consultationTopicHeadingId\": \"7dc1cb9c-6d80-1446-aff5-bea57d68a0ef\",\n \"hiddenFromPatientFacingServices\": false,\n \"confidentialFromThirdParties\": false,\n \"attachments\": [\n {\n \"fileName\": \"string\",\n \"contentType\": \"string\",\n \"data\": \"string\"\n },\n {\n \"fileName\": \"string\",\n \"contentType\": \"string\",\n \"data\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "da9c9bbf-3983-47a9-870b-1ee8d374c8ce", "name": "Referral created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-outbound-referral" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"ac8ff8bb-fd2d-2a47-c78d-c5258f020fb9\",\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"referralDate\": \"2017-12-04\",\n \"priority\": \"string\",\n \"ubrn\": \"string\",\n \"referredToOrganisation\": {\n \"name\": \"string\"\n },\n \"referredToPractitioner\": {\n \"name\": \"string\"\n },\n \"additionalInformation\": \"string\",\n \"consultationTopicHeadingId\": \"c9907e6b-816b-d712-4bd4-8ba4249a85b9\",\n \"hiddenFromPatientFacingServices\": false,\n \"confidentialFromThirdParties\": false,\n \"attachments\": [\n {\n \"fileName\": \"string\",\n \"contentType\": \"string\",\n \"data\": \"string\"\n },\n {\n \"fileName\": \"string\",\n \"contentType\": \"string\",\n \"data\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"67a1d517-756f-eb85-ff4b-4006c57e7d30\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c920c557-daa1-4cca-8867-9381e9c5e448", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "create-outbound-referral" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"ac8ff8bb-fd2d-2a47-c78d-c5258f020fb9\",\n \"code\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"referralDate\": \"2017-12-04\",\n \"priority\": \"string\",\n \"ubrn\": \"string\",\n \"referredToOrganisation\": {\n \"name\": \"string\"\n },\n \"referredToPractitioner\": {\n \"name\": \"string\"\n },\n \"additionalInformation\": \"string\",\n \"consultationTopicHeadingId\": \"c9907e6b-816b-d712-4bd4-8ba4249a85b9\",\n \"hiddenFromPatientFacingServices\": false,\n \"confidentialFromThirdParties\": false,\n \"attachments\": [\n {\n \"fileName\": \"string\",\n \"contentType\": \"string\",\n \"data\": \"string\"\n },\n {\n \"fileName\": \"string\",\n \"contentType\": \"string\",\n \"data\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-patient-id\",\n \"description\": \"The patientId is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "17409996-6b8d-4688-a92f-a3cebd62d8a6", "name": "List Documents", "request": { "name": "List Documents", "description": { "content": "Lists the documents held against a patient record via [GP Connect Access Document](https://digital.nhs.uk/developer/api-catalogue/gp-connect-access-document-fhir). The patient must have an NHS number. Returns a FHIR STU3 searchset Bundle of DocumentReference resources.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "list-documents" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/list-documents" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"patientId\": \"19cba386-3c6c-180d-990b-34f304b91323\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bcb9feb4-8fcd-4883-8276-61d3d3a42cfe", "name": "A FHIR STU3 searchset Bundle of the patient's documents.", "originalRequest": { "url": { "path": [ "transactional-api", "list-documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"19cba386-3c6c-180d-990b-34f304b91323\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0015824a-5c8c-4a85-9f80-c232230ef226", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "list-documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"19cba386-3c6c-180d-990b-34f304b91323\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-patient-id\",\n \"description\": \"The patientId is not a UUID\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "72fa45c8-00b7-4565-a99b-4e6383520100", "name": "Retrieve Care Record", "request": { "name": "Retrieve Care Record", "description": { "content": "Retrieves the patient's structured care record (allergies, medication, consultations, problems, immunisations, investigations, referrals, diary entries and uncategorised data) via [GP Connect Access Record: Structured](https://digital.nhs.uk/developer/api-catalogue/gp-connect-access-record-structured-fhir). The patient must have an NHS number. Returns a FHIR STU3 Bundle.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "retrieve-care-record" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/retrieve-care-record" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"patientId\": \"19cba386-3c6c-180d-990b-34f304b91323\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bf9b82ec-7cf3-478d-8baf-99750bc01d9c", "name": "FHIR STU3 Bundle containing the patient's structured care record.", "originalRequest": { "url": { "path": [ "transactional-api", "retrieve-care-record" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"19cba386-3c6c-180d-990b-34f304b91323\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"collection\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be18e3fa-6f90-4a4e-bd54-318620cf35d2", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "retrieve-care-record" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"19cba386-3c6c-180d-990b-34f304b91323\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-patient-id\",\n \"description\": \"The patientId is not a UUID\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "73b8c968-f166-4b1c-b71a-80459a538ae3", "name": "Retrieve Confidential Care Record", "request": { "name": "Retrieve Confidential Care Record", "description": { "content": "Retrieves the patient's structured care record, including confidential items (allergies, medication, consultations, problems, immunisations, investigations, referrals, diary entries and uncategorised data), via [GP Connect Access Record: Structured](https://digital.nhs.uk/developer/api-catalogue/gp-connect-access-record-structured-fhir). The patient must have an NHS number. Returns a FHIR STU3 Bundle.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "retrieve-confidential-care-record" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/retrieve-confidential-care-record" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"patientId\": \"19cba386-3c6c-180d-990b-34f304b91323\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4f73cd4b-a260-4760-9741-beb0087bfd97", "name": "FHIR STU3 Bundle containing the patient's structured care record, including confidential items.", "originalRequest": { "url": { "path": [ "transactional-api", "retrieve-confidential-care-record" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"19cba386-3c6c-180d-990b-34f304b91323\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"collection\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5df57859-5ee1-49c3-b53b-cdaad8432adb", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "retrieve-confidential-care-record" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"19cba386-3c6c-180d-990b-34f304b91323\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-patient-id\",\n \"description\": \"The patientId is not a UUID\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b168ff6a-548f-4e6b-a7ac-da2f7e4252f8", "name": "Retrieve Document", "request": { "name": "Retrieve Document", "description": { "content": "Retrieves the binary content of a document by its identifier via [GP Connect Access Document](https://digital.nhs.uk/developer/api-catalogue/gp-connect-access-document-fhir). Returns a FHIR STU3 Binary resource whose `content` field carries the base64-encoded document data.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "retrieve-document", "Binary", ":documentId" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "documentId", "description": "(Required) Identifier of the document to retrieve." }, { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/retrieve-document/Binary/:documentId" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "227bb353-93f6-4b98-b123-c50a0b5278e7", "name": "A FHIR STU3 Binary resource containing the document content.", "originalRequest": { "url": { "path": [ "transactional-api", "retrieve-document", "Binary", ":documentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "documentId", "description": "(Required) Identifier of the document to retrieve." }, { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34a7cef8-f664-40b1-9898-c2548c8b1dea", "name": "Validation or retrieval error.", "originalRequest": { "url": { "path": [ "transactional-api", "retrieve-document", "Binary", ":documentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "documentId", "description": "(Required) Identifier of the document to retrieve." }, { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"no-patient-id\",\n \"description\": \"No patientId specified\"\n },\n {\n \"code\": \"no-patient-id\",\n \"description\": \"No patientId specified\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b1d884db-bba0-4b92-992f-0c60e0237b04", "name": "Appointments", "description": { "content": "Check-in, arrival and appointment metadata", "type": "text/plain" }, "item": [ { "id": "542bca65-c9f0-4c25-a83f-e1d82354c951", "name": "Book Appointment", "request": { "name": "Book Appointment", "description": { "content": "Books an appointment for a patient into a specific diary slot. Use List Available Slots to obtain the diaryId, startTime, and endTime for a bookable slot.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "book-appointment" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/book-appointment" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"patientId\": \"8cf7bf8f-ef9a-9a51-1361-fa877687f122\",\n \"diaryId\": \"8cbce3be-a228-eff5-c290-935449f14c08\",\n \"appointmentServiceId\": \"c45ba154-c51d-3345-e29c-d8b956767285\",\n \"appointmentTypeId\": \"c5ebf7fe-5076-9efe-3d71-5c99aa2a1ddf\",\n \"startTime\": \"2016-11-20T18:12:33.531Z\",\n \"endTime\": \"2009-09-14T22:42:52.605Z\",\n \"reasonForAppointment\": \"string\",\n \"additionalInformation\": \"string\",\n \"embargoOverrideReason\": \"string\",\n \"gpadReportingExceptionReasons\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ffd32873-e46a-40e8-a0b5-15a7eb31ec97", "name": "Appointment booked successfully.", "originalRequest": { "url": { "path": [ "transactional-api", "book-appointment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"3d0c57ab-cd63-d126-6526-28b4a3a84338\",\n \"diaryId\": \"c652d800-64e1-6cee-cdc0-29aa52a83497\",\n \"appointmentServiceId\": \"e4f8aea1-8ca1-2bd2-a3f1-79c7891d1920\",\n \"appointmentTypeId\": \"8b64f3b9-6087-ffc6-258c-779c8a733ab7\",\n \"startTime\": \"2020-08-12T01:42:45.620Z\",\n \"endTime\": \"1988-10-23T21:17:03.739Z\",\n \"reasonForAppointment\": \"string\",\n \"additionalInformation\": \"string\",\n \"embargoOverrideReason\": \"string\",\n \"gpadReportingExceptionReasons\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"appointmentId\": \"1b6406b8-f7d0-2a90-31a1-a2508a12adb4\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eaa1a913-6b60-4f99-92ba-ef3e952e3068", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "book-appointment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"3d0c57ab-cd63-d126-6526-28b4a3a84338\",\n \"diaryId\": \"c652d800-64e1-6cee-cdc0-29aa52a83497\",\n \"appointmentServiceId\": \"e4f8aea1-8ca1-2bd2-a3f1-79c7891d1920\",\n \"appointmentTypeId\": \"8b64f3b9-6087-ffc6-258c-779c8a733ab7\",\n \"startTime\": \"2020-08-12T01:42:45.620Z\",\n \"endTime\": \"1988-10-23T21:17:03.739Z\",\n \"reasonForAppointment\": \"string\",\n \"additionalInformation\": \"string\",\n \"embargoOverrideReason\": \"string\",\n \"gpadReportingExceptionReasons\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-patient-id\",\n \"description\": \"The patientId is not a UUID\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1ce953f-3092-49bb-80ce-161078ca5864", "name": "A referenced resource was not found (patient, diary, appointment type, or slot).", "originalRequest": { "url": { "path": [ "transactional-api", "book-appointment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"3d0c57ab-cd63-d126-6526-28b4a3a84338\",\n \"diaryId\": \"c652d800-64e1-6cee-cdc0-29aa52a83497\",\n \"appointmentServiceId\": \"e4f8aea1-8ca1-2bd2-a3f1-79c7891d1920\",\n \"appointmentTypeId\": \"8b64f3b9-6087-ffc6-258c-779c8a733ab7\",\n \"startTime\": \"2020-08-12T01:42:45.620Z\",\n \"endTime\": \"1988-10-23T21:17:03.739Z\",\n \"reasonForAppointment\": \"string\",\n \"additionalInformation\": \"string\",\n \"embargoOverrideReason\": \"string\",\n \"gpadReportingExceptionReasons\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"patient-not-found\",\n \"description\": \"Patient not found for the id: 3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d9d6bb97-50e3-4039-b894-477a0a6b9740", "name": "Cancel Appointment", "request": { "name": "Cancel Appointment", "description": { "content": "Cancels an existing appointment for a patient. A cancellation reason is required. Returns 204 No Content on success.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "cancel-appointment" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/cancel-appointment" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"appointmentId\": \"f76b6e78-6e2f-d59f-70c2-1534f0b1facc\",\n \"patientId\": \"e3b5bbda-f26f-78e5-73bf-5738cb19d274\",\n \"cancellationReason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c0c0258d-151d-479c-ba1e-487a96774414", "name": "Appointment cancelled successfully.", "originalRequest": { "url": { "path": [ "transactional-api", "cancel-appointment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"appointmentId\": \"f76b6e78-6e2f-d59f-70c2-1534f0b1facc\",\n \"patientId\": \"e3b5bbda-f26f-78e5-73bf-5738cb19d274\",\n \"cancellationReason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aac4bfee-aff2-4679-9886-5af99fb37719", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "cancel-appointment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"appointmentId\": \"f76b6e78-6e2f-d59f-70c2-1534f0b1facc\",\n \"patientId\": \"e3b5bbda-f26f-78e5-73bf-5738cb19d274\",\n \"cancellationReason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-patient-id\",\n \"description\": \"The patientId is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4313bc7a-47d4-4d40-86b9-e1d683a247a8", "name": "No appointment found for the given appointmentId and patientId combination.", "originalRequest": { "url": { "path": [ "transactional-api", "cancel-appointment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"appointmentId\": \"f76b6e78-6e2f-d59f-70c2-1534f0b1facc\",\n \"patientId\": \"e3b5bbda-f26f-78e5-73bf-5738cb19d274\",\n \"cancellationReason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"appointment-not-found\",\n \"description\": \"Appointment not found for this appointmentId and patientId.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfe4c957-bfda-4963-ae56-be57d65bd595", "name": "The appointment exists but cannot be cancelled in its current state.", "originalRequest": { "url": { "path": [ "transactional-api", "cancel-appointment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"appointmentId\": \"f76b6e78-6e2f-d59f-70c2-1534f0b1facc\",\n \"patientId\": \"e3b5bbda-f26f-78e5-73bf-5738cb19d274\",\n \"cancellationReason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"appointment-cannot-be-cancelled\",\n \"description\": \"The appointment cannot be cancelled because it has already started or has already been cancelled.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ad52ce6-869a-449c-b19f-f3c151a35f22", "name": "Find Appointments for Check-in", "request": { "name": "Find Appointments for Check-in", "description": { "content": "Returns the patient's face-to-face appointments scheduled for today that are still eligible for self check-in.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "find-appointments-for-check-in" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/find-appointments-for-check-in" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"patientId\": \"8f4d79fd-4327-e21a-1357-216f570a6b94\",\n \"dateOfBirth\": \"1976-11-23\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "49825a59-e1f0-402c-ae77-581617a88a0f", "name": "Appointments eligible for check-in.", "originalRequest": { "url": { "path": [ "transactional-api", "find-appointments-for-check-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"8f4d79fd-4327-e21a-1357-216f570a6b94\",\n \"dateOfBirth\": \"1976-11-23\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"appointmentId\": \"130725b4-a89f-f35b-8536-09dc01e75b9e\",\n \"startTime\": \"string\",\n \"siteName\": \"string\",\n \"roomName\": \"string\",\n \"patientCheckInInstructions\": \"string\",\n \"practitionerName\": \"string\"\n },\n {\n \"appointmentId\": \"3254c95e-caaa-26a2-6ddd-f0dacc18dc58\",\n \"startTime\": \"string\",\n \"siteName\": \"string\",\n \"roomName\": \"string\",\n \"patientCheckInInstructions\": \"string\",\n \"practitionerName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "389334cf-2a75-4c47-a0a2-edb1c44381d7", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "find-appointments-for-check-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"8f4d79fd-4327-e21a-1357-216f570a6b94\",\n \"dateOfBirth\": \"1976-11-23\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-patient-id\",\n \"description\": \"The patientId is not a UUID\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a7af816-7e37-4690-ade3-b073871ccb7d", "name": "No patient found for the given patientId.", "originalRequest": { "url": { "path": [ "transactional-api", "find-appointments-for-check-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"8f4d79fd-4327-e21a-1357-216f570a6b94\",\n \"dateOfBirth\": \"1976-11-23\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"patient-not-found\",\n \"description\": \"Patient not found for the id: 3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "13822316-47af-4491-93ee-85c413f6d979", "name": "Get Appointment Metadata", "request": { "name": "Get Appointment Metadata", "description": { "content": "Returns the appointment services, appointment types and available procedures configured for the practice, for use when constructing a booking request (for example with Create Appointment Booking Link).", "type": "text/plain" }, "url": { "path": [ "transactional-api", "appointment", "get-metadata" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/appointment/get-metadata" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "30318fbd-1962-40aa-b7b2-a51ef0ffa36f", "name": "Appointment services configured for the practice.", "originalRequest": { "url": { "path": [ "transactional-api", "appointment", "get-metadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"appointmentServices\": [\n {\n \"id\": \"9bee5c02-1f9a-3cb8-f009-c825db646da2\",\n \"name\": \"string\",\n \"patientFacingName\": \"string\",\n \"appointmentTypes\": [\n {\n \"id\": \"afd83951-5e4b-0c80-5af7-53a6815bd749\",\n \"name\": \"string\",\n \"patientFacingName\": \"string\",\n \"colour\": \"string\",\n \"availableProcedures\": [\n {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n ]\n },\n {\n \"id\": \"4e4427b4-d8ee-7b8f-ecf2-b83260d48910\",\n \"name\": \"string\",\n \"patientFacingName\": \"string\",\n \"colour\": \"string\",\n \"availableProcedures\": [\n {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n ]\n }\n ]\n },\n {\n \"id\": \"a3464a69-5c52-9103-c2a5-4c7d17330783\",\n \"name\": \"string\",\n \"patientFacingName\": \"string\",\n \"appointmentTypes\": [\n {\n \"id\": \"00df87ed-1cd2-df25-6529-9e1c96afccf8\",\n \"name\": \"string\",\n \"patientFacingName\": \"string\",\n \"colour\": \"string\",\n \"availableProcedures\": [\n {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n ]\n },\n {\n \"id\": \"33101aa3-ea69-d802-9561-c1cec35465c1\",\n \"name\": \"string\",\n \"patientFacingName\": \"string\",\n \"colour\": \"string\",\n \"availableProcedures\": [\n {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n ]\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3844d9f8-e058-4726-a980-8b7a225802ee", "name": "List Available Slots", "request": { "name": "List Available Slots", "description": { "content": "Returns bookable appointment slots from a given date, with optional filters for appointment services, types, practitioners, and sites. Results are sorted by start time. The maximum date range between `fromDate` and `endDate` is 4 weeks; if `endDate` is omitted, slots up to 4 weeks from `fromDate` are returned.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "list-available-slots" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/list-available-slots" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"fromDate\": \"1952-01-27\",\n \"endDate\": \"2013-09-28\",\n \"appointmentServiceIds\": [\n \"d2b48143-8892-801d-76a7-29d9d5f507dc\",\n \"a3a8d7de-7b78-9a09-882e-02a194132397\"\n ],\n \"appointmentTypeIds\": [\n \"1789f568-d662-8597-d867-e19ad4c215f1\",\n \"0422c0a1-aaca-c4a8-971b-117be7927e76\"\n ],\n \"practitionerIds\": [\n \"26a9a33f-0867-4bba-cbd9-fd28e017e264\",\n \"43072ebc-c927-e9e1-7cc9-47b9d7bc2541\"\n ],\n \"siteIds\": [\n \"8a33b53d-c748-4f46-5f8a-d4ea9a71bf57\",\n \"59bbc4e9-5fc6-99cd-a7f5-7fa7ce3d58e5\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "03b38ddf-3475-4907-b5c7-f87b344f8685", "name": "Available slots matching the request filters.", "originalRequest": { "url": { "path": [ "transactional-api", "list-available-slots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fromDate\": \"1962-04-22\",\n \"endDate\": \"2020-07-29\",\n \"appointmentServiceIds\": [\n \"e7db6d6e-a93e-fdd2-72ec-f917fd792bb2\",\n \"f4dfa1cb-02b0-e95b-f09b-30687d218e36\"\n ],\n \"appointmentTypeIds\": [\n \"8ff4adeb-1fbc-16c6-9d37-0f3ae0f755f8\",\n \"eb78ec4a-aa1f-e482-3901-474efab3127a\"\n ],\n \"practitionerIds\": [\n \"84bb0c66-03fd-4407-3617-566b56bd2fcf\",\n \"514c79f5-e646-c97f-20c1-d947a15b0331\"\n ],\n \"siteIds\": [\n \"c53f51a3-ba13-7e6e-d316-583dcfe6a518\",\n \"149ac920-c657-a781-b71b-5a326f4413fe\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"startTime\": \"1952-06-11T04:37:55.126Z\",\n \"endTime\": \"1961-11-18T14:04:47.719Z\",\n \"diaryId\": \"8da15538-e117-8aa6-c3cd-25aa5884c0fc\",\n \"practitionerIds\": [\n \"a68dc137-29fb-8182-45ce-4ac6890b94b8\",\n \"de3459f1-d91f-14ea-4d36-69d7f28e1614\"\n ],\n \"siteId\": \"e94e42ab-6aac-2d34-3bde-5dde610d0f25\",\n \"roomId\": \"3715b943-f1c1-9082-7bfd-5a53fd349b7d\",\n \"appointmentServiceId\": \"a1f8972c-d738-bc23-f7e6-f07182233214\",\n \"appointmentTypeId\": \"e90aed3c-5007-dea3-84ab-47d1d04061dd\",\n \"colour\": \"string\",\n \"deliveryMode\": \"string\",\n \"embargoed\": true\n },\n {\n \"startTime\": \"2007-10-07T17:27:32.418Z\",\n \"endTime\": \"1970-07-04T02:16:01.118Z\",\n \"diaryId\": \"fdf24c31-f317-dacb-1afe-4c8d0d60a501\",\n \"practitionerIds\": [\n \"683e0240-3601-e039-2411-12ff92ab1220\",\n \"481af45e-545d-5cc2-f02f-a5a903b87aad\"\n ],\n \"siteId\": \"50e5424d-d62f-49c3-5640-4acec3036629\",\n \"roomId\": \"f98c19be-4353-e4b7-6e41-768498e8b11f\",\n \"appointmentServiceId\": \"9e50f325-d349-b12d-3478-13108e8c8876\",\n \"appointmentTypeId\": \"12b6154b-0c90-90d7-c457-25128486bcbe\",\n \"colour\": \"string\",\n \"deliveryMode\": \"string\",\n \"embargoed\": true\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4a213f5-d707-4db6-8b54-dc9a5cb272d8", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "list-available-slots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fromDate\": \"1962-04-22\",\n \"endDate\": \"2020-07-29\",\n \"appointmentServiceIds\": [\n \"e7db6d6e-a93e-fdd2-72ec-f917fd792bb2\",\n \"f4dfa1cb-02b0-e95b-f09b-30687d218e36\"\n ],\n \"appointmentTypeIds\": [\n \"8ff4adeb-1fbc-16c6-9d37-0f3ae0f755f8\",\n \"eb78ec4a-aa1f-e482-3901-474efab3127a\"\n ],\n \"practitionerIds\": [\n \"84bb0c66-03fd-4407-3617-566b56bd2fcf\",\n \"514c79f5-e646-c97f-20c1-d947a15b0331\"\n ],\n \"siteIds\": [\n \"c53f51a3-ba13-7e6e-d316-583dcfe6a518\",\n \"149ac920-c657-a781-b71b-5a326f4413fe\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-from-date\",\n \"description\": \"The fromDate is required and must be a valid date in Y-m-d format.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a24d37f-e89c-4be2-8629-01ebf8f2dcdf", "name": "A referenced appointment service or type was not found.", "originalRequest": { "url": { "path": [ "transactional-api", "list-available-slots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fromDate\": \"1962-04-22\",\n \"endDate\": \"2020-07-29\",\n \"appointmentServiceIds\": [\n \"e7db6d6e-a93e-fdd2-72ec-f917fd792bb2\",\n \"f4dfa1cb-02b0-e95b-f09b-30687d218e36\"\n ],\n \"appointmentTypeIds\": [\n \"8ff4adeb-1fbc-16c6-9d37-0f3ae0f755f8\",\n \"eb78ec4a-aa1f-e482-3901-474efab3127a\"\n ],\n \"practitionerIds\": [\n \"84bb0c66-03fd-4407-3617-566b56bd2fcf\",\n \"514c79f5-e646-c97f-20c1-d947a15b0331\"\n ],\n \"siteIds\": [\n \"c53f51a3-ba13-7e6e-d316-583dcfe6a518\",\n \"149ac920-c657-a781-b71b-5a326f4413fe\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"appointment-service-not-found\",\n \"description\": \"The appointment service with the ID '3fa85f64-5717-4562-b3fc-2c963f66afa6' could not be found.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb0b0024-50db-4587-916f-931b2c9d5392", "name": "List Called-in Appointments", "request": { "name": "List Called-in Appointments", "description": { "content": "Returns pending appointments at the given site whose arrival status is currently Called In, ordered by intended start time. An appointment drops off this list once its consultation starts, its called-in status is cleared, or it is marked as Did Not Attend.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "list-called-in-appointments", ":siteId" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a", "key": "siteId", "description": "(Required) Site to list called-in appointments for." }, { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/list-called-in-appointments/:siteId" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1b84801d-9242-44e7-b973-92e78b97d08c", "name": "Called-in appointments for the given site.", "originalRequest": { "url": { "path": [ "transactional-api", "list-called-in-appointments", ":siteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a", "key": "siteId", "description": "(Required) Site to list called-in appointments for." }, { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"appointmentId\": \"7e295bcf-83b5-b428-256e-b12be4707ca5\",\n \"patientName\": \"string\",\n \"roomName\": \"string\",\n \"calledInAt\": \"2012-11-03T18:07:37.635Z\"\n },\n {\n \"appointmentId\": \"6eea16b2-6a9e-4e20-0111-657c24bade30\",\n \"patientName\": \"string\",\n \"roomName\": \"string\",\n \"calledInAt\": \"1983-11-28T01:57:01.892Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce8eb3c7-5072-48ae-9c20-4eacb2d152b8", "name": "The siteId is not a valid UUID.", "originalRequest": { "url": { "path": [ "transactional-api", "list-called-in-appointments", ":siteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a", "key": "siteId", "description": "(Required) Site to list called-in appointments for." }, { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-site-id\",\n \"description\": \"The siteId is not a UUID\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "774ea283-c203-4083-892f-bc93d9feef93", "name": "No site found for the given siteId.", "originalRequest": { "url": { "path": [ "transactional-api", "list-called-in-appointments", ":siteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a", "key": "siteId", "description": "(Required) Site to list called-in appointments for." }, { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"site-not-found\",\n \"description\": \"Site not found for this siteId\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7a9c95e-a18b-4c0e-8b99-15f511c2a01c", "name": "List Sites", "request": { "name": "List Sites", "description": { "content": "Returns all active sites with their identifier and name.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "list-sites" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/list-sites" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "63a9534f-e11f-47ac-85e9-f3aa322a714e", "name": "Active sites.", "originalRequest": { "url": { "path": [ "transactional-api", "list-sites" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"376f2c2e-ce7f-dcbc-e9a5-6806431bc20c\",\n \"name\": \"string\"\n },\n {\n \"id\": \"f806d8a0-1dae-984c-e92a-0f2f034a1d69\",\n \"name\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "331f731e-d58c-4bdb-91c8-0269e934701a", "name": "Mark Patient as Arrived", "request": { "name": "Mark Patient as Arrived", "description": { "content": "Checks a patient in for the given appointment, setting its arrival status to arrived when the appointment is still pending.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "mark-patient-as-arrived" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/mark-patient-as-arrived" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"appointmentId\": \"f2ce8b48-d018-9304-1edb-574777d73dbb\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "de234cd8-b16a-448a-b91d-4e706efb417f", "name": "Patient checked in.", "originalRequest": { "url": { "path": [ "transactional-api", "mark-patient-as-arrived" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"appointmentId\": \"f2ce8b48-d018-9304-1edb-574777d73dbb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"502ba930-efc8-0053-7533-8052b210217d\",\n \"arrivalStatus\": \"string\",\n \"patientInstructions\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b73b63f2-ee3f-4038-bb78-5e29fb482b16", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "mark-patient-as-arrived" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"appointmentId\": \"f2ce8b48-d018-9304-1edb-574777d73dbb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-appointment-id\",\n \"description\": \"The appointmentId is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "255dd2d7-b01a-4224-a0cc-42dc7cad28b1", "name": "Staff", "description": { "content": "Practice staff", "type": "text/plain" }, "item": [ { "id": "e7578aa2-c18f-498f-b0f4-4efc060dddf5", "name": "List Staff", "request": { "name": "List Staff", "description": { "content": "Returns all active staff members with their identifier, display name, and username.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "list-staff" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/list-staff" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "586a4b63-a17e-4632-b914-5e8762e0860e", "name": "Active staff members.", "originalRequest": { "url": { "path": [ "transactional-api", "list-staff" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"4bce1d15-a200-7b1e-4cda-4159c71b9b30\",\n \"name\": \"string\",\n \"username\": \"string\",\n \"userRoles\": [\n \"string\",\n \"string\"\n ],\n \"jobRoles\": [\n {\n \"id\": \"9fa01de5-0665-ae5f-641f-8b52667d1598\",\n \"name\": \"string\",\n \"gpadRole\": \"string\",\n \"gpConnectRole\": \"string\",\n \"emed3FitNoteProfession\": \"string\"\n },\n {\n \"id\": \"a7881f01-3305-96c6-2b47-16215eeb6918\",\n \"name\": \"string\",\n \"gpadRole\": \"string\",\n \"gpConnectRole\": \"string\",\n \"emed3FitNoteProfession\": \"string\"\n }\n ],\n \"gmcNumber\": \"string\",\n \"nmcPin\": \"string\",\n \"gphcRegistrationNumber\": \"string\",\n \"hcpcRegistrationNumber\": \"string\"\n },\n {\n \"id\": \"f99b1028-149c-6bdc-0112-aaf42ee356be\",\n \"name\": \"string\",\n \"username\": \"string\",\n \"userRoles\": [\n \"string\",\n \"string\"\n ],\n \"jobRoles\": [\n {\n \"id\": \"ade95c29-0ae4-dcd3-6413-d485381dd609\",\n \"name\": \"string\",\n \"gpadRole\": \"string\",\n \"gpConnectRole\": \"string\",\n \"emed3FitNoteProfession\": \"string\"\n },\n {\n \"id\": \"f5711f53-9119-1c31-b549-539ee88a32ee\",\n \"name\": \"string\",\n \"gpadRole\": \"string\",\n \"gpConnectRole\": \"string\",\n \"emed3FitNoteProfession\": \"string\"\n }\n ],\n \"gmcNumber\": \"string\",\n \"nmcPin\": \"string\",\n \"gphcRegistrationNumber\": \"string\",\n \"hcpcRegistrationNumber\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5ff2eb5f-daee-4c2c-8caf-bc7cc4892447", "name": "Front Door", "description": { "content": "Front-of-house entry points: patient self-service (booking links) and telephony system integrations, such as inbound caller lookup", "type": "text/plain" }, "item": [ { "id": "7d8e337d-1097-4ea5-ac6e-0984bfdb74af", "name": "Caller ID Lookup", "request": { "name": "Caller ID Lookup", "description": { "content": "Looks up patients by phone number. Returns all patients whose registered phone number matches, plus patients linked to a matching registered carer or contact. Suitable for inbound call identification.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "caller-id-lookup" ], "host": [ "{{base_url}}" ], "query": [ { "disabled": false, "key": "phoneNumber", "value": "+447700900000", "description": "(Required) Phone number to look up. Accepts national (e.g. 07700 900000) or international (e.g. +447700900000) format." } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/caller-id-lookup" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5baf3b27-1d27-405c-8621-b715cd414fdd", "name": "Matching patients, sorted by family name then given name. Returns an empty array when no patients match.", "originalRequest": { "url": { "path": [ "transactional-api", "caller-id-lookup" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "phoneNumber", "value": "+447700900000" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"patientId\": \"6825fdb3-1b74-481a-f52a-b9d7de7df9bc\",\n \"displayName\": \"string\",\n \"dateOfBirth\": \"2017-09-11\",\n \"nhsNumber\": \"string\"\n },\n {\n \"patientId\": \"5979b740-624d-2ea7-b645-c0f3f5e13ff6\",\n \"displayName\": \"string\",\n \"dateOfBirth\": \"1982-01-28\",\n \"nhsNumber\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a8631f6-ea47-4b31-add9-05a7922370a8", "name": "Validation error: `phoneNumber` is missing.", "originalRequest": { "url": { "path": [ "transactional-api", "caller-id-lookup" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "phoneNumber", "value": "+447700900000" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-phone-number\",\n \"description\": \"No phone number is specified\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "137247e9-c92e-44ac-a785-a3952739175f", "name": "Create Appointment Booking Link", "request": { "name": "Create Appointment Booking Link", "description": { "content": "Generates a public URL for self-service appointment booking. Provide either `requiredProcedures` (SNOMED CT coded) or both `appointmentServiceId` and `appointmentTypeId`, but not both; see Get Appointment Metadata for the available services, types and procedures.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "appointment", "create-booking-link" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/appointment/create-booking-link" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"patientId\": \"3e641ada-3ffe-6e7e-67f8-1cab7fc63a25\",\n \"appointmentServiceId\": \"cea27a67-e267-dfcc-66b1-6187707e395d\",\n \"appointmentTypeId\": \"5aa7caaa-6f3d-e743-8b5e-9afb2b1464a1\",\n \"requiredProcedures\": [\n {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"predefinedReasonForAppointment\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "11438935-6301-42c5-83c3-0eb1926a01e7", "name": "Booking link created.", "originalRequest": { "url": { "path": [ "transactional-api", "appointment", "create-booking-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"70d4a68c-e51b-f400-3e77-e1d0af1dbb8a\",\n \"appointmentServiceId\": \"4c36b396-23e8-1dd7-5573-a3e5f107c0b5\",\n \"appointmentTypeId\": \"e1ae7b77-137e-afcd-8ecf-0b62fced88a2\",\n \"requiredProcedures\": [\n {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"predefinedReasonForAppointment\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b52daa5-85f1-4268-b52d-ca203fa63676", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "appointment", "create-booking-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"70d4a68c-e51b-f400-3e77-e1d0af1dbb8a\",\n \"appointmentServiceId\": \"4c36b396-23e8-1dd7-5573-a3e5f107c0b5\",\n \"appointmentTypeId\": \"e1ae7b77-137e-afcd-8ecf-0b62fced88a2\",\n \"requiredProcedures\": [\n {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"predefinedReasonForAppointment\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-patient-id\",\n \"description\": \"The patientId is not a UUID\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3189f68-6c2e-4840-a8cc-cc1f63d90155", "name": "Create Patient Request", "request": { "name": "Create Patient Request", "description": { "content": "Submits a patient request to Medicus on behalf of a patient. Use `medical` for clinical concerns and `admin` for administrative matters.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-patient-request" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-patient-request" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"patientId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"requestType\": \"medical\",\n \"requester\": \"patient\",\n \"response\": [\n {\n \"question\": \"healthConcern\",\n \"answer\": \"Persistent chest pain for three days.\"\n },\n {\n \"question\": \"healthConcern\",\n \"answer\": \"Persistent chest pain for three days.\"\n }\n ],\n \"isHighPriority\": false,\n \"proxyDetails\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"relationshipToPatient\": \"Mother\"\n },\n \"attachments\": [\n {\n \"fileName\": \"ecg-result.jpg\",\n \"contentType\": \"image/jpeg\",\n \"data\": \"/9j/4AAQSkZJRgAB...\"\n },\n {\n \"fileName\": \"ecg-result.jpg\",\n \"contentType\": \"image/jpeg\",\n \"data\": \"/9j/4AAQSkZJRgAB...\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c591fc1f-7ce3-402f-ab5a-760db3fef0ae", "name": "Patient request created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-patient-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"requestType\": \"medical\",\n \"requester\": \"patient\",\n \"response\": [\n {\n \"question\": \"healthConcern\",\n \"answer\": \"Persistent chest pain for three days.\"\n },\n {\n \"question\": \"healthConcern\",\n \"answer\": \"Persistent chest pain for three days.\"\n }\n ],\n \"isHighPriority\": false,\n \"proxyDetails\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"relationshipToPatient\": \"Mother\"\n },\n \"attachments\": [\n {\n \"fileName\": \"ecg-result.jpg\",\n \"contentType\": \"image/jpeg\",\n \"data\": \"/9j/4AAQSkZJRgAB...\"\n },\n {\n \"fileName\": \"ecg-result.jpg\",\n \"contentType\": \"image/jpeg\",\n \"data\": \"/9j/4AAQSkZJRgAB...\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"patientRequestId\": \"93821e2c-af7f-6f00-fe66-cfab01fefece\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fce7ab96-6f21-4031-ac84-9e7a6b0e9d02", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "create-patient-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patientId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"requestType\": \"medical\",\n \"requester\": \"patient\",\n \"response\": [\n {\n \"question\": \"healthConcern\",\n \"answer\": \"Persistent chest pain for three days.\"\n },\n {\n \"question\": \"healthConcern\",\n \"answer\": \"Persistent chest pain for three days.\"\n }\n ],\n \"isHighPriority\": false,\n \"proxyDetails\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"relationshipToPatient\": \"Mother\"\n },\n \"attachments\": [\n {\n \"fileName\": \"ecg-result.jpg\",\n \"contentType\": \"image/jpeg\",\n \"data\": \"/9j/4AAQSkZJRgAB...\"\n },\n {\n \"fileName\": \"ecg-result.jpg\",\n \"contentType\": \"image/jpeg\",\n \"data\": \"/9j/4AAQSkZJRgAB...\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-patient-id\",\n \"description\": \"The patientId is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0fecb340-a596-4457-9bbc-8b114df976e2", "name": "Resource Publishing", "description": { "content": "Create, version, and publish clinical content resources (templates, dashboards, future action rules, and content packages)", "type": "text/plain" }, "item": [ { "id": "1a29762b-d538-4b54-a545-935458a8ef7a", "name": "Archive Communication Template", "request": { "name": "Archive Communication Template", "description": { "content": "Archives a communication template, making it unavailable for use.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "archive-communication-template" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/archive-communication-template" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"templateId\": \"5e835ab3-64cf-2e59-b60f-f0dbf2bf888f\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fb293d54-b940-4934-9c4c-34a3cc70b722", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-communication-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"5e835ab3-64cf-2e59-b60f-f0dbf2bf888f\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd7cb110-61b7-4b08-83dc-01bd975a9072", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-communication-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"5e835ab3-64cf-2e59-b60f-f0dbf2bf888f\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5bea3723-a0f5-41e2-951a-45db4489f8e1", "name": "Archive Content Package", "request": { "name": "Archive Content Package", "description": { "content": "Archives a content package, making it unavailable for distribution.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "archive-content-package" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/archive-content-package" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"packageId\": \"696b8c8a-08fe-6874-9538-c497a2189e71\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "125fa25c-cf07-483d-a0ff-07985e60e2e6", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-content-package" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"packageId\": \"696b8c8a-08fe-6874-9538-c497a2189e71\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa52cdc9-89af-49ab-9fed-19502e8f69d6", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-content-package" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"packageId\": \"696b8c8a-08fe-6874-9538-c497a2189e71\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15167456-414c-4fae-9b55-83c60e00d25e", "name": "Content package not found.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-content-package" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"packageId\": \"696b8c8a-08fe-6874-9538-c497a2189e71\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eda790b8-6f96-42bf-b5f6-b3da7a167252", "name": "Archive Custom Dashboard", "request": { "name": "Archive Custom Dashboard", "description": { "content": "Archives a custom dashboard template, making it unavailable for use.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "archive-custom-dashboard" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/archive-custom-dashboard" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"dashboardId\": \"ec502efc-79b2-b095-9c2c-69b1fc71dec8\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "05f61bf1-27ce-4a75-80eb-40c2f097dc43", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-custom-dashboard" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dashboardId\": \"ec502efc-79b2-b095-9c2c-69b1fc71dec8\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58a16c03-f05d-45ba-b003-a74c00f33b84", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-custom-dashboard" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dashboardId\": \"ec502efc-79b2-b095-9c2c-69b1fc71dec8\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d046b8c2-84f2-4691-89c0-3f1396b7a6dd", "name": "Archive Data Entry Template", "request": { "name": "Archive Data Entry Template", "description": { "content": "Archives a data entry template, making it unavailable for use.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "archive-data-entry-template" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/archive-data-entry-template" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"templateId\": \"cd37f1ee-6f6b-2703-e8e5-5429d12330e0\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4f802734-3c4a-434b-a85e-6ff9a9c3d360", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-data-entry-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"cd37f1ee-6f6b-2703-e8e5-5429d12330e0\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fe53cf4-3758-4a5d-82e1-d98e27e4a8ec", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-data-entry-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"cd37f1ee-6f6b-2703-e8e5-5429d12330e0\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9276b33f-45a4-4e53-b3c2-37e962b7a17f", "name": "Data entry template not found.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-data-entry-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"cd37f1ee-6f6b-2703-e8e5-5429d12330e0\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46c7142e-8cb0-4aa7-abf2-69eef9d5e7cc", "name": "Archive Document Template", "request": { "name": "Archive Document Template", "description": { "content": "Archives a document form template, making it unavailable for use.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "archive-document-template" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/archive-document-template" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"templateId\": \"397318e3-7535-02cf-73bb-ea69b07c8b35\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "29e715a6-6d99-44bb-ad12-839b86bced6f", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-document-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"397318e3-7535-02cf-73bb-ea69b07c8b35\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dffbc804-0fa9-45ec-b3c2-64a49284f5b1", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-document-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"397318e3-7535-02cf-73bb-ea69b07c8b35\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f24c1af2-5ed8-4695-a82f-e4af9acab377", "name": "Document form template not found.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-document-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"397318e3-7535-02cf-73bb-ea69b07c8b35\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ebf9bc3-ab79-479a-b2ad-3d3510ebdf46", "name": "Archive Future Action Rule", "request": { "name": "Archive Future Action Rule", "description": { "content": "Archives a future action rule, making it unavailable for use.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "archive-future-action-rule" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/archive-future-action-rule" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ruleId\": \"fa90754a-0b83-5025-e793-bcee272d8030\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dfe996bd-dcf9-4eec-a0d4-5e3d11112b02", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-future-action-rule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ruleId\": \"fa90754a-0b83-5025-e793-bcee272d8030\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c5a2ae5-d909-48c5-a15e-40301c590149", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-future-action-rule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ruleId\": \"fa90754a-0b83-5025-e793-bcee272d8030\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9c8cb2b-7f46-482c-bd29-e6ab517ae57c", "name": "Future action rule not found.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-future-action-rule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ruleId\": \"fa90754a-0b83-5025-e793-bcee272d8030\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40aab216-766a-4a99-b7db-de616e8e26ed", "name": "Archive Patient Questionnaire Template", "request": { "name": "Archive Patient Questionnaire Template", "description": { "content": "Archives a patient questionnaire template, making it unavailable for use.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "archive-patient-questionnaire-template" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/archive-patient-questionnaire-template" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"templateId\": \"78dc8150-6e90-919f-ee62-c7781136ad59\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "58a52540-da39-4efa-8535-a9db6dd72d4e", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-patient-questionnaire-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"78dc8150-6e90-919f-ee62-c7781136ad59\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2bf4d82-5bf4-410c-8f0e-696c0764008b", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "archive-patient-questionnaire-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"78dc8150-6e90-919f-ee62-c7781136ad59\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c627db58-35ae-4b73-88e7-6860a81183aa", "name": "Create Communication Template", "request": { "name": "Create Communication Template", "description": { "content": "Creates a new communication template.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-communication-template" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-communication-template" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c338533a-a50a-4550-a802-47b080348a64", "name": "Created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-communication-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4dac527-5a47-4171-9a98-41b54ab69f81", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "create-communication-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54dcf2b2-4884-49e3-874f-c5f4844607a9", "name": "Create Communication Template Version", "request": { "name": "Create Communication Template Version", "description": { "content": "Creates a new draft version of a communication template.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-communication-template-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-communication-template-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"templateId\": \"51a9fa6c-a6ae-1cba-2a2d-fa4bf49ee379\",\n \"versionNumber\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8ce86115-5e90-47b4-9730-7beabc8d44c3", "name": "Created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-communication-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"51a9fa6c-a6ae-1cba-2a2d-fa4bf49ee379\",\n \"versionNumber\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cb0bc8f-5520-4494-8f09-fe8ef8f7ecd8", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "create-communication-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"51a9fa6c-a6ae-1cba-2a2d-fa4bf49ee379\",\n \"versionNumber\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ab5f720-391c-4474-b05a-4011c5e479a0", "name": "Create Content Package", "request": { "name": "Create Content Package", "description": { "content": "Creates a new content package for distributing resources to organisations.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-content-package" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-content-package" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"availability\": \"all_healthcare_organisations\",\n \"description\": \"string\",\n \"availableToTenants\": [\n \"28d40b0c-997f-2f66-e21d-2668f30c8c4a\",\n \"20f5042a-dfbb-6772-7ab4-27412fdbbc44\"\n ],\n \"availableToOdsCodes\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dcb816f9-d93e-4d44-b115-afa08ad98f8a", "name": "Created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-content-package" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"availability\": \"all_healthcare_organisations\",\n \"description\": \"string\",\n \"availableToTenants\": [\n \"b650f37e-431e-d504-b6ff-cabe8c849844\",\n \"37217196-a861-31fa-25c5-89369e4fde19\"\n ],\n \"availableToOdsCodes\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "005f3f9e-d358-482b-a2e5-692e45806e89", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "create-content-package" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"availability\": \"all_healthcare_organisations\",\n \"description\": \"string\",\n \"availableToTenants\": [\n \"b650f37e-431e-d504-b6ff-cabe8c849844\",\n \"37217196-a861-31fa-25c5-89369e4fde19\"\n ],\n \"availableToOdsCodes\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8c10796-f3c0-40ba-b768-3c5e9ac6c408", "name": "Create Custom Dashboard", "request": { "name": "Create Custom Dashboard", "description": { "content": "Creates a new custom dashboard template.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-custom-dashboard" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-custom-dashboard" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"type\": \"ncd\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9ac33804-e8f1-42e0-b66e-ce5485582fe2", "name": "Created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-custom-dashboard" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"type\": \"ncd\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a81f2666-0fdd-44bd-8b90-07ed85447e59", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "create-custom-dashboard" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"type\": \"ncd\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "82b0c658-74fa-4e0d-824d-1995bed5a69a", "name": "Create Custom Dashboard Version", "request": { "name": "Create Custom Dashboard Version", "description": { "content": "Creates a new draft version of a custom dashboard template.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-custom-dashboard-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-custom-dashboard-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"dashboardId\": \"99f4d567-a282-98d8-7b8a-7428197c8112\",\n \"versionNumber\": \"string\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "954535b6-1850-4c7d-803d-e9dfa008a1ae", "name": "Created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-custom-dashboard-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dashboardId\": \"99f4d567-a282-98d8-7b8a-7428197c8112\",\n \"versionNumber\": \"string\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d1ad2d3-2bd0-4518-a57d-d44aab32b3f8", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "create-custom-dashboard-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dashboardId\": \"99f4d567-a282-98d8-7b8a-7428197c8112\",\n \"versionNumber\": \"string\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a2311fb1-a294-4dec-a108-f791b2352bef", "name": "Create Data Entry Template", "request": { "name": "Create Data Entry Template", "description": { "content": "Creates a new data entry template.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-data-entry-template" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-data-entry-template" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6e36824d-c03f-472a-8e1d-55728ddb9671", "name": "Created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-data-entry-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16a9e4e0-7722-4d12-b7d5-0e0102999db0", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "create-data-entry-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e223d32-447f-446b-9e79-e670c72ede3d", "name": "Create Data Entry Template Version", "request": { "name": "Create Data Entry Template Version", "description": { "content": "Creates a new draft version of a data entry template.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-data-entry-template-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-data-entry-template-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"templateId\": \"f571ef77-44f4-3a38-3fef-4620fca23d39\",\n \"versionNumber\": \"string\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2fb9fb6c-2e17-4862-a9e7-34a72da913ff", "name": "Created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-data-entry-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"f571ef77-44f4-3a38-3fef-4620fca23d39\",\n \"versionNumber\": \"string\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47844433-ffa9-4579-82dc-0f4e5ecd8868", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "create-data-entry-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"f571ef77-44f4-3a38-3fef-4620fca23d39\",\n \"versionNumber\": \"string\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de4042d1-63dc-460e-b764-a1b09459865b", "name": "Data entry template not found.", "originalRequest": { "url": { "path": [ "transactional-api", "create-data-entry-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"f571ef77-44f4-3a38-3fef-4620fca23d39\",\n \"versionNumber\": \"string\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8fa59861-a179-4813-88d9-c09a52b19269", "name": "Create Document Form Template", "request": { "name": "Create Document Form Template", "description": { "content": "Creates a new document form template.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-document-form-template" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-document-form-template" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"type\": \"general-document\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "196fe64b-e28a-400a-a20d-d1cbeb57c1b7", "name": "Created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-document-form-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"type\": \"general-document\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39e54173-0e3a-444e-bb61-786c118f7a6e", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "create-document-form-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"type\": \"general-document\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2edbed06-b304-4b3a-8570-7e97019c701d", "name": "Create Document Form Template Version", "request": { "name": "Create Document Form Template Version", "description": { "content": "Creates a new draft version of a document form template.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-document-form-template-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-document-form-template-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"templateId\": \"e198c474-1f9d-0c59-3802-a57e88c71fd5\",\n \"versionNumber\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b4294e0a-3d6f-44ab-b053-c271f89e0094", "name": "Created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-document-form-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"e198c474-1f9d-0c59-3802-a57e88c71fd5\",\n \"versionNumber\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20f75891-867c-4510-81c6-fa3844553ba8", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "create-document-form-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"e198c474-1f9d-0c59-3802-a57e88c71fd5\",\n \"versionNumber\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fd61785-f8af-4f74-ab45-ddccb3e8d90b", "name": "Document form template not found.", "originalRequest": { "url": { "path": [ "transactional-api", "create-document-form-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"e198c474-1f9d-0c59-3802-a57e88c71fd5\",\n \"versionNumber\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a13fc7ed-2b7b-4f12-a94e-342a19ae7b8b", "name": "Create Future Action Rule", "request": { "name": "Create Future Action Rule", "description": { "content": "Creates a new future action rule.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-future-action-rule" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-future-action-rule" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e88001a6-58a3-4305-97d7-db681ce25271", "name": "Created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-future-action-rule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a210ae2e-31ed-4bdb-822f-0f20cb8edf9e", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "create-future-action-rule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1cf67433-8c15-4c4c-b27a-e558c98bb48e", "name": "Create Future Action Rule Version", "request": { "name": "Create Future Action Rule Version", "description": { "content": "Creates a new draft version of a future action rule.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-future-action-rule-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-future-action-rule-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ruleId\": \"95962726-a661-535b-77db-ad1f77685afc\",\n \"versionNumber\": \"string\",\n \"ruleDefinition\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "941decb2-dbbc-49ae-acfc-64720ff5c216", "name": "Created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-future-action-rule-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ruleId\": \"95962726-a661-535b-77db-ad1f77685afc\",\n \"versionNumber\": \"string\",\n \"ruleDefinition\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0e5fe21-e94b-4bd2-8d0e-7af2521d4571", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "create-future-action-rule-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ruleId\": \"95962726-a661-535b-77db-ad1f77685afc\",\n \"versionNumber\": \"string\",\n \"ruleDefinition\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00db36c6-d230-409e-ba6c-6f4801aecf34", "name": "Future action rule not found.", "originalRequest": { "url": { "path": [ "transactional-api", "create-future-action-rule-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ruleId\": \"95962726-a661-535b-77db-ad1f77685afc\",\n \"versionNumber\": \"string\",\n \"ruleDefinition\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7d5e696-5be1-4e88-97f8-797b60eee104", "name": "Create Patient Questionnaire Template", "request": { "name": "Create Patient Questionnaire Template", "description": { "content": "Creates a new patient questionnaire template.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-patient-questionnaire-template" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-patient-questionnaire-template" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "35b4af26-3ac0-4abc-9e7e-e6182ace3727", "name": "Created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-patient-questionnaire-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4a95dfd-7175-4f92-a1eb-ee8cc15b19dd", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "create-patient-questionnaire-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c8707c87-5bb4-4761-bca8-ca9542e4f2d1", "name": "Create Patient Questionnaire Template Version", "request": { "name": "Create Patient Questionnaire Template Version", "description": { "content": "Creates a new draft version of a patient questionnaire template.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "create-patient-questionnaire-template-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/create-patient-questionnaire-template-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"templateId\": \"448d5783-d0e7-7b2f-8aff-bbd96b9f5ab7\",\n \"versionNumber\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "eae3102d-42e0-47aa-b101-9384005124b2", "name": "Created.", "originalRequest": { "url": { "path": [ "transactional-api", "create-patient-questionnaire-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"448d5783-d0e7-7b2f-8aff-bbd96b9f5ab7\",\n \"versionNumber\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63e31cb8-123e-4156-b498-22812ffbbf45", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "create-patient-questionnaire-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"448d5783-d0e7-7b2f-8aff-bbd96b9f5ab7\",\n \"versionNumber\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1bf4952-e78c-4f0b-b618-f824f9ef3418", "name": "Delete Communication Template Version", "request": { "name": "Delete Communication Template Version", "description": { "content": "Permanently deletes a draft version of a communication template.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "delete-communication-template-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/delete-communication-template-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3025c092-b434-46d2-a658-a08408804ab5", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "delete-communication-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de77070c-24a9-435b-b9ff-2d791dbccc70", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "delete-communication-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6415198-ee8e-46e1-8b08-2b49da76421e", "name": "Delete Custom Dashboard Version", "request": { "name": "Delete Custom Dashboard Version", "description": { "content": "Permanently deletes a draft version of a custom dashboard template.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "delete-custom-dashboard-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/delete-custom-dashboard-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "64289e81-c821-44a2-b281-b19021c6dd05", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "delete-custom-dashboard-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24bdeb44-714e-4211-9bf9-65f08d419010", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "delete-custom-dashboard-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f108d9c-50be-4b96-8819-6282b496dd01", "name": "Delete Data Entry Template Version", "request": { "name": "Delete Data Entry Template Version", "description": { "content": "Permanently deletes a draft version of a data entry template.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "delete-data-entry-template-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/delete-data-entry-template-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "94edf0f4-ed8c-4140-84f6-b99f66ce2090", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "delete-data-entry-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "823bde03-f234-477f-bca3-aa91eb3a3a78", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "delete-data-entry-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16e3dac7-4bac-4eb6-bc61-b609c7ca67f0", "name": "Data entry template version not found.", "originalRequest": { "url": { "path": [ "transactional-api", "delete-data-entry-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1683b92f-b88d-4d0a-9be3-69c26cab7b2a", "name": "Delete Document Template Version", "request": { "name": "Delete Document Template Version", "description": { "content": "Permanently deletes a draft version of a document form template.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "delete-document-template-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/delete-document-template-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ce4fee6b-2b41-46d9-9da3-ef23627d3721", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "delete-document-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5203f75-f32d-4c7c-b80c-b143beabc5c2", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "delete-document-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3672d104-c1b8-4b62-a324-79aa292f6ff2", "name": "Document form template version not found.", "originalRequest": { "url": { "path": [ "transactional-api", "delete-document-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90825505-0374-4bd1-b8e1-95717c21b0cb", "name": "Delete Future Action Rule Version", "request": { "name": "Delete Future Action Rule Version", "description": { "content": "Permanently deletes a draft version of a future action rule.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "delete-future-action-rule-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/delete-future-action-rule-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "08a48d66-63cd-49d2-980d-612bb22da233", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "delete-future-action-rule-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa673958-afa7-4a02-a5a8-ae0f2c96fb54", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "delete-future-action-rule-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b72d051f-23d7-4b22-9037-51c7a59bfe0a", "name": "Future action rule version not found.", "originalRequest": { "url": { "path": [ "transactional-api", "delete-future-action-rule-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ced3ed96-9f68-4b9a-a621-143a05b5b1b2", "name": "Delete Patient Questionnaire Template Version", "request": { "name": "Delete Patient Questionnaire Template Version", "description": { "content": "Permanently deletes a draft version of a patient questionnaire template.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "delete-patient-questionnaire-template-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/delete-patient-questionnaire-template-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3c32dfa7-3efa-47a3-9e5e-5ffef63c1f49", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "delete-patient-questionnaire-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ca878bc-d109-42ab-9b52-d1fab8aa4cbb", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "delete-patient-questionnaire-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b3f930bc-3353-c63a-8af3-c9d59aebb7c2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b18fc668-648a-4513-9a28-3c4a22b5e248", "name": "Get Communication Template Version", "request": { "name": "Get Communication Template Version", "description": { "content": "Returns the content and metadata for a specific communication template version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "get-communication-template-version" ], "host": [ "{{base_url}}" ], "query": [ { "disabled": false, "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a", "description": "(Required) " } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/get-communication-template-version" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9425f68c-4b85-423c-94ab-de796fe5dca7", "name": "Communication template version.", "originalRequest": { "url": { "path": [ "transactional-api", "get-communication-template-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5ba0c8ad-8be7-b9d8-85fe-6a4fbb78bbf1\",\n \"templateId\": \"5f8576ee-5516-4912-0d2c-e11f0d8993a9\",\n \"versionNumber\": \"string\",\n \"status\": \"draft\",\n \"content\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4089b66e-1732-4423-83c5-910b23b03882", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "get-communication-template-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-field\",\n \"description\": \"versionId must be a valid UUID.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f28485b-29d3-4ff1-bbf0-399fa55a5ee3", "name": "Version not found.", "originalRequest": { "url": { "path": [ "transactional-api", "get-communication-template-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd5004df-c2b0-4ea3-8ac9-1f3ac9a02f05", "name": "Get Content Package", "request": { "name": "Get Content Package", "description": { "content": "Returns a content package with all its item IDs grouped by resource type.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "get-content-package" ], "host": [ "{{base_url}}" ], "query": [ { "disabled": false, "key": "packageId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a", "description": "(Required) " } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/get-content-package" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9c88e1f6-23e7-4f03-8017-7e63efec4019", "name": "Content package detail.", "originalRequest": { "url": { "path": [ "transactional-api", "get-content-package" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "packageId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"2b3b8ef3-8c5e-dde4-d617-3d73ba4bc539\",\n \"name\": \"string\",\n \"status\": \"draft\",\n \"availability\": \"all_healthcare_organisations\",\n \"dataEntryTemplateIds\": [\n \"98890da2-c483-fe5f-17d9-57a78b7f8f35\",\n \"b2e8b03a-42b3-708f-1544-75f32455bb78\"\n ],\n \"patientQuestionnaireTemplateIds\": [\n \"03ebb83f-3f33-00c8-8917-1943cdc2c3d0\",\n \"2eaf331a-d8c5-36a5-27b2-22938bee0a26\"\n ],\n \"communicationTemplateIds\": [\n \"119f9a4b-0c78-2c35-b192-caa0706ef0ee\",\n \"c8afc6b1-ac7c-7526-005a-84841d3b9fbe\"\n ],\n \"documentFormTemplateIds\": [\n \"dace42e4-88f8-1272-49aa-44ed26ee6264\",\n \"a044dfbf-3654-fe4f-b8be-79a3c36ec1dd\"\n ],\n \"customDashboardIds\": [\n \"0c1be5b6-262c-30b8-3edc-8d513852721f\",\n \"feb7786a-c410-87d7-3c62-a8904cc6cd06\"\n ],\n \"futureActionRuleIds\": [\n \"4eec8359-6450-1bfe-870b-9500779612d7\",\n \"6a966d20-c1ad-b495-f8b2-67e1bc8580c6\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "640aa4bc-37e1-4eed-b3ec-c7e92c923baf", "name": "Package not found.", "originalRequest": { "url": { "path": [ "transactional-api", "get-content-package" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "packageId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "66c780a0-4f98-4db9-9243-8df42fbc1d84", "name": "Get Custom Dashboard Version", "request": { "name": "Get Custom Dashboard Version", "description": { "content": "Returns the content and metadata for a specific custom dashboard version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "get-custom-dashboard-version" ], "host": [ "{{base_url}}" ], "query": [ { "disabled": false, "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a", "description": "(Required) " } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/get-custom-dashboard-version" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6afd1ec7-d2f9-4ac5-9269-207c82963202", "name": "Custom dashboard version.", "originalRequest": { "url": { "path": [ "transactional-api", "get-custom-dashboard-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"d37af271-9c89-8011-55ec-1513b9a9980f\",\n \"dashboardId\": \"2493a3a6-4302-db0e-eb35-b70122771e8c\",\n \"versionNumber\": \"string\",\n \"status\": \"draft\",\n \"content\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7300d0bf-7e5d-4630-b27f-f43f35aad824", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "get-custom-dashboard-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-field\",\n \"description\": \"versionId must be a valid UUID.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "334419a7-e63d-4014-aea6-939017c5d778", "name": "Version not found.", "originalRequest": { "url": { "path": [ "transactional-api", "get-custom-dashboard-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0787b2be-f9ef-4b93-b667-a4d91a88ade0", "name": "Get Data Entry Template Version", "request": { "name": "Get Data Entry Template Version", "description": { "content": "Returns the content and metadata for a specific data entry template version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "get-data-entry-template-version" ], "host": [ "{{base_url}}" ], "query": [ { "disabled": false, "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a", "description": "(Required) " } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/get-data-entry-template-version" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "98f2ac29-f22b-4b0e-875d-5d6582d0fc51", "name": "Data entry template version.", "originalRequest": { "url": { "path": [ "transactional-api", "get-data-entry-template-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5ba0c8ad-8be7-b9d8-85fe-6a4fbb78bbf1\",\n \"templateId\": \"5f8576ee-5516-4912-0d2c-e11f0d8993a9\",\n \"versionNumber\": \"string\",\n \"status\": \"draft\",\n \"content\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c43f4fa-3617-4932-8f0f-ade6f95053f3", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "get-data-entry-template-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-field\",\n \"description\": \"versionId must be a valid UUID.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11ee8c36-cb6a-42c4-b7eb-3a926a059fd2", "name": "Version not found.", "originalRequest": { "url": { "path": [ "transactional-api", "get-data-entry-template-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "751948c5-31cb-4334-a563-ed90f8ff309f", "name": "Get Document Form Template Version", "request": { "name": "Get Document Form Template Version", "description": { "content": "Returns the content and metadata for a specific document form template version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "get-document-form-template-version" ], "host": [ "{{base_url}}" ], "query": [ { "disabled": false, "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a", "description": "(Required) " } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/get-document-form-template-version" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "30fe11d8-2a28-4459-82f2-5b49f9011b05", "name": "Document form template version.", "originalRequest": { "url": { "path": [ "transactional-api", "get-document-form-template-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"d2f4af88-c557-c1dc-e4e7-9eedc6aebf2e\",\n \"templateId\": \"db260d65-57a4-e8a3-4ea9-15b6403cf306\",\n \"versionNumber\": \"string\",\n \"status\": \"draft\",\n \"content\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "915b6da1-a764-41a2-87c8-34e3d4b766a9", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "get-document-form-template-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-field\",\n \"description\": \"versionId must be a valid UUID.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f84e461c-fb6f-436a-a03e-6bb3a3e884ea", "name": "Version not found.", "originalRequest": { "url": { "path": [ "transactional-api", "get-document-form-template-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "85dcbc09-f64b-4fff-9dfe-15d710236a75", "name": "Get Future Action Rule Version", "request": { "name": "Get Future Action Rule Version", "description": { "content": "Returns the rule definition and metadata for a specific future action rule version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "get-future-action-rule-version" ], "host": [ "{{base_url}}" ], "query": [ { "disabled": false, "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a", "description": "(Required) " } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/get-future-action-rule-version" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "35c2aeb7-6609-496b-bbbd-dac91ca414cb", "name": "Future action rule version.", "originalRequest": { "url": { "path": [ "transactional-api", "get-future-action-rule-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"391c11db-3801-4127-3ee1-4a2e074a20a3\",\n \"ruleId\": \"665d0492-7957-4c1c-888c-f4015dd78a2e\",\n \"versionNumber\": \"string\",\n \"status\": \"draft\",\n \"ruleDefinition\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a290202-eed6-4b07-9584-09615fb02e41", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "get-future-action-rule-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-field\",\n \"description\": \"versionId must be a valid UUID.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80e027cb-586f-481d-ae95-8cd05a1ad5e1", "name": "Version not found.", "originalRequest": { "url": { "path": [ "transactional-api", "get-future-action-rule-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "78b58b40-2d04-4bf5-84cb-f837b1663bfe", "name": "Get Patient Questionnaire Template Version", "request": { "name": "Get Patient Questionnaire Template Version", "description": { "content": "Returns the content and metadata for a specific patient questionnaire template version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "get-patient-questionnaire-template-version" ], "host": [ "{{base_url}}" ], "query": [ { "disabled": false, "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a", "description": "(Required) " } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/get-patient-questionnaire-template-version" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "91c8c4fe-4d84-4d20-856e-bf9d39d07bab", "name": "Patient questionnaire template version.", "originalRequest": { "url": { "path": [ "transactional-api", "get-patient-questionnaire-template-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5ba0c8ad-8be7-b9d8-85fe-6a4fbb78bbf1\",\n \"templateId\": \"5f8576ee-5516-4912-0d2c-e11f0d8993a9\",\n \"versionNumber\": \"string\",\n \"status\": \"draft\",\n \"content\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "585bda51-0c0e-43a1-9eea-f6a453c1f8cb", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "get-patient-questionnaire-template-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-field\",\n \"description\": \"versionId must be a valid UUID.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f2afa7a-772d-4fb5-b834-ba9e9fff86c4", "name": "Version not found.", "originalRequest": { "url": { "path": [ "transactional-api", "get-patient-questionnaire-template-version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a5472e1-1cc3-4ac8-96e1-59ba5c8f8e1f", "name": "List Communication Templates", "request": { "name": "List Communication Templates", "description": { "content": "Returns all communication templates with their current status and active version reference.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "list-communication-templates" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/list-communication-templates" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9872f861-f634-44f0-82cf-52070fc96cd6", "name": "Communication templates.", "originalRequest": { "url": { "path": [ "transactional-api", "list-communication-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"ab3f3503-7393-efcc-4ba0-c2533d4386fa\",\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"status\": \"draft\",\n \"currentVersionId\": \"2ed7c72e-be75-d09a-fcb3-7208a7f2ff41\"\n },\n {\n \"id\": \"a008bc6b-83b4-18ca-cab8-be34c66619aa\",\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"status\": \"draft\",\n \"currentVersionId\": \"7c42a95f-138c-d8d8-40c3-559084c7ae38\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "afafe2f3-ae34-495f-b0d7-293d9a4aa145", "name": "List Content Packages", "request": { "name": "List Content Packages", "description": { "content": "Returns all content packages with their status and availability.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "list-content-packages" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/list-content-packages" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d2004ebf-49db-4be9-8015-65f72169fada", "name": "Content packages.", "originalRequest": { "url": { "path": [ "transactional-api", "list-content-packages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"c90c3d8d-02f7-f2b9-4dd5-8f6cc3b38422\",\n \"name\": \"string\",\n \"status\": \"draft\",\n \"availability\": \"all_healthcare_organisations\"\n },\n {\n \"id\": \"91e4e479-5711-81a1-7ac4-765b056cd8fa\",\n \"name\": \"string\",\n \"status\": \"draft\",\n \"availability\": \"all_healthcare_organisations\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e5fe12f-349e-4ce4-8805-1fdc72423d9b", "name": "List Custom Dashboards", "request": { "name": "List Custom Dashboards", "description": { "content": "Returns all custom dashboards with their current status and active version reference.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "list-custom-dashboards" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/list-custom-dashboards" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "23033804-c6e3-49e8-bb57-33fbf068496b", "name": "Custom dashboards.", "originalRequest": { "url": { "path": [ "transactional-api", "list-custom-dashboards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"ab3f3503-7393-efcc-4ba0-c2533d4386fa\",\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"status\": \"draft\",\n \"currentVersionId\": \"2ed7c72e-be75-d09a-fcb3-7208a7f2ff41\"\n },\n {\n \"id\": \"a008bc6b-83b4-18ca-cab8-be34c66619aa\",\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"status\": \"draft\",\n \"currentVersionId\": \"7c42a95f-138c-d8d8-40c3-559084c7ae38\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aae1088f-b1f4-4f4a-86e6-8baf67fd9612", "name": "List Data Entry Templates", "request": { "name": "List Data Entry Templates", "description": { "content": "Returns all data entry templates with their current status and active version reference.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "list-data-entry-templates" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/list-data-entry-templates" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e52b7d9a-c0b8-4510-90f0-972bde8da2ec", "name": "Data entry templates.", "originalRequest": { "url": { "path": [ "transactional-api", "list-data-entry-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"3cd11b2a-31ca-5222-dae8-5641c03cfe23\",\n \"name\": \"string\",\n \"status\": \"draft\",\n \"currentVersionId\": \"fa05f7e6-1a4e-366a-eda9-6be4f200fcb8\"\n },\n {\n \"id\": \"64d6a4bd-00f5-03cb-b44a-f73b861c8b8b\",\n \"name\": \"string\",\n \"status\": \"draft\",\n \"currentVersionId\": \"9448c1cd-a683-3859-d43c-5bc2c408ac49\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "099a8311-8f5c-419d-981c-d8e92433bc53", "name": "List Document Form Templates", "request": { "name": "List Document Form Templates", "description": { "content": "Returns all document form templates with their current status and active version reference.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "list-document-form-templates" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/list-document-form-templates" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "8a5ccd06-4a21-4f31-a0e5-8cde5af9c12d", "name": "Document form templates.", "originalRequest": { "url": { "path": [ "transactional-api", "list-document-form-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"5f5d6514-9fc7-2098-b6e3-0e6cd57f0e15\",\n \"name\": \"string\",\n \"type\": \"document\",\n \"status\": \"draft\",\n \"currentVersionId\": \"1d73d581-047d-6520-7b6f-fb8a41599ceb\"\n },\n {\n \"id\": \"c1df3d47-41a2-76b9-e194-5d98dfddfee9\",\n \"name\": \"string\",\n \"type\": \"document\",\n \"status\": \"draft\",\n \"currentVersionId\": \"ed5ed88f-f7ac-cef7-e069-f5e297f3f515\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e35cbd14-748e-45e2-8a5e-523c1cc1e68d", "name": "List Future Action Rules", "request": { "name": "List Future Action Rules", "description": { "content": "Returns all future action rules with their current authoring status and active version reference.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "list-future-action-rules" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/list-future-action-rules" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2e9d6fdd-5f5a-4882-9b14-0ad9853dbb43", "name": "Future action rules.", "originalRequest": { "url": { "path": [ "transactional-api", "list-future-action-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"0a46ecdc-deda-e049-cf85-8e1f5eee3892\",\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"status\": \"draft\",\n \"currentVersionId\": \"450ddf7a-2357-c201-e111-82bcf7ddcd7b\"\n },\n {\n \"id\": \"9846ece9-b48f-c038-90e7-0f841a76d39b\",\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"status\": \"draft\",\n \"currentVersionId\": \"e922a256-c234-9627-2622-c3430669f917\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f538d93-0eb9-4e4a-9bc6-301ef3f6170f", "name": "List Patient Questionnaire Templates", "request": { "name": "List Patient Questionnaire Templates", "description": { "content": "Returns all patient questionnaire templates with their current status and active version reference.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "list-patient-questionnaire-templates" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/list-patient-questionnaire-templates" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e7ea3b32-b87c-48e7-ac2d-514b1f7c549e", "name": "Patient questionnaire templates.", "originalRequest": { "url": { "path": [ "transactional-api", "list-patient-questionnaire-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"ab3f3503-7393-efcc-4ba0-c2533d4386fa\",\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"status\": \"draft\",\n \"currentVersionId\": \"2ed7c72e-be75-d09a-fcb3-7208a7f2ff41\"\n },\n {\n \"id\": \"a008bc6b-83b4-18ca-cab8-be34c66619aa\",\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"status\": \"draft\",\n \"currentVersionId\": \"7c42a95f-138c-d8d8-40c3-559084c7ae38\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "55cb5e07-4a94-49d0-98a4-6518a9d2fff3", "name": "Publish Communication Template Version", "request": { "name": "Publish Communication Template Version", "description": { "content": "Publishes a draft version of a communication template, making it the active version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "publish-communication-template-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/publish-communication-template-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"templateId\": \"f64061b4-0113-774d-5d61-d24ab28bc151\",\n \"versionId\": \"5cfbcf00-fe9f-c575-e5d9-246752ab96a8\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "aa6c6551-db8e-4a88-aa37-5436cc2da173", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-communication-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"f64061b4-0113-774d-5d61-d24ab28bc151\",\n \"versionId\": \"5cfbcf00-fe9f-c575-e5d9-246752ab96a8\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "992e2748-b2fb-4d21-99b3-f5ecfc98c86f", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-communication-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"f64061b4-0113-774d-5d61-d24ab28bc151\",\n \"versionId\": \"5cfbcf00-fe9f-c575-e5d9-246752ab96a8\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1567dbea-c056-462d-a4d5-a478496932df", "name": "Template not found.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-communication-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"f64061b4-0113-774d-5d61-d24ab28bc151\",\n \"versionId\": \"5cfbcf00-fe9f-c575-e5d9-246752ab96a8\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "de0f5f2a-9b19-4d59-bdd3-29c6f0cf38e3", "name": "Publish Content Package", "request": { "name": "Publish Content Package", "description": { "content": "Publishes a content package, making it available for distribution to subscribed organisations.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "publish-content-package" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/publish-content-package" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"packageId\": \"d022b155-7c63-6d82-fb65-d8c402c1806a\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0f845a88-8ff3-4bac-bb84-03db61350253", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-content-package" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"packageId\": \"d022b155-7c63-6d82-fb65-d8c402c1806a\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b24dc51d-cdb4-4f93-a281-699af0aa194f", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-content-package" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"packageId\": \"d022b155-7c63-6d82-fb65-d8c402c1806a\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "385e70f8-1746-4785-8a92-5483e42fcd63", "name": "Content package not found.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-content-package" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"packageId\": \"d022b155-7c63-6d82-fb65-d8c402c1806a\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a1de0117-c05b-4664-beb9-89b1d4380cbf", "name": "Publish Custom Dashboard Version", "request": { "name": "Publish Custom Dashboard Version", "description": { "content": "Publishes a draft version of a custom dashboard template, making it the active version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "publish-custom-dashboard-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/publish-custom-dashboard-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"dashboardId\": \"7a9711de-b6b2-4f88-4903-16ad1a2c9b35\",\n \"versionId\": \"230194e1-becc-88eb-a0c0-aed1847d3d44\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8a198b54-f5fb-48c5-b1ce-adf6d379f3fa", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-custom-dashboard-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dashboardId\": \"7a9711de-b6b2-4f88-4903-16ad1a2c9b35\",\n \"versionId\": \"230194e1-becc-88eb-a0c0-aed1847d3d44\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d034f82-85f9-4a5e-b96e-abd946d99635", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-custom-dashboard-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dashboardId\": \"7a9711de-b6b2-4f88-4903-16ad1a2c9b35\",\n \"versionId\": \"230194e1-becc-88eb-a0c0-aed1847d3d44\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "985bd240-d02e-4b9d-8f53-8001097bd9e0", "name": "Dashboard not found.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-custom-dashboard-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dashboardId\": \"7a9711de-b6b2-4f88-4903-16ad1a2c9b35\",\n \"versionId\": \"230194e1-becc-88eb-a0c0-aed1847d3d44\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "458b9713-a79d-4c91-91e8-e8bd6a06dc81", "name": "Publish Data Entry Template Version", "request": { "name": "Publish Data Entry Template Version", "description": { "content": "Publishes a draft version of a data entry template, making it the active version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "publish-data-entry-template-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/publish-data-entry-template-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"templateId\": \"3a2a7c25-fb21-1eb6-83dd-eac696fd2e9e\",\n \"versionId\": \"336af248-03b9-83c7-3d28-f593c88489cd\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2481b8e5-4ecd-4fb9-adeb-6e942fe0d21b", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-data-entry-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"3a2a7c25-fb21-1eb6-83dd-eac696fd2e9e\",\n \"versionId\": \"336af248-03b9-83c7-3d28-f593c88489cd\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f87cb02e-cf69-45cb-9dd7-826d4a420ddc", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-data-entry-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"3a2a7c25-fb21-1eb6-83dd-eac696fd2e9e\",\n \"versionId\": \"336af248-03b9-83c7-3d28-f593c88489cd\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd33cfe2-3c2c-4617-a72a-fd5a426e3974", "name": "Template not found.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-data-entry-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"3a2a7c25-fb21-1eb6-83dd-eac696fd2e9e\",\n \"versionId\": \"336af248-03b9-83c7-3d28-f593c88489cd\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7014cd7f-5ab7-4a22-8249-b17126da1541", "name": "Publish Document Form Template Version", "request": { "name": "Publish Document Form Template Version", "description": { "content": "Publishes a draft version of a document form template, making it the active version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "publish-document-form-template-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/publish-document-form-template-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"templateId\": \"82d00c22-3b5a-eef6-067f-8a3d2f21840b\",\n \"versionId\": \"04a56ef8-7cd8-32c9-15ff-55db8c4a4330\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "03373ea0-3ce9-4035-aa83-bbf345f47225", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-document-form-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"82d00c22-3b5a-eef6-067f-8a3d2f21840b\",\n \"versionId\": \"04a56ef8-7cd8-32c9-15ff-55db8c4a4330\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9655d23-d81a-4cb1-b1c6-4382356dfcff", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-document-form-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"82d00c22-3b5a-eef6-067f-8a3d2f21840b\",\n \"versionId\": \"04a56ef8-7cd8-32c9-15ff-55db8c4a4330\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eeb9fef7-c257-430a-bf8b-e813cd8d6426", "name": "Template not found.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-document-form-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"82d00c22-3b5a-eef6-067f-8a3d2f21840b\",\n \"versionId\": \"04a56ef8-7cd8-32c9-15ff-55db8c4a4330\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f3a17244-2ee7-4572-8fda-8ecc96fc607e", "name": "Publish Future Action Rule Version", "request": { "name": "Publish Future Action Rule Version", "description": { "content": "Publishes a draft version of a future action rule, making it the active version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "publish-future-action-rule-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/publish-future-action-rule-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ruleId\": \"9044a882-deaf-6456-84fd-970d3610b14d\",\n \"versionId\": \"f3b93d27-4fd2-3fbf-d212-40fbce91496d\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "24cda55c-2044-4bc3-a0da-81e59b500fac", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-future-action-rule-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ruleId\": \"9044a882-deaf-6456-84fd-970d3610b14d\",\n \"versionId\": \"f3b93d27-4fd2-3fbf-d212-40fbce91496d\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ede38dbc-d769-4726-8e53-132175b5c6cc", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-future-action-rule-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ruleId\": \"9044a882-deaf-6456-84fd-970d3610b14d\",\n \"versionId\": \"f3b93d27-4fd2-3fbf-d212-40fbce91496d\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dfb8161-45c1-4b87-9703-c11465f70590", "name": "Future action rule version not found.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-future-action-rule-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ruleId\": \"9044a882-deaf-6456-84fd-970d3610b14d\",\n \"versionId\": \"f3b93d27-4fd2-3fbf-d212-40fbce91496d\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88fc9677-aff5-4c9a-a1cb-b3dd1e048b3f", "name": "Publish Patient Questionnaire Template Version", "request": { "name": "Publish Patient Questionnaire Template Version", "description": { "content": "Publishes a draft version of a patient questionnaire template, making it the active version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "publish-patient-questionnaire-template-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/publish-patient-questionnaire-template-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"templateId\": \"dffefefd-61a1-d530-242f-cbf1a91aa89d\",\n \"versionId\": \"c4eb0915-a9e6-b977-273e-7cefb6dbce80\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bc66f2cb-1934-4293-945f-026f237be371", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-patient-questionnaire-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"dffefefd-61a1-d530-242f-cbf1a91aa89d\",\n \"versionId\": \"c4eb0915-a9e6-b977-273e-7cefb6dbce80\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7414333b-e7e7-44c2-9f75-fb226a65f729", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-patient-questionnaire-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"dffefefd-61a1-d530-242f-cbf1a91aa89d\",\n \"versionId\": \"c4eb0915-a9e6-b977-273e-7cefb6dbce80\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8255344-9569-4180-8d81-1c0a201860e8", "name": "Template not found.", "originalRequest": { "url": { "path": [ "transactional-api", "publish-patient-questionnaire-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"dffefefd-61a1-d530-242f-cbf1a91aa89d\",\n \"versionId\": \"c4eb0915-a9e6-b977-273e-7cefb6dbce80\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90af23e9-367c-4905-b8f9-6ff379d84591", "name": "Set Content Package Items", "request": { "name": "Set Content Package Items", "description": { "content": "Sets the complete list of resource items included in a content package, replacing any existing items.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "set-content-package-items" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/set-content-package-items" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"packageId\": \"98d5d53d-bda5-60fd-efe1-4e92005909cc\",\n \"type\": \"future-action-rule\",\n \"ids\": [\n \"b84f9783-1e63-4d7d-30cc-4327c5a86c7e\",\n \"d661d06a-b6a7-f97b-dcc5-395a216c68d4\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3c47283f-2279-431f-83bc-af8b0cf2ea65", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "set-content-package-items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"packageId\": \"442010a9-0e58-bf95-f560-9a849d4e4d58\",\n \"type\": \"patient-questionnaire\",\n \"ids\": [\n \"91cd4d2a-cc9b-d584-5b36-cc940d52434c\",\n \"5cb6b005-e392-f980-f305-e10399c1a859\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae86350d-b111-40c7-af22-1550b48acb4d", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "set-content-package-items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"packageId\": \"442010a9-0e58-bf95-f560-9a849d4e4d58\",\n \"type\": \"patient-questionnaire\",\n \"ids\": [\n \"91cd4d2a-cc9b-d584-5b36-cc940d52434c\",\n \"5cb6b005-e392-f980-f305-e10399c1a859\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c63a015e-ae99-4633-8b90-46a898884339", "name": "Content package not found.", "originalRequest": { "url": { "path": [ "transactional-api", "set-content-package-items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"packageId\": \"442010a9-0e58-bf95-f560-9a849d4e4d58\",\n \"type\": \"patient-questionnaire\",\n \"ids\": [\n \"91cd4d2a-cc9b-d584-5b36-cc940d52434c\",\n \"5cb6b005-e392-f980-f305-e10399c1a859\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c3ef5be-8375-41ea-b0ff-59b3c7b27f05", "name": "Update Communication Template Version", "request": { "name": "Update Communication Template Version", "description": { "content": "Updates the content of a draft communication template version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "update-communication-template-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/update-communication-template-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"versionId\": \"5eef63aa-2205-6b82-f596-2cb7087f9964\",\n \"content\": \"string\",\n \"clinicalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "199a71af-3771-44fa-914e-02f9d0886836", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "update-communication-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"5eef63aa-2205-6b82-f596-2cb7087f9964\",\n \"content\": \"string\",\n \"clinicalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f601e7df-a53b-4eb8-92bc-31903b572d55", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "update-communication-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"5eef63aa-2205-6b82-f596-2cb7087f9964\",\n \"content\": \"string\",\n \"clinicalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa2673f7-195a-45fc-bbce-58826b10ebe6", "name": "Update Content Package", "request": { "name": "Update Content Package", "description": { "content": "Updates the name, description, or availability settings of a content package.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "update-content-package" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/update-content-package" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"packageId\": \"58956e93-840a-9efa-99d2-09ee8f11988c\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"availability\": \"all_healthcare_organisations\",\n \"availableToTenants\": [\n \"140a896d-26ad-f7ae-8499-0255551ea95c\",\n \"ef670a5e-8053-ac73-c511-57aaa6524a40\"\n ],\n \"availableToOdsCodes\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9e309350-cae4-4e9d-b3f4-9f575ed0fe6c", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "update-content-package" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"packageId\": \"2b5e8a96-0a85-94aa-8fff-6d9ab2a8efb8\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"availability\": \"all_healthcare_organisations\",\n \"availableToTenants\": [\n \"2daf7662-8320-295a-6a45-881f0f29f3fa\",\n \"26c018e3-360c-2d29-83c9-c2c34eafea9e\"\n ],\n \"availableToOdsCodes\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67e8ef9a-a142-4616-88c8-49b399e239a8", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "update-content-package" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"packageId\": \"2b5e8a96-0a85-94aa-8fff-6d9ab2a8efb8\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"availability\": \"all_healthcare_organisations\",\n \"availableToTenants\": [\n \"2daf7662-8320-295a-6a45-881f0f29f3fa\",\n \"26c018e3-360c-2d29-83c9-c2c34eafea9e\"\n ],\n \"availableToOdsCodes\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "591e3460-1cbd-45b5-aeaf-daa20b375b69", "name": "Content package not found.", "originalRequest": { "url": { "path": [ "transactional-api", "update-content-package" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"packageId\": \"2b5e8a96-0a85-94aa-8fff-6d9ab2a8efb8\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"availability\": \"all_healthcare_organisations\",\n \"availableToTenants\": [\n \"2daf7662-8320-295a-6a45-881f0f29f3fa\",\n \"26c018e3-360c-2d29-83c9-c2c34eafea9e\"\n ],\n \"availableToOdsCodes\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "29d49f34-99da-4896-8dd2-92e6f10173ba", "name": "Update Custom Dashboard Version", "request": { "name": "Update Custom Dashboard Version", "description": { "content": "Updates the content of a draft custom dashboard version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "update-custom-dashboard-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/update-custom-dashboard-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"versionId\": \"6fa1c4b8-57f7-51e6-9d5a-d54d1f097294\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1000b361-108c-455a-9296-0e5dd3f5fe18", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "update-custom-dashboard-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"6fa1c4b8-57f7-51e6-9d5a-d54d1f097294\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "626ab774-2fc8-4028-982c-9d9f3a26d838", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "update-custom-dashboard-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"6fa1c4b8-57f7-51e6-9d5a-d54d1f097294\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3221884d-e003-4903-b936-394e93674417", "name": "Update Data Entry Template Version", "request": { "name": "Update Data Entry Template Version", "description": { "content": "Updates the content of a draft data entry template version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "update-data-entry-template-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/update-data-entry-template-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"versionId\": \"e486d588-0375-2c81-ed9d-ecd7ec5e79a3\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "de8814cf-0f52-4856-aae8-5ac7a87107eb", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "update-data-entry-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"e486d588-0375-2c81-ed9d-ecd7ec5e79a3\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "324cc735-a23a-43ff-beec-a1cc4e3e033a", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "update-data-entry-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"e486d588-0375-2c81-ed9d-ecd7ec5e79a3\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a92dd4b8-5ac1-44d7-9ce1-3f96592a2d44", "name": "Data entry template version not found.", "originalRequest": { "url": { "path": [ "transactional-api", "update-data-entry-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"e486d588-0375-2c81-ed9d-ecd7ec5e79a3\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ca64cc8c-e851-4b7c-9aef-f96636b0462f", "name": "Update Document Template Version", "request": { "name": "Update Document Template Version", "description": { "content": "Updates the content of a draft document form template version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "update-document-template-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/update-document-template-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"versionId\": \"e486d588-0375-2c81-ed9d-ecd7ec5e79a3\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2ba72964-1050-459f-a60e-d29f5f3a44a5", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "update-document-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"e486d588-0375-2c81-ed9d-ecd7ec5e79a3\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6b168d5-ac08-4e42-a127-319ec7ab2384", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "update-document-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"e486d588-0375-2c81-ed9d-ecd7ec5e79a3\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a192eea2-7c9d-48b3-a1c4-a373e83d4751", "name": "Document form template version not found.", "originalRequest": { "url": { "path": [ "transactional-api", "update-document-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"e486d588-0375-2c81-ed9d-ecd7ec5e79a3\",\n \"content\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c256bbdc-2073-4721-9d6e-75f0c77c93ef", "name": "Update Future Action Rule Version", "request": { "name": "Update Future Action Rule Version", "description": { "content": "Updates the rule definition of a draft future action rule version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "update-future-action-rule-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/update-future-action-rule-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b22b4be4-198e-667d-5d90-d3b1596a935b\",\n \"ruleDefinition\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "809c97f0-98e1-42bf-92eb-418430487113", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "update-future-action-rule-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b22b4be4-198e-667d-5d90-d3b1596a935b\",\n \"ruleDefinition\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65c3322c-76fd-4f3b-8ee9-017fa139ed39", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "update-future-action-rule-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b22b4be4-198e-667d-5d90-d3b1596a935b\",\n \"ruleDefinition\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c0dd4a7-079b-4c07-8bab-6fc5071d59b2", "name": "Future action rule version not found.", "originalRequest": { "url": { "path": [ "transactional-api", "update-future-action-rule-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b22b4be4-198e-667d-5d90-d3b1596a935b\",\n \"ruleDefinition\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec4a1466-d0a7-4d0d-b0f3-238d7aeb9238", "name": "Update Patient Questionnaire Template Version", "request": { "name": "Update Patient Questionnaire Template Version", "description": { "content": "Updates the content of a draft patient questionnaire template version.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "update-patient-questionnaire-template-version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/update-patient-questionnaire-template-version" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b993930c-bb89-d5f0-5e33-e653a1741ec5\",\n \"content\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "07ab29bd-34a6-46ef-a214-3f89f50a3ab7", "name": "Success.", "originalRequest": { "url": { "path": [ "transactional-api", "update-patient-questionnaire-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b993930c-bb89-d5f0-5e33-e653a1741ec5\",\n \"content\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7545b80-1084-4c9e-aba6-5460bcc81248", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "transactional-api", "update-patient-questionnaire-template-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionId\": \"b993930c-bb89-d5f0-5e33-e653a1741ec5\",\n \"content\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"missing-required-field\",\n \"description\": \"fieldName is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "724c0d23-6c3e-4b6c-b761-97c80841659a", "name": "Workflow", "description": { "content": "Workflow", "type": "text/plain" }, "item": [ { "id": "5a273885-7e3c-40e9-9c00-11bf5ff3f1d0", "name": "File Investigation Report", "request": { "name": "File Investigation Report", "description": { "content": "Files a PENDING investigation report by resolving the associated review task. Optional filing comments may be provided for specific groups or results. Investigation request items may be marked as fulfilled.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "file-investigation-report" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/file-investigation-report" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"reportId\": \"e8a468be-021d-e833-27b3-861f242df8a2\",\n \"groupFilingComments\": [\n {\n \"groupId\": \"fd21db1e-5c38-e142-92be-694495401db9\",\n \"comment\": \"string\"\n },\n {\n \"groupId\": \"28261aa2-c6e7-b114-e114-72fd332ebb84\",\n \"comment\": \"string\"\n }\n ],\n \"resultFilingComments\": [\n {\n \"resultId\": \"3d0ca17c-cd13-3fc3-9614-91b6fbfa8ef5\",\n \"comment\": \"string\"\n },\n {\n \"resultId\": \"9d6fdbd3-bac7-507b-44fe-15e4c151ba64\",\n \"comment\": \"string\"\n }\n ],\n \"fulfilledInvestigationRequestIds\": [\n \"15de9025-c92d-4d4f-a026-a90170f40e2f\",\n \"0356e1ad-513c-08d8-6e6c-537f374fbdaa\"\n ],\n \"reportFilingComment\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c0f84f6c-b90b-475f-bba2-714ef4438cb2", "name": "Investigation report filed successfully.", "originalRequest": { "url": { "path": [ "transactional-api", "file-investigation-report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reportId\": \"4b3a943c-98f2-5678-ab65-09b2fc0529e9\",\n \"groupFilingComments\": [\n {\n \"groupId\": \"5fe55346-12fd-8be4-48fa-fe1dbdf52a6d\",\n \"comment\": \"string\"\n },\n {\n \"groupId\": \"72e301b2-218c-5c39-e425-47ec3f23f536\",\n \"comment\": \"string\"\n }\n ],\n \"resultFilingComments\": [\n {\n \"resultId\": \"421cc99e-ae9f-e045-f819-781fef66e487\",\n \"comment\": \"string\"\n },\n {\n \"resultId\": \"0d14cb2b-9a7a-9a4f-2169-1aa545db17d3\",\n \"comment\": \"string\"\n }\n ],\n \"fulfilledInvestigationRequestIds\": [\n \"93f91dac-cc21-78f0-51d7-5aaa5320ac79\",\n \"59fae0bc-411e-ff98-a572-277be884c2e0\"\n ],\n \"reportFilingComment\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9093ba68-83f4-4229-b167-b158dca0b6d2", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "file-investigation-report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reportId\": \"4b3a943c-98f2-5678-ab65-09b2fc0529e9\",\n \"groupFilingComments\": [\n {\n \"groupId\": \"5fe55346-12fd-8be4-48fa-fe1dbdf52a6d\",\n \"comment\": \"string\"\n },\n {\n \"groupId\": \"72e301b2-218c-5c39-e425-47ec3f23f536\",\n \"comment\": \"string\"\n }\n ],\n \"resultFilingComments\": [\n {\n \"resultId\": \"421cc99e-ae9f-e045-f819-781fef66e487\",\n \"comment\": \"string\"\n },\n {\n \"resultId\": \"0d14cb2b-9a7a-9a4f-2169-1aa545db17d3\",\n \"comment\": \"string\"\n }\n ],\n \"fulfilledInvestigationRequestIds\": [\n \"93f91dac-cc21-78f0-51d7-5aaa5320ac79\",\n \"59fae0bc-411e-ff98-a572-277be884c2e0\"\n ],\n \"reportFilingComment\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-report-id\",\n \"description\": \"The reportId is not a UUID.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14ca0a4d-06b8-4366-99a8-501026c4baa5", "name": "Forbidden: the calling application does not have the required permission.", "originalRequest": { "url": { "path": [ "transactional-api", "file-investigation-report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reportId\": \"4b3a943c-98f2-5678-ab65-09b2fc0529e9\",\n \"groupFilingComments\": [\n {\n \"groupId\": \"5fe55346-12fd-8be4-48fa-fe1dbdf52a6d\",\n \"comment\": \"string\"\n },\n {\n \"groupId\": \"72e301b2-218c-5c39-e425-47ec3f23f536\",\n \"comment\": \"string\"\n }\n ],\n \"resultFilingComments\": [\n {\n \"resultId\": \"421cc99e-ae9f-e045-f819-781fef66e487\",\n \"comment\": \"string\"\n },\n {\n \"resultId\": \"0d14cb2b-9a7a-9a4f-2169-1aa545db17d3\",\n \"comment\": \"string\"\n }\n ],\n \"fulfilledInvestigationRequestIds\": [\n \"93f91dac-cc21-78f0-51d7-5aaa5320ac79\",\n \"59fae0bc-411e-ff98-a572-277be884c2e0\"\n ],\n \"reportFilingComment\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"forbidden\",\n \"description\": \"The calling application does not have permission to use this endpoint.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3868d54a-2eda-4a66-a0db-8a7e078a7d50", "name": "The report, a group, or a result was not found.", "originalRequest": { "url": { "path": [ "transactional-api", "file-investigation-report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reportId\": \"4b3a943c-98f2-5678-ab65-09b2fc0529e9\",\n \"groupFilingComments\": [\n {\n \"groupId\": \"5fe55346-12fd-8be4-48fa-fe1dbdf52a6d\",\n \"comment\": \"string\"\n },\n {\n \"groupId\": \"72e301b2-218c-5c39-e425-47ec3f23f536\",\n \"comment\": \"string\"\n }\n ],\n \"resultFilingComments\": [\n {\n \"resultId\": \"421cc99e-ae9f-e045-f819-781fef66e487\",\n \"comment\": \"string\"\n },\n {\n \"resultId\": \"0d14cb2b-9a7a-9a4f-2169-1aa545db17d3\",\n \"comment\": \"string\"\n }\n ],\n \"fulfilledInvestigationRequestIds\": [\n \"93f91dac-cc21-78f0-51d7-5aaa5320ac79\",\n \"59fae0bc-411e-ff98-a572-277be884c2e0\"\n ],\n \"reportFilingComment\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"investigation-report-not-found\",\n \"description\": \"Investigation report not found for this reportId.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a39a163-0301-4046-b827-e61957c795ef", "name": "The report exists but is not in PENDING status.", "originalRequest": { "url": { "path": [ "transactional-api", "file-investigation-report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reportId\": \"4b3a943c-98f2-5678-ab65-09b2fc0529e9\",\n \"groupFilingComments\": [\n {\n \"groupId\": \"5fe55346-12fd-8be4-48fa-fe1dbdf52a6d\",\n \"comment\": \"string\"\n },\n {\n \"groupId\": \"72e301b2-218c-5c39-e425-47ec3f23f536\",\n \"comment\": \"string\"\n }\n ],\n \"resultFilingComments\": [\n {\n \"resultId\": \"421cc99e-ae9f-e045-f819-781fef66e487\",\n \"comment\": \"string\"\n },\n {\n \"resultId\": \"0d14cb2b-9a7a-9a4f-2169-1aa545db17d3\",\n \"comment\": \"string\"\n }\n ],\n \"fulfilledInvestigationRequestIds\": [\n \"93f91dac-cc21-78f0-51d7-5aaa5320ac79\",\n \"59fae0bc-411e-ff98-a572-277be884c2e0\"\n ],\n \"reportFilingComment\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"investigation-report-not-pending\",\n \"description\": \"This investigation report is not in PENDING status and cannot be filed.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4df24565-16f3-475f-9add-c1cd1f69c9d8", "name": "The report contains free-text results and cannot be filed via this API.", "originalRequest": { "url": { "path": [ "transactional-api", "file-investigation-report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reportId\": \"4b3a943c-98f2-5678-ab65-09b2fc0529e9\",\n \"groupFilingComments\": [\n {\n \"groupId\": \"5fe55346-12fd-8be4-48fa-fe1dbdf52a6d\",\n \"comment\": \"string\"\n },\n {\n \"groupId\": \"72e301b2-218c-5c39-e425-47ec3f23f536\",\n \"comment\": \"string\"\n }\n ],\n \"resultFilingComments\": [\n {\n \"resultId\": \"421cc99e-ae9f-e045-f819-781fef66e487\",\n \"comment\": \"string\"\n },\n {\n \"resultId\": \"0d14cb2b-9a7a-9a4f-2169-1aa545db17d3\",\n \"comment\": \"string\"\n }\n ],\n \"fulfilledInvestigationRequestIds\": [\n \"93f91dac-cc21-78f0-51d7-5aaa5320ac79\",\n \"59fae0bc-411e-ff98-a572-277be884c2e0\"\n ],\n \"reportFilingComment\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"investigation-report-has-text-results\",\n \"description\": \"This investigation report contains free-text results and cannot be filed via this API.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea7311da-29fc-4036-8a62-c9ab697772a1", "name": "Get Investigation Report", "request": { "name": "Get Investigation Report", "description": { "content": "Returns the full detail of a single PENDING investigation report.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "get-investigation-report" ], "host": [ "{{base_url}}" ], "query": [ { "disabled": false, "key": "reportId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a", "description": "(Required) The UUID of the investigation report to retrieve." } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/get-investigation-report" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1940e0c3-ee0d-42b8-baf0-ab47d1eaa905", "name": "Investigation report detail.", "originalRequest": { "url": { "path": [ "transactional-api", "get-investigation-report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "reportId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"reportId\": \"dcab82fe-ac9a-6ad1-1d6f-2bf18e0afe34\",\n \"patientId\": \"1266923c-c76f-55c0-19f8-17949868848a\",\n \"displayDescription\": \"string\",\n \"receivedDateTime\": \"2024-01-15 09:30:00\",\n \"issuedDateTime\": \"2024-01-15 09:30:00\",\n \"requestedByOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"nhs-england-ods-code\",\n \"identifierValue\": \"string\"\n },\n \"requestedByPractitioner\": {\n \"displayName\": \"string\",\n \"identifierType\": \"medicus-referral-provider-practitioner-id\",\n \"identifierValue\": \"string\"\n },\n \"performedByOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"medicus-tenant-id\",\n \"identifierValue\": \"string\"\n },\n \"performedByPractitioner\": {\n \"displayName\": \"string\",\n \"identifierType\": \"gb-nhs-gp-connect-practitioner-id\",\n \"identifierValue\": \"string\"\n },\n \"requesterComments\": \"string\",\n \"performerComments\": \"string\",\n \"reportIdentifier\": \"string\",\n \"filingComments\": [\n {\n \"commentId\": \"071a5944-72c8-f370-26d7-0c4fbcea1257\",\n \"comment\": \"string\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"string\",\n \"identifierType\": \"gb-hcpc-number\",\n \"identifierValue\": \"string\"\n },\n \"recordAuthorOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"nhs-england-ods-code\",\n \"identifierValue\": \"string\"\n }\n },\n {\n \"commentId\": \"4e564509-a4eb-5d88-afdb-b30fba4c4364\",\n \"comment\": \"string\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"string\",\n \"identifierType\": \"sds-user-id\",\n \"identifierValue\": \"string\"\n },\n \"recordAuthorOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"nhs-england-ods-code\",\n \"identifierValue\": \"string\"\n }\n }\n ],\n \"investigationGroups\": [\n {\n \"groupId\": \"4a255f04-b1fc-f015-2e58-0af94438d4b1\",\n \"type\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"performerComments\": \"string\",\n \"results\": [\n {\n \"resultId\": \"d1a0cd2a-7785-4831-0dff-6d919fc80411\",\n \"type\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultCode\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultValue\": \"string\",\n \"resultUnit\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultComparator\": \"<=\",\n \"resultStatus\": \"final\",\n \"interpretation\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"referenceRanges\": [\n {\n \"lowerReferenceLimit\": \"string\",\n \"upperReferenceLimit\": \"string\",\n \"description\": \"string\"\n },\n {\n \"lowerReferenceLimit\": \"string\",\n \"upperReferenceLimit\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"issuedDateTime\": \"2024-01-15 09:30:00\",\n \"performedDateTime\": \"2024-01-15 09:30:00\",\n \"approximateResult\": false,\n \"performerComments\": \"string\",\n \"specimen\": {\n \"specimenId\": \"1b83e3e6-07d6-01d7-261e-a80cf8258af0\",\n \"specimenType\": \"string\",\n \"collectedDate\": \"2024-01-14\",\n \"collectedTime\": \"14:00:00\",\n \"receivedForProcessingDateTime\": \"2024-01-14 15:00:00\",\n \"fastingStatus\": \"fasting\",\n \"amountCollectedValue\": \"string\",\n \"amountCollectedUnit\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"requesterIdentifier\": \"string\",\n \"performerIdentifier\": \"string\",\n \"performerComments\": \"string\"\n },\n \"filingComments\": [\n {\n \"commentId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"comment\": \"Filed: result within expected range.\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"Dr. Smith\",\n \"identifierType\": \"medicus-staff-id\",\n \"identifierValue\": \"a1b2c3d4\"\n },\n \"recordAuthorOrganisation\": null\n },\n {\n \"commentId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"comment\": \"Filed: result within expected range.\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"Dr. Smith\",\n \"identifierType\": \"medicus-staff-id\",\n \"identifierValue\": \"a1b2c3d4\"\n },\n \"recordAuthorOrganisation\": null\n }\n ]\n },\n {\n \"resultId\": \"7bac88ca-8d65-088c-7faa-165aca7e5140\",\n \"type\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultCode\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultValue\": \"string\",\n \"resultUnit\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultComparator\": \"<=\",\n \"resultStatus\": \"amended\",\n \"interpretation\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"referenceRanges\": [\n {\n \"lowerReferenceLimit\": \"string\",\n \"upperReferenceLimit\": \"string\",\n \"description\": \"string\"\n },\n {\n \"lowerReferenceLimit\": \"string\",\n \"upperReferenceLimit\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"issuedDateTime\": \"2024-01-15 09:30:00\",\n \"performedDateTime\": \"2024-01-15 09:30:00\",\n \"approximateResult\": true,\n \"performerComments\": \"string\",\n \"specimen\": {\n \"specimenId\": \"4b94fda7-cb91-15c2-fd79-2c8affa1f338\",\n \"specimenType\": \"string\",\n \"collectedDate\": \"2024-01-14\",\n \"collectedTime\": \"14:00:00\",\n \"receivedForProcessingDateTime\": \"2024-01-14 15:00:00\",\n \"fastingStatus\": \"fasting\",\n \"amountCollectedValue\": \"string\",\n \"amountCollectedUnit\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"requesterIdentifier\": \"string\",\n \"performerIdentifier\": \"string\",\n \"performerComments\": \"string\"\n },\n \"filingComments\": [\n {\n \"commentId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"comment\": \"Filed: result within expected range.\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"Dr. Smith\",\n \"identifierType\": \"medicus-staff-id\",\n \"identifierValue\": \"a1b2c3d4\"\n },\n \"recordAuthorOrganisation\": null\n },\n {\n \"commentId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"comment\": \"Filed: result within expected range.\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"Dr. Smith\",\n \"identifierType\": \"medicus-staff-id\",\n \"identifierValue\": \"a1b2c3d4\"\n },\n \"recordAuthorOrganisation\": null\n }\n ]\n }\n ],\n \"specimen\": {\n \"specimenId\": \"894bc1aa-0139-42ef-3356-f959af810214\",\n \"specimenType\": \"string\",\n \"collectedDate\": \"2024-01-14\",\n \"collectedTime\": \"14:00:00\",\n \"receivedForProcessingDateTime\": \"2024-01-14 15:00:00\",\n \"fastingStatus\": \"fasting\",\n \"amountCollectedValue\": \"string\",\n \"amountCollectedUnit\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"requesterIdentifier\": \"string\",\n \"performerIdentifier\": \"string\",\n \"performerComments\": \"string\"\n },\n \"filingComments\": [\n {\n \"commentId\": \"ac7bfe04-45a7-1fec-ae09-0ea07ab51d9e\",\n \"comment\": \"string\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"string\",\n \"identifierType\": \"sds-user-id\",\n \"identifierValue\": \"string\"\n },\n \"recordAuthorOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"medicus-referral-provider-id\",\n \"identifierValue\": \"string\"\n }\n },\n {\n \"commentId\": \"ee4ebda4-465c-4663-7fe7-89fa0677cd31\",\n \"comment\": \"string\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"string\",\n \"identifierType\": \"gb-nhs-gp-connect-practitioner-id\",\n \"identifierValue\": \"string\"\n },\n \"recordAuthorOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"third-party-system-organisation-id\",\n \"identifierValue\": \"string\"\n }\n }\n ]\n },\n {\n \"groupId\": \"a735c3e8-49e5-c65d-7e4f-8d40b80f41f1\",\n \"type\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"performerComments\": \"string\",\n \"results\": [\n {\n \"resultId\": \"0224447f-4ded-cd61-34fe-fd3459e27b1d\",\n \"type\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultCode\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultValue\": \"string\",\n \"resultUnit\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultComparator\": \">\",\n \"resultStatus\": \"preliminary\",\n \"interpretation\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"referenceRanges\": [\n {\n \"lowerReferenceLimit\": \"string\",\n \"upperReferenceLimit\": \"string\",\n \"description\": \"string\"\n },\n {\n \"lowerReferenceLimit\": \"string\",\n \"upperReferenceLimit\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"issuedDateTime\": \"2024-01-15 09:30:00\",\n \"performedDateTime\": \"2024-01-15 09:30:00\",\n \"approximateResult\": false,\n \"performerComments\": \"string\",\n \"specimen\": {\n \"specimenId\": \"4442e935-b71d-7814-9638-489bc83c8056\",\n \"specimenType\": \"string\",\n \"collectedDate\": \"2024-01-14\",\n \"collectedTime\": \"14:00:00\",\n \"receivedForProcessingDateTime\": \"2024-01-14 15:00:00\",\n \"fastingStatus\": \"fasting\",\n \"amountCollectedValue\": \"string\",\n \"amountCollectedUnit\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"requesterIdentifier\": \"string\",\n \"performerIdentifier\": \"string\",\n \"performerComments\": \"string\"\n },\n \"filingComments\": [\n {\n \"commentId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"comment\": \"Filed: result within expected range.\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"Dr. Smith\",\n \"identifierType\": \"medicus-staff-id\",\n \"identifierValue\": \"a1b2c3d4\"\n },\n \"recordAuthorOrganisation\": null\n },\n {\n \"commentId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"comment\": \"Filed: result within expected range.\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"Dr. Smith\",\n \"identifierType\": \"medicus-staff-id\",\n \"identifierValue\": \"a1b2c3d4\"\n },\n \"recordAuthorOrganisation\": null\n }\n ]\n },\n {\n \"resultId\": \"2f643113-cabe-62fb-e8d2-ee19a0d8ff84\",\n \"type\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultCode\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultValue\": \"string\",\n \"resultUnit\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultComparator\": \"<\",\n \"resultStatus\": \"final\",\n \"interpretation\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"referenceRanges\": [\n {\n \"lowerReferenceLimit\": \"string\",\n \"upperReferenceLimit\": \"string\",\n \"description\": \"string\"\n },\n {\n \"lowerReferenceLimit\": \"string\",\n \"upperReferenceLimit\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"issuedDateTime\": \"2024-01-15 09:30:00\",\n \"performedDateTime\": \"2024-01-15 09:30:00\",\n \"approximateResult\": true,\n \"performerComments\": \"string\",\n \"specimen\": {\n \"specimenId\": \"66c3225c-23fe-5777-36ab-810d95cf39ea\",\n \"specimenType\": \"string\",\n \"collectedDate\": \"2024-01-14\",\n \"collectedTime\": \"14:00:00\",\n \"receivedForProcessingDateTime\": \"2024-01-14 15:00:00\",\n \"fastingStatus\": \"fasting\",\n \"amountCollectedValue\": \"string\",\n \"amountCollectedUnit\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"requesterIdentifier\": \"string\",\n \"performerIdentifier\": \"string\",\n \"performerComments\": \"string\"\n },\n \"filingComments\": [\n {\n \"commentId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"comment\": \"Filed: result within expected range.\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"Dr. Smith\",\n \"identifierType\": \"medicus-staff-id\",\n \"identifierValue\": \"a1b2c3d4\"\n },\n \"recordAuthorOrganisation\": null\n },\n {\n \"commentId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"comment\": \"Filed: result within expected range.\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"Dr. Smith\",\n \"identifierType\": \"medicus-staff-id\",\n \"identifierValue\": \"a1b2c3d4\"\n },\n \"recordAuthorOrganisation\": null\n }\n ]\n }\n ],\n \"specimen\": {\n \"specimenId\": \"debcd6a6-c3bb-7bf8-33cb-65b94f5a8a31\",\n \"specimenType\": \"string\",\n \"collectedDate\": \"2024-01-14\",\n \"collectedTime\": \"14:00:00\",\n \"receivedForProcessingDateTime\": \"2024-01-14 15:00:00\",\n \"fastingStatus\": \"fasting\",\n \"amountCollectedValue\": \"string\",\n \"amountCollectedUnit\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"requesterIdentifier\": \"string\",\n \"performerIdentifier\": \"string\",\n \"performerComments\": \"string\"\n },\n \"filingComments\": [\n {\n \"commentId\": \"48d8cb12-2d61-44e5-7aee-09ffefea5a34\",\n \"comment\": \"string\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"string\",\n \"identifierType\": \"gb-nmc-pin\",\n \"identifierValue\": \"string\"\n },\n \"recordAuthorOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"nhs-england-ods-code\",\n \"identifierValue\": \"string\"\n }\n },\n {\n \"commentId\": \"ccffa9a4-9bec-f711-cd55-83ba297f8a81\",\n \"comment\": \"string\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"string\",\n \"identifierType\": \"sds-user-id\",\n \"identifierValue\": \"string\"\n },\n \"recordAuthorOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"medicus-referral-provider-id\",\n \"identifierValue\": \"string\"\n }\n }\n ]\n }\n ],\n \"ungroupedResults\": [\n {\n \"resultId\": \"34eb3d64-7965-4dc7-93b8-eaeed561e303\",\n \"type\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultCode\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultValue\": \"string\",\n \"resultUnit\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultComparator\": \"<\",\n \"resultStatus\": \"amended\",\n \"interpretation\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"referenceRanges\": [\n {\n \"lowerReferenceLimit\": \"string\",\n \"upperReferenceLimit\": \"string\",\n \"description\": \"string\"\n },\n {\n \"lowerReferenceLimit\": \"string\",\n \"upperReferenceLimit\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"issuedDateTime\": \"2024-01-15 09:30:00\",\n \"performedDateTime\": \"2024-01-15 09:30:00\",\n \"approximateResult\": false,\n \"performerComments\": \"string\",\n \"specimen\": {\n \"specimenId\": \"a625f9cf-e25c-4fa9-a3fc-c306957b9342\",\n \"specimenType\": \"string\",\n \"collectedDate\": \"2024-01-14\",\n \"collectedTime\": \"14:00:00\",\n \"receivedForProcessingDateTime\": \"2024-01-14 15:00:00\",\n \"fastingStatus\": \"fasting\",\n \"amountCollectedValue\": \"string\",\n \"amountCollectedUnit\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"requesterIdentifier\": \"string\",\n \"performerIdentifier\": \"string\",\n \"performerComments\": \"string\"\n },\n \"filingComments\": [\n {\n \"commentId\": \"0a0ae6b7-4976-9960-d0ff-f90138a9a64c\",\n \"comment\": \"string\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"string\",\n \"identifierType\": \"gb-nmc-pin\",\n \"identifierValue\": \"string\"\n },\n \"recordAuthorOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"medicus-tenant-id\",\n \"identifierValue\": \"string\"\n }\n },\n {\n \"commentId\": \"cb874602-8365-e81b-cf6f-4a68634d328f\",\n \"comment\": \"string\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"string\",\n \"identifierType\": \"gb-nhs-gp-connect-practitioner-id\",\n \"identifierValue\": \"string\"\n },\n \"recordAuthorOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"medicus-tenant-id\",\n \"identifierValue\": \"string\"\n }\n }\n ]\n },\n {\n \"resultId\": \"d5019a35-ca98-3208-2bd2-8aa00503f819\",\n \"type\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultCode\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultValue\": \"string\",\n \"resultUnit\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"resultComparator\": \"<\",\n \"resultStatus\": \"not-available\",\n \"interpretation\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"referenceRanges\": [\n {\n \"lowerReferenceLimit\": \"string\",\n \"upperReferenceLimit\": \"string\",\n \"description\": \"string\"\n },\n {\n \"lowerReferenceLimit\": \"string\",\n \"upperReferenceLimit\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"issuedDateTime\": \"2024-01-15 09:30:00\",\n \"performedDateTime\": \"2024-01-15 09:30:00\",\n \"approximateResult\": false,\n \"performerComments\": \"string\",\n \"specimen\": {\n \"specimenId\": \"7eaf6e73-00a8-e960-c942-8711bb116e3c\",\n \"specimenType\": \"string\",\n \"collectedDate\": \"2024-01-14\",\n \"collectedTime\": \"14:00:00\",\n \"receivedForProcessingDateTime\": \"2024-01-14 15:00:00\",\n \"fastingStatus\": \"fasting\",\n \"amountCollectedValue\": \"string\",\n \"amountCollectedUnit\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"requesterIdentifier\": \"string\",\n \"performerIdentifier\": \"string\",\n \"performerComments\": \"string\"\n },\n \"filingComments\": [\n {\n \"commentId\": \"391ad48c-3275-56a7-3899-0169014666fc\",\n \"comment\": \"string\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"string\",\n \"identifierType\": \"gb-gmc-number\",\n \"identifierValue\": \"string\"\n },\n \"recordAuthorOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"medicus-referral-provider-id\",\n \"identifierValue\": \"string\"\n }\n },\n {\n \"commentId\": \"8a281fdd-6e0b-b85f-70fe-f20a0f7cacb2\",\n \"comment\": \"string\",\n \"recordDate\": \"2024-01-15\",\n \"recordAuthorPractitioner\": {\n \"displayName\": \"string\",\n \"identifierType\": \"sds-user-id\",\n \"identifierValue\": \"string\"\n },\n \"recordAuthorOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"unknown-identifier-type\",\n \"identifierValue\": \"string\"\n }\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a8225c6-46e0-456f-a68e-050d490b29b6", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "get-investigation-report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "reportId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-report-id\",\n \"description\": \"The reportId is not a UUID.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77459c48-789b-4135-ae83-bd51becdd0e7", "name": "Forbidden: the calling application does not have the required permission.", "originalRequest": { "url": { "path": [ "transactional-api", "get-investigation-report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "reportId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"forbidden\",\n \"description\": \"The calling application does not have permission to use this endpoint.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d00715d-c060-4bba-80cd-6c4177c61568", "name": "No report exists for the given reportId.", "originalRequest": { "url": { "path": [ "transactional-api", "get-investigation-report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "reportId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"investigation-report-not-found\",\n \"description\": \"Investigation report not found for this reportId.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1aff0cea-6204-4b70-893b-d49ee6a62a9d", "name": "The report exists but is not in PENDING status.", "originalRequest": { "url": { "path": [ "transactional-api", "get-investigation-report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "reportId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"investigation-report-not-pending\",\n \"description\": \"This investigation report is not in PENDING status.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4bdf38e-4095-484c-b51f-ac1a4119a97a", "name": "The report contains free-text results and cannot be retrieved via this API.", "originalRequest": { "url": { "path": [ "transactional-api", "get-investigation-report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "reportId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"investigation-report-has-text-results\",\n \"description\": \"This investigation report contains free-text results and cannot be retrieved via this API.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a8ba0af-0c3d-4350-96c2-64ae5a345723", "name": "List Unfiled Investigation Reports", "request": { "name": "List Unfiled Investigation Reports", "description": { "content": "Returns all PENDING investigation reports that have been matched to a patient. Reports that contain any free-text result values are excluded, as those cannot be automatically filed.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "list-unfiled-investigation-reports" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/list-unfiled-investigation-reports" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a81267dc-06b9-4f9f-84a5-5e3cf7d53b74", "name": "Unfiled investigation reports.", "originalRequest": { "url": { "path": [ "transactional-api", "list-unfiled-investigation-reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"reportId\": \"25fc3acf-80db-1874-3a92-ff41257641bb\",\n \"patientId\": \"e257a686-2f89-004e-c45f-0da623aa9288\",\n \"displayDescription\": \"string\",\n \"receivedDateTime\": \"2024-01-15 09:30:00\",\n \"issuedDateTime\": \"2024-01-15 09:30:00\",\n \"reportIdentifier\": \"string\"\n },\n {\n \"reportId\": \"2a4f32df-eaf3-dfdf-8d89-67e6e5fddd33\",\n \"patientId\": \"aa399664-4975-b27e-03b8-4a3e7b50f997\",\n \"displayDescription\": \"string\",\n \"receivedDateTime\": \"2024-01-15 09:30:00\",\n \"issuedDateTime\": \"2024-01-15 09:30:00\",\n \"reportIdentifier\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6fb0fdb-f968-49c3-b934-7b0f756a3f20", "name": "Forbidden: the calling application does not have the required permission.", "originalRequest": { "url": { "path": [ "transactional-api", "list-unfiled-investigation-reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"forbidden\",\n \"description\": \"The calling application does not have permission to use this endpoint.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3bc57e7f-1c85-41ed-826c-b9a3da5205d0", "name": "List Unfulfilled Investigation Requests", "request": { "name": "List Unfulfilled Investigation Requests", "description": { "content": "Returns all UNFULFILLED investigation request items for a patient, grouped by their parent investigation request.", "type": "text/plain" }, "url": { "path": [ "transactional-api", "list-unfulfilled-investigation-requests" ], "host": [ "{{base_url}}" ], "query": [ { "disabled": false, "key": "patientId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a", "description": "(Required) The UUID of the patient to retrieve unfulfilled investigation requests for." } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ], "raw": "{{base_url}}/transactional-api/list-unfulfilled-investigation-requests" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a5c993d1-5c7e-4a7a-a742-3c6b2ad11056", "name": "Unfulfilled investigation requests.", "originalRequest": { "url": { "path": [ "transactional-api", "list-unfulfilled-investigation-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patientId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"requestId\": \"34dadfca-1f04-7c91-d0cf-8816e8ead4a9\",\n \"requestedDateTime\": \"2024-01-15 09:30:00\",\n \"orderMethod\": \"t-quest\",\n \"requestedByOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"nhs-england-ods-code\",\n \"identifierValue\": \"string\"\n },\n \"requestedByPractitioner\": {\n \"displayName\": \"string\",\n \"identifierType\": \"medicus-staff-id\",\n \"identifierValue\": \"string\"\n },\n \"serviceProvider\": {\n \"name\": \"string\",\n \"identifierType\": \"medicus-tenant-id\",\n \"identifierValue\": \"string\"\n },\n \"reasonForRequest\": \"string\",\n \"additionalInformation\": \"string\",\n \"items\": [\n {\n \"itemId\": \"23acc11b-32c5-b049-e0f3-7975ac012563\",\n \"requestedInvestigation\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"thirdPartyOrderReference\": \"string\",\n \"performingOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"medicus-referral-provider-id\",\n \"identifierValue\": \"string\"\n }\n },\n {\n \"itemId\": \"be6d33ec-b8d2-0f0f-82d4-c9a1c1f11244\",\n \"requestedInvestigation\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"thirdPartyOrderReference\": \"string\",\n \"performingOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"medicus-tenant-id\",\n \"identifierValue\": \"string\"\n }\n }\n ]\n },\n {\n \"requestId\": \"0d472027-a950-17ee-8b53-a735372d0626\",\n \"requestedDateTime\": \"2024-01-15 09:30:00\",\n \"orderMethod\": \"t-quest\",\n \"requestedByOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"medicus-tenant-id\",\n \"identifierValue\": \"string\"\n },\n \"requestedByPractitioner\": {\n \"displayName\": \"string\",\n \"identifierType\": \"medicus-staff-id\",\n \"identifierValue\": \"string\"\n },\n \"serviceProvider\": {\n \"name\": \"string\",\n \"identifierType\": \"third-party-system-organisation-id\",\n \"identifierValue\": \"string\"\n },\n \"reasonForRequest\": \"string\",\n \"additionalInformation\": \"string\",\n \"items\": [\n {\n \"itemId\": \"c633ae30-157e-1c0b-55f8-d5321ba94acb\",\n \"requestedInvestigation\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"thirdPartyOrderReference\": \"string\",\n \"performingOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"unknown-identifier-type\",\n \"identifierValue\": \"string\"\n }\n },\n {\n \"itemId\": \"413d9f3f-79eb-21a6-09bd-0b22eee500cd\",\n \"requestedInvestigation\": {\n \"conceptId\": \"string\",\n \"description\": \"string\"\n },\n \"thirdPartyOrderReference\": \"string\",\n \"performingOrganisation\": {\n \"name\": \"string\",\n \"identifierType\": \"medicus-tenant-id\",\n \"identifierValue\": \"string\"\n }\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad8b4fcd-1680-4bf3-bfc8-51363144ebf1", "name": "Validation error.", "originalRequest": { "url": { "path": [ "transactional-api", "list-unfulfilled-investigation-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patientId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"invalid-patient-id\",\n \"description\": \"The patientId is not a UUID.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e6502f4-d182-440f-a68c-789d85c49ea4", "name": "Forbidden: the calling application does not have the required permission.", "originalRequest": { "url": { "path": [ "transactional-api", "list-unfulfilled-investigation-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patientId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"forbidden\",\n \"description\": \"The calling application does not have permission to use this endpoint.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27962850-ca24-46fa-a4ed-184bdfe72515", "name": "Patient not found.", "originalRequest": { "url": { "path": [ "transactional-api", "list-unfulfilled-investigation-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patientId", "value": "77db164b-7cc6-4c1c-8679-f78fde438c1a" } ], "variable": [ { "description": "Your Medicus tenant (practice) identifier.", "type": "any", "value": "{{tenantId}}", "key": "tenantId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"patient-not-found\",\n \"description\": \"Patient not found for the id: 3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.collectionVariables.set(\"exp\", Math.floor(Date.now() / 1000) + 60);" ] } } ], "variable": [ { "key": "client_id", "value": "medicus-test" }, { "key": "base_url", "value": "https://your-tenant.api.staging.england.medicus.health" }, { "key": "exp", "value": "0" } ], "auth": { "type": "jwt", "jwt": [ { "key": "header", "value": "{\n \"kid\": \"ADD HERE\"\n}", "type": "string" }, { "key": "privateKey", "value": "", "type": "string" }, { "key": "payload", "value": "{\n \"iss\": \"{{client_id}}\",\n \"sub\": \"{{client_id}}\",\n \"iat\": {{$timestamp}},\n \"exp\": {{exp}}\n}", "type": "string" }, { "key": "algorithm", "value": "RS256", "type": "string" }, { "key": "isSecretBase64Encoded", "value": false, "type": "boolean" }, { "key": "addTokenTo", "value": "header", "type": "string" }, { "key": "headerPrefix", "value": "Bearer", "type": "string" }, { "key": "queryParamKey", "value": "token", "type": "string" } ] }, "info": { "_postman_id": "c5f3f249-9f92-40a8-ae06-2b393d0f1fce", "name": "Medicus Transactional API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "REST API for third-party applications to interact with Medicus: create\nclinical notes, documents, encounters and observations; retrieve care\nrecords and documents; and find, match and manage patients and\nappointments.\n\nEvery request is authenticated against the calling application's\nregistered keys and authorised against a per-endpoint permission.", "type": "text/plain" } } }