Departments
Bring diagnostic work back into the relevant care context.
Laboratory
Select the test from the service catalogue and link it to the patient, encounter and ordering clinician. Include the clinical question, priority and required specimen information.
Record specimen type, collection information, accession identifier, received time and condition. Keep processing notes and the original request linked so recollection can be traced.
Keep observations and diagnostic reports with the request and specimen. Configure the approved test definitions, units and result interpretation; name the result reviewer and critical-result communication route.
Make the approved report available in the clinical encounter. Preserve amendment reasons, reviewer responsibility and communication evidence; the ordering team owns the clinical follow-up.
Your configuration
Use the registered details of your organization. Do not enter patient records here.
Upload in the matching account setup step, review the preview, apply the values and Save and continue. The tenant version may define different columns; download its template inside setup.
| Column | Required | Format | Example |
|---|---|---|---|
Registered organization namelegal_name | Yes | text | Example Healthcare Organization |
Commercial registration numberregistration_number | Yes | text | EXAMPLE-CR-001 |
Countrycountry | Yes | SA / AE / BH / KW / QA / OM / EG / OTHER | SA |
Tax registration numbervat_number | Optional | text | — |
Add every facility included in your subscription. These become real, separate facilities in your app.
Upload in the matching account setup step, review the preview, apply the values and Save and continue. The tenant version may define different columns; download its template inside setup.
Load / review first: Your organization
| Column | Required | Format | Example |
|---|---|---|---|
Facility namename | Yes | text | Example Facility |
Facility typetype | Yes | hospital / clinic / polyclinic / laboratory / other | clinic |
Facility licenselicense_number | Yes | text | EXAMPLE-LICENSE-001 |
Addressaddress | Yes | text | Example training address |
Phonephone | Yes | text | +966500000000 |
Time zonetimezone | Yes | Asia/Riyadh / Asia/Dubai / Asia/Qatar / Africa/Cairo / UTC | Asia/Riyadh |
Create departments, consultation rooms, wards and beds. You can add more inside your app.
Upload in the matching account setup step, review the preview, apply the values and Save and continue. The tenant version may define different columns; download its template inside setup.
Load / review first: Facilities
| Column | Required | Format | Example |
|---|---|---|---|
Facility number (starting at 1)facility | Yes | integer 1–1000 | 1 |
Department namename | Yes | text | Example Department |
Create departments, consultation rooms, wards and beds. You can add more inside your app.
Upload in the matching account setup step, review the preview, apply the values and Save and continue. The tenant version may define different columns; download its template inside setup.
Load / review first: Facilities
| Column | Required | Format | Example |
|---|---|---|---|
Facility numberfacility | Yes | integer 1–1000 | 1 |
Location namename | Yes | text | Example Room |
Typekind | Yes | room / ward / bed | room |
Inside location (optional)parent | Optional | text | — |
Your verified account becomes the facility administrator. Invite staff in the account portal; staff seats are enforced.
Upload in the matching account setup step, review the preview, apply the values and Save and continue. The tenant version may define different columns; download its template inside setup.
| Column | Required | Format | Example |
|---|---|---|---|
Namename | Yes | text | Example Staff |
Work emailemail | Yes | staff@example.invalid | |
Clinical rolerole | Yes | facility_admin / doctor / nurse / pharmacist / reception / billing / member | doctor |
Healthcare service directory
Upload in Your products · configuration data. Apply, then Save and continue checks cross-file references. Launch imports supported records in one transaction and reconciles counts. Function settings are validated against the supported registry, applied natively and read back; prices, catalogue mappings and hardware require approval before activation.
Load / review first: Departments · Rooms, wards and beds
| Column | Required | Format | Example |
|---|---|---|---|
Local service codeservice_code | Yes | text | EXAMPLE-SVC-001 |
English namename_en | Yes | text | Example service |
Arabic namename_ar | Yes | text | خدمة تدريبية |
Facility numberfacility | Yes | integer 1–1000 | 1 |
Departmentdepartment | Yes | text | Example Department |
Locationlocation | Yes | text | Example Room |
Service functioninternal_type | Yes | general / scheduling / lab / pharmacy / store | scheduling |
Device register, location and department assignment
Upload in Your products · configuration data. Apply, then Save and continue checks cross-file references. Launch imports supported records in one transaction and reconciles counts. Function settings are validated against the supported registry, applied natively and read back; prices, catalogue mappings and hardware require approval before activation.
Load / review first: Departments · Rooms, wards and beds
| Column | Required | Format | Example |
|---|---|---|---|
Unique asset codeasset_code | Yes | text | EXAMPLE-LAB-001 |
Facility numberfacility | Yes | integer 1–1000 | 1 |
Departmentdepartment | Yes | text | Example Department |
Locationlocation | Yes | text | Example Room |
Device namename | Yes | text | Training laboratory analyser |
Manufacturermanufacturer | Yes | text | Example manufacturer |
Modelmodel | Yes | text | EXAMPLE-MODEL |
Serial numberserial_number | Yes | text | EXAMPLE-SERIAL |
Product / department purposecare_type | Yes | text | laboratory |
Interface protocol and versionprotocol | Optional | text | TO-CONFIRM |
Maintenance duemaintenance_due | Optional | YYYY-MM-DD | 2027-10-09 |
Registry function settings applied to native scheduling closures with readback
Upload in Your products · configuration data. Apply, then Save and continue checks cross-file references. Launch imports supported records in one transaction and reconciles counts. Function settings are validated against the supported registry, applied natively and read back; prices, catalogue mappings and hardware require approval before activation.
Load / review first: Rooms, wards and beds
| Column | Required | Format | Example |
|---|---|---|---|
Facility numberfacility | Yes | integer 1–1000 | 1 |
Selected feature IDfeature | Yes | scheduling | scheduling |
Function settingfunction_key | Yes | scheduling.closures | scheduling.closures |
Closure namename | Yes | text | Example closure |
First closed datevalid_from | Yes | YYYY-MM-DD | 2026-12-01 |
Last closed datevalid_to | Yes | YYYY-MM-DD | 2026-12-01 |
Closed fromstart_time | Yes | HH:MM | 08:00 |
Closed untilend_time | Yes | HH:MM | 17:00 |
Room (blank closes the whole facility)location | Optional | text | Example Room |
Freeze products, versions, facilities, delivery mode and acceptance scope.
Upload in Account setup → Implementation files & acceptance evidence. The data is saved in your account implementation records. Review with the named owner, record approval and attach the evidence. This register records decisions; it does not activate production configuration.
| Column | Required | Format | Example |
|---|---|---|---|
Catalogue product IDproduct_id | Yes | text | outpatient |
Agreed releaserelease | Yes | text | TO-CONFIRM |
Operating modemode | Yes | native / connected | native |
Facility scopefacility_scope | Yes | text | all |
Included in this projectincluded | Yes | true / false | true |
Accountable roleowner_role | Yes | text | Project owner |
Acceptance evidenceacceptance_test | Yes | text | Approved end-to-end test |
Approval referenceapproval_reference | Yes | text | EXAMPLE-REF-001 |
Map roles to permitted actions and verify access across facility boundaries.
Upload in Account setup → Implementation files & acceptance evidence. The data is saved in your account implementation records. Review with the named owner, record approval and attach the evidence. This register records decisions; it does not activate production configuration.
Load / review first: Facilities · Planned team
| Column | Required | Format | Example |
|---|---|---|---|
Rolerole | Yes | text | doctor |
Facility scopefacility_scope | Yes | text | EXAMPLE-FACILITY-001 |
Resourceresource | Yes | text | Patient record |
Actionaction | Yes | text | read |
Allowedallowed | Yes | true / false | true |
Approverapprover_role | Yes | text | Security owner |
Test evidenceevidence_reference | Yes | text | EXAMPLE-REF-001 |
Define services and approved code mappings before orders, tariffs and interfaces.
Upload this preparation file in Account setup → Implementation files & acceptance evidence. It is saved in your account records. Use the secure migration workspace for actual clinical data. Approve the source-to-target mapping and import adapter for the selected release before any load. Run a dry run, reconcile counts and retain the result log.
Load / review first: Departments
| Column | Required | Format | Example |
|---|---|---|---|
Local service codeservice_code | Yes | text | EXAMPLE-SVC-001 |
English namename_en | Yes | text | Example service |
Arabic namename_ar | Yes | text | خدمة تدريبية |
Department codedepartment_code | Yes | text | EXAMPLE-DEPT-001 |
Unit of serviceunit | Yes | text | TO-CONFIRM |
Code systemcode_system | Yes | text | TO-CONFIRM |
Catalogue releaserelease | Yes | text | TO-CONFIRM |
Approved external mappingexternal_code | Yes | text | TO-CONFIRM |
Effective fromeffective_from | Yes | YYYY-MM-DD | 2026-10-09 |
Record locally approved pathways, responsibilities and exception handling.
Upload in Account setup → Implementation files & acceptance evidence. The data is saved in your account implementation records. Review with the named owner, record approval and attach the evidence. This register records decisions; it does not activate production configuration.
Load / review first: Departments · Access & approvals
| Column | Required | Format | Example |
|---|---|---|---|
Workflow IDworkflow_id | Yes | text | EXAMPLE-WF-001 |
Product IDproduct_id | Yes | text | outpatient |
Entry evententry_event | Yes | text | Patient arrival |
Responsible roleresponsible_role | Yes | text | Nurse |
Required informationrequired_information | Yes | text | Verified identity and visit context |
Next eventnext_event | Yes | text | Clinical consultation |
Handover ownerhandover_owner | Yes | text | Doctor |
Exception pathexception_path | Yes | text | Identity mismatch to review |
Workflow approvalapproval_reference | Yes | text | EXAMPLE-REF-001 |
Define the agreed message contract. Store references to credentials, never the credentials themselves.
Upload in Account setup → Implementation files & acceptance evidence. The data is saved in your account implementation records. Review with the named owner, record approval and attach the evidence. This register records decisions; it does not activate production configuration.
Load / review first: Facilities · Service catalogue · Existing systems & versions
| Column | Required | Format | Example |
|---|---|---|---|
Interface IDinterface_id | Yes | text | EXAMPLE-IF-001 |
Source systemsource_system | Yes | text | SRC-EPIC-001 |
Target systemtarget_system | Yes | text | MANSOQ |
Directiondirection | Yes | inbound / outbound / bidirectional | inbound |
Protocol and versionprotocol_version | Yes | text | TO-CONFIRM |
Message scopemessage_scope | Yes | text | TO-CONFIRM |
Identifier mappingidentifier_mapping | Yes | text | TO-CONFIRM |
Secret manager referencesecret_reference | Yes | text | REFERENCE-ONLY |
Retry and duplicate policyretry_policy | Yes | text | TO-CONFIRM |
Failure ownerfailure_owner | Yes | text | Integration owner |
Test evidencetest_reference | Yes | text | EXAMPLE-REF-001 |
Record complete positive, negative, boundary, access and failure tests per product.
Upload in Account setup → Implementation files & acceptance evidence. The data is saved in your account implementation records. Review with the named owner, record approval and attach the evidence. This register records decisions; it does not activate production configuration.
Load / review first: Project scope · Clinical workflow configuration
| Column | Required | Format | Example |
|---|---|---|---|
Test IDtest_id | Yes | text | UAT-001 |
Product IDproduct_id | Yes | text | outpatient |
Scenarioscenario | Yes | text | Visit from arrival to financial follow-up |
Preconditionspreconditions | Yes | text | Approved setup and synthetic data |
Exact actionsactions | Yes | text | TO-CONFIRM |
Expected resultexpected_result | Yes | text | TO-CONFIRM |
Actual resultactual_result | Yes | text | NOT-RUN |
Statusstatus | Yes | not_run / pass / fail / blocked | not_run |
Evidence referenceevidence_reference | Yes | text | EXAMPLE-REF-001 |
Approverapprover_role | Yes | text | Product owner |
Inventory every source EHR, department system, archive and ERP separately, including the exact installed product and licensed extraction route.
Upload this planning CSV in Account setup → Implementation files & acceptance evidence. Preview, apply and save. Keep source clinical files and identity crosswalk records in the approved secure migration workspace. Record actual evidence references after review; this register does not run a vendor connector or import patient history.
Load / review first: Project scope
| Column | Required | Format | Example |
|---|---|---|---|
System IDsystem_id | Yes | text | SRC-EPIC-001 |
Vendorvendor | Yes | text | Epic |
Installed productproduct | Yes | text | Epic EHR |
Installed releaserelease | Yes | text | TO-CONFIRM |
Environmentenvironment | Yes | test / production / archive | test |
Facilities coveredfacility_scope | Yes | text | EXAMPLE-FACILITY-001 |
Source administrator rolesource_owner | Yes | text | Source EHR administrator |
Approved extraction routeexport_route | Yes | text | EHI export assessment pending |
Licence/access evidencelicence_reference | Yes | text | EXAMPLE-REF-001 |
Release-specific specificationspecification_reference | Yes | text | https://open.epic.com/TechnicalSpecifications |
Illustrative operating cases
A clinic clinician requests a test; collection staff and the laboratory complete the diagnostic record.
Request, specimen, observations and report agree on identity, and a clinician owns result review.
The first specimen fails the local acceptance procedure and a later report requires correction.
The rejected specimen, replacement and report versions are traceable, with recorded communication responsibility.
Worked operating scenarios
Record the condition and reason, retain the original request reference and arrange recollection under the approved laboratory procedure.
Follow the locally approved reviewer and notification procedure; record who was informed and preserve the previous report and correction reason.
Delivery boundary
Native requests, specimens, observations and reports are distinct from an external LIS or analyzer connection. Device protocols, code mappings, acknowledgements and downtime recovery require interface testing for the chosen release.
Lab orders, specimen and result workflows with native operation distinct from external LIS integration. Request: Select the test from the service catalogue and link it to the patient, encounter and ordering clinician. Include the clinical question, priority and required specimen information. Collect & receive: Record specimen type, collection information, accession identifier, received time and condition. Keep processing notes and the original request linked so recollection can be traced. Record & review: Keep observations and diagnostic reports with the request and specimen. Configure the approved test definitions, units and result interpretation; name the result reviewer and critical-result communication route. Release & follow up: Make the approved report available in the clinical encounter. Preserve amendment reasons, reviewer responsibility and communication evidence; the ordering team owns the clinical follow-up.
Explore the detailsConfigure the selected release using the account templates, then validate references and preview before import. Required planning and setup files include Services & department catalogue (services.csv); Assets, devices & hardware (assets_devices.csv); Interface specification (interfaces.csv); Clinical workflow configuration (clinical_workflows.csv); Function settings · scheduling closures (product_settings.csv); Acceptance tests (uat_cases.csv). Each file’s field guide identifies whether it imports setup records or documents a migration/decision.
Explore the detailsRejected or insufficient specimen Record the condition and reason, retain the original request reference and arrange recollection under the approved laboratory procedure. Critical or corrected result Follow the locally approved reviewer and notification procedure; record who was informed and preserve the previous report and correction reason.
Explore the detailsNative requests, specimens, observations and reports are distinct from an external LIS or analyzer connection. Device protocols, code mappings, acknowledgements and downtime recovery require interface testing for the chosen release.
Explore the details