{ "info": { "_postman_id": "4e10468a-5d06-42a4-a0d9-3d8637ce64d2", "name": "Orion Health FHIR Alerts DocumentReference API", "description": "The Orion Health FHIR API provides standards-based access to healthcare data using the HL7 FHIR (Fast Healthcare Interoperability Resources) specification. It enables healthcare organizations to read, search, create, and update clinical resources including patients, encounters, observations, conditions, medications, allergies, procedures, diagnostic reports, and care plans. The API conforms to FHIR R4 (v4.0.1) and supports both JSON and XML representations.\n\nContact Support:\n Name: Orion Health API Support\n Email: apisupport@orionhealth.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:29:13.000Z", "updatedAt": "2026-07-28T02:29:13.000Z", "lastUpdatedBy": "35240", "uid": "35240-4e10468a-5d06-42a4-a0d9-3d8637ce64d2" }, "item": [ { "name": "DocumentReference", "item": [ { "name": "{id}", "item": [ { "name": "Orion Health Read a document reference by ID", "id": "009a489f-3e39-4186-89a5-d556cb4a660e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/fhir+json" } ], "url": { "raw": "{{baseUrl}}/DocumentReference/:id?_format=application/fhir+json", "host": [ "{{baseUrl}}" ], "path": [ "DocumentReference", ":id" ], "query": [ { "description": "Response format", "key": "_format", "value": "application/fhir+json" } ], "variable": [ { "id": "970e5c46-d723-4344-ab4a-3bb29b1050fa", "key": "id", "value": "", "description": "(Required) Logical ID of the FHIR resource" } ] }, "description": "Retrieve a specific DocumentReference resource by its logical ID." }, "response": [ { "id": "64254257-78ef-488b-9933-c284c15f9d47", "name": "DocumentReference resource", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/fhir+json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/DocumentReference/:id?_format=application/fhir+json", "host": [ "{{baseUrl}}" ], "path": [ "DocumentReference", ":id" ], "query": [ { "description": "Response format", "key": "_format", "value": "application/fhir+json" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/fhir+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"resourceType\": \"\",\n \"id\": \"\",\n \"status\": \"current\",\n \"type\": {\n \"coding\": [\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n },\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n }\n ],\n \"text\": \"\"\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n },\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n }\n ],\n \"text\": \"\"\n },\n {\n \"coding\": [\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n },\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n }\n ],\n \"text\": \"\"\n }\n ],\n \"subject\": {\n \"reference\": \"\",\n \"display\": \"\"\n },\n \"date\": \"\",\n \"content\": [\n {\n \"attachment\": {\n \"contentType\": \"\",\n \"url\": \"\",\n \"title\": \"\"\n }\n },\n {\n \"attachment\": {\n \"contentType\": \"\",\n \"url\": \"\",\n \"title\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:29:14.000Z", "updatedAt": "2026-07-28T02:29:14.000Z", "uid": "35240-64254257-78ef-488b-9933-c284c15f9d47" }, { "id": "1cc86a1c-be70-49f7-8d57-1f28ca88aaee", "name": "Authentication required or token expired", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/fhir+json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/DocumentReference/:id?_format=application/fhir+json", "host": [ "{{baseUrl}}" ], "path": [ "DocumentReference", ":id" ], "query": [ { "description": "Response format", "key": "_format", "value": "application/fhir+json" } ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/fhir+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"resourceType\": \"\",\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"\",\n \"diagnostics\": \"\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n },\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n }\n ],\n \"text\": \"\"\n }\n },\n {\n \"severity\": \"error\",\n \"code\": \"\",\n \"diagnostics\": \"\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n },\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n }\n ],\n \"text\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:29:14.000Z", "updatedAt": "2026-07-28T02:29:14.000Z", "uid": "35240-1cc86a1c-be70-49f7-8d57-1f28ca88aaee" }, { "id": "420efc03-904c-4670-bec5-4f6b9b81b3f6", "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/fhir+json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/DocumentReference/:id?_format=application/fhir+json", "host": [ "{{baseUrl}}" ], "path": [ "DocumentReference", ":id" ], "query": [ { "description": "Response format", "key": "_format", "value": "application/fhir+json" } ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/fhir+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"resourceType\": \"\",\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"\",\n \"diagnostics\": \"\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n },\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n }\n ],\n \"text\": \"\"\n }\n },\n {\n \"severity\": \"error\",\n \"code\": \"\",\n \"diagnostics\": \"\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n },\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n }\n ],\n \"text\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:29:14.000Z", "updatedAt": "2026-07-28T02:29:14.000Z", "uid": "35240-420efc03-904c-4670-bec5-4f6b9b81b3f6" } ], "createdAt": "2026-07-28T02:29:14.000Z", "updatedAt": "2026-07-28T02:29:14.000Z", "uid": "35240-009a489f-3e39-4186-89a5-d556cb4a660e" } ], "id": "5faa4872-7cc7-4c8c-88e2-37b8239b5e4a", "createdAt": "2026-07-28T02:29:14.000Z", "updatedAt": "2026-07-28T02:29:14.000Z", "uid": "35240-5faa4872-7cc7-4c8c-88e2-37b8239b5e4a" }, { "name": "Orion Health Search for document references", "id": "552c4301-bc45-48ab-b163-173698351891", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/fhir+json" } ], "url": { "raw": "{{baseUrl}}/DocumentReference?_format=application/fhir+json&_count=20&_offset=0&patient=&type=&category=&date=&status=current", "host": [ "{{baseUrl}}" ], "path": [ "DocumentReference" ], "query": [ { "description": "Response format", "key": "_format", "value": "application/fhir+json" }, { "description": "Maximum number of results per page", "key": "_count", "value": "20" }, { "description": "Starting offset for paging", "key": "_offset", "value": "0" }, { "description": "Reference to the patient", "key": "patient", "value": "" }, { "description": "Document type code", "key": "type", "value": "" }, { "description": "Document category", "key": "category", "value": "" }, { "description": "Document date or date range", "key": "date", "value": "" }, { "description": "Document status", "key": "status", "value": "current" } ] }, "description": "Search for DocumentReference resources representing clinical documents, notes, and reports." }, "response": [ { "id": "3fa35f34-c27f-4b10-8c40-45b6d7216c36", "name": "Bundle of matching DocumentReference resources", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/fhir+json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/DocumentReference?_format=application/fhir+json&_count=20&_offset=0&patient=&type=&category=&date=&status=current", "host": [ "{{baseUrl}}" ], "path": [ "DocumentReference" ], "query": [ { "description": "Response format", "key": "_format", "value": "application/fhir+json" }, { "description": "Maximum number of results per page", "key": "_count", "value": "20" }, { "description": "Starting offset for paging", "key": "_offset", "value": "0" }, { "description": "Reference to the patient", "key": "patient", "value": "" }, { "description": "Document type code", "key": "type", "value": "" }, { "description": "Document category", "key": "category", "value": "" }, { "description": "Document date or date range", "key": "date", "value": "" }, { "description": "Document status", "key": "status", "value": "current" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/fhir+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"resourceType\": \"\",\n \"type\": \"batch-response\",\n \"total\": \"\",\n \"link\": [\n {\n \"relation\": \"next\",\n \"url\": \"\"\n },\n {\n \"relation\": \"next\",\n \"url\": \"\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"\",\n \"resource\": {\n \"resourceType\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"versionId\": \"\",\n \"lastUpdated\": \"\",\n \"profile\": [\n \"\",\n \"\"\n ]\n }\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"\",\n \"resource\": {\n \"resourceType\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"versionId\": \"\",\n \"lastUpdated\": \"\",\n \"profile\": [\n \"\",\n \"\"\n ]\n }\n },\n \"search\": {\n \"mode\": \"outcome\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:29:14.000Z", "updatedAt": "2026-07-28T02:29:14.000Z", "uid": "35240-3fa35f34-c27f-4b10-8c40-45b6d7216c36" }, { "id": "625208ac-55d4-4c16-b86f-7b973abbf678", "name": "Invalid request parameters", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/fhir+json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/DocumentReference?_format=application/fhir+json&_count=20&_offset=0&patient=&type=&category=&date=&status=current", "host": [ "{{baseUrl}}" ], "path": [ "DocumentReference" ], "query": [ { "description": "Response format", "key": "_format", "value": "application/fhir+json" }, { "description": "Maximum number of results per page", "key": "_count", "value": "20" }, { "description": "Starting offset for paging", "key": "_offset", "value": "0" }, { "description": "Reference to the patient", "key": "patient", "value": "" }, { "description": "Document type code", "key": "type", "value": "" }, { "description": "Document category", "key": "category", "value": "" }, { "description": "Document date or date range", "key": "date", "value": "" }, { "description": "Document status", "key": "status", "value": "current" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/fhir+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"resourceType\": \"\",\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"\",\n \"diagnostics\": \"\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n },\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n }\n ],\n \"text\": \"\"\n }\n },\n {\n \"severity\": \"error\",\n \"code\": \"\",\n \"diagnostics\": \"\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n },\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n }\n ],\n \"text\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:29:14.000Z", "updatedAt": "2026-07-28T02:29:14.000Z", "uid": "35240-625208ac-55d4-4c16-b86f-7b973abbf678" }, { "id": "b923243e-fdf2-4428-9c0f-6b24329bde65", "name": "Authentication required or token expired", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/fhir+json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/DocumentReference?_format=application/fhir+json&_count=20&_offset=0&patient=&type=&category=&date=&status=current", "host": [ "{{baseUrl}}" ], "path": [ "DocumentReference" ], "query": [ { "description": "Response format", "key": "_format", "value": "application/fhir+json" }, { "description": "Maximum number of results per page", "key": "_count", "value": "20" }, { "description": "Starting offset for paging", "key": "_offset", "value": "0" }, { "description": "Reference to the patient", "key": "patient", "value": "" }, { "description": "Document type code", "key": "type", "value": "" }, { "description": "Document category", "key": "category", "value": "" }, { "description": "Document date or date range", "key": "date", "value": "" }, { "description": "Document status", "key": "status", "value": "current" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/fhir+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"resourceType\": \"\",\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"\",\n \"diagnostics\": \"\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n },\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n }\n ],\n \"text\": \"\"\n }\n },\n {\n \"severity\": \"error\",\n \"code\": \"\",\n \"diagnostics\": \"\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n },\n {\n \"system\": \"\",\n \"code\": \"\",\n \"display\": \"\"\n }\n ],\n \"text\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:29:14.000Z", "updatedAt": "2026-07-28T02:29:14.000Z", "uid": "35240-b923243e-fdf2-4428-9c0f-6b24329bde65" } ], "createdAt": "2026-07-28T02:29:14.000Z", "updatedAt": "2026-07-28T02:29:14.000Z", "uid": "35240-552c4301-bc45-48ab-b163-173698351891" } ], "id": "0a96089e-1b4a-46d1-8beb-1b082d303232", "createdAt": "2026-07-28T02:29:14.000Z", "updatedAt": "2026-07-28T02:29:14.000Z", "uid": "35240-0a96089e-1b4a-46d1-8beb-1b082d303232" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "patient/*.read patient/*.write patient/Patient.read patient/Observation.read patient/Condition.read patient/MedicationRequest.read launch openid fhirUser", "type": "string" }, { "key": "accessTokenUrl", "value": "https://auth.orionhealth.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://auth.orionhealth.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.orionhealth.com/fhir" } ] }