{ "info": { "_postman_id": "a86d6d58-de83-4ca2-be56-b94ce6555fd8", "name": "FHIR R4 REST API", "description": "HL7 FHIR R4 RESTful API served from the APEX Nexus gateway and FHIR Data Lake.\nSupports SMART on FHIR OAuth 2.0, bulk $export, and 300+ resource types.\n", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "https://api.parkerapex.com/fhir/R4", "type": "string" }, { "key": "access_token", "value": "REPLACE_WITH_TOKEN", "type": "string" } ], "item": [ { "name": "Conformance", "item": [ { "name": "CapabilityStatement", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/metadata", "host": [ "{{base_url}}" ], "path": [ "metadata" ] }, "description": "FHIR conformance metadata \u2014 supported resource types, interactions, and search parameters." } } ] }, { "name": "SMART", "item": [ { "name": "SMART on FHIR configuration", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/.well-known/smart-configuration", "host": [ "{{base_url}}" ], "path": [ ".well-known", "smart-configuration" ] }, "description": "OAuth authorization and token endpoints, supported scopes, and launch capabilities." } } ] }, { "name": "Patient", "item": [ { "name": "Search Patients", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/Patient", "host": [ "{{base_url}}" ], "path": [ "Patient" ] }, "description": "Search Patient resources by name, identifier (GPID), birthdate, and other search parameters." } }, { "name": "Create Patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/Patient", "host": [ "{{base_url}}" ], "path": [ "Patient" ] }, "description": "", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Read Patient", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/Patient/{id}", "host": [ "{{base_url}}" ], "path": [ "Patient", "{id}" ] }, "description": "" } } ] }, { "name": "Observation", "item": [ { "name": "Search Observations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/Observation", "host": [ "{{base_url}}" ], "path": [ "Observation" ] }, "description": "" } } ] }, { "name": "Bundle", "item": [ { "name": "Submit FHIR Bundle", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/", "host": [ "{{base_url}}" ], "path": [] }, "description": "Transaction or batch Bundle for multi-resource ingest.", "body": { "mode": "raw", "raw": "{}" } } } ] }, { "name": "Bulk Export", "item": [ { "name": "Bulk Data Export", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/$export", "host": [ "{{base_url}}" ], "path": [ "$export" ] }, "description": "Initiate async bulk FHIR export (SMART Backend Services). Returns 202 with Content-Location polling URL." } } ] }, { "name": "ADT", "item": [ { "name": "Admit patient (create inpatient Encounter)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/Encounter/$admit", "host": [ "{{base_url}}" ], "path": [ "Encounter", "$admit" ] }, "description": "Admit a patient to inpatient care. Creates an Encounter with class `inpatient`\nand status `in-progress`, sets the admission timestamp, and \u2014 when a bed\n`location` is supplied \u2014 marks that Location's operational status `Occupied`.\n", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Transfer an admitted patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/Encounter/{id}/$transfer", "host": [ "{{base_url}}" ], "path": [ "Encounter", "{id}", "$transfer" ] }, "description": "Move an in-progress inpatient Encounter to a new bed/unit. Frees the\n`from` Location (set to `Housekeeping`) and occupies the `to` Location.\n", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Discharge an admitted patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/Encounter/{id}/$discharge", "host": [ "{{base_url}}" ], "path": [ "Encounter", "{id}", "$discharge" ] }, "description": "Finish an inpatient Encounter. Sets status `finished`, records the discharge\ntimestamp and length of stay, and frees the bed (Location \u2192 `Housekeeping`).\n", "body": { "mode": "raw", "raw": "{}" } } } ] }, { "name": "Orders", "item": [ { "name": "Place an order (CPOE)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ServiceRequest", "host": [ "{{base_url}}" ], "path": [ "ServiceRequest" ] }, "description": "Create a ServiceRequest for a lab, imaging study, procedure, or nursing\norder. `subject` (Patient) and `code` are required; `requester` defaults to\nthe authenticated practitioner when omitted.\n", "body": { "mode": "raw", "raw": "{}" } } } ] }, { "name": "Bed Management", "item": [ { "name": "Create a Location (facility, ward, room, or bed)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/Location", "host": [ "{{base_url}}" ], "path": [ "Location" ] }, "description": "", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Update a Location (bed status)", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/Location/{id}", "host": [ "{{base_url}}" ], "path": [ "Location", "{id}" ] }, "description": "Update a Location \u2014 primarily to change bed occupancy. Accepts a compact\n`operationalStatus` shorthand (`occupied`, `unoccupied`, `housekeeping`,\n`closed`, `contaminated`, `isolated`) or a full FHIR CodeableConcept.\n", "body": { "mode": "raw", "raw": "{}" } } } ] }, { "name": "Audit", "item": [ { "name": "Search AuditEvents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/AuditEvent", "host": [ "{{base_url}}" ], "path": [ "AuditEvent" ] }, "description": "Query the security audit log. AuditEvent records who accessed or acted on\nthe system, when, and from where \u2014 the audit trail required for ONC (g)(10).\n" } }, { "name": "Read AuditEvent", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/AuditEvent/{id}", "host": [ "{{base_url}}" ], "path": [ "AuditEvent", "{id}" ] }, "description": "" } } ] } ] }