Extensions

Make every connection count.

Connect the data your teams need, with clear ownership.

Define the exchange

Name source and target systems, message types, direction, protocol and version. Agree whether the connection carries identity, encounters, orders, results, devices or financial activity and identify its owners.

  • Source and target owners
  • Interface scope, message inventory and responsibility
View the full workflow
01 / 04
01

System & Device Interfaces

From the first action to the final record.

01

Define the exchange

Name source and target systems, message types, direction, protocol and version. Agree whether the connection carries identity, encounters, orders, results, devices or financial activity and identify its owners.

Responsible team
Source and target owners
Data & records
Interface scope, message inventory and responsibility
02

Map identifiers & data

Map patient, facility, practitioner and encounter identifiers alongside service codes, units, timestamps and statuses. Define required fields, transformations and the treatment of unsupported values.

Responsible team
Integration and data team
Data & records
Field mapping, terminology and identifier crosswalk
03

Test & accept

Use the agreed test environment, credentials and endpoint. Verify valid, invalid, duplicate and delayed messages, acknowledgements, ordering and reconciliation before approving production access.

Responsible team
Integration owner and receiving users
Data & records
Test cases, acknowledgements, reconciliation and acceptance
04

Operate & recover

Monitor failed and pending exchanges and assign support responsibility. Follow approved retry and duplicate rules, then reconcile records after downtime, credential rotation or interface version changes.

Responsible team
Integration operations team
Data & records
Message trace, failure queue, retry and recovery evidence
02

Your configuration

The data that makes this module yours.

  1. Download the template for your account’s selected release.
  2. Use the sample to understand formats; replace every example with approved data.
  3. Load parent records first, then use their exact identifiers in dependent files.
  4. Upload in the named setup step, fix validation errors and review the preview.
  5. Apply and save; test the workflow and record approval before activation.
Your organizationorganization.csvAccount 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.

Columns, formats and example values
ColumnRequiredFormatExample
Registered organization namelegal_nameYestextExample Healthcare Organization
Commercial registration numberregistration_numberYestextEXAMPLE-CR-001
CountrycountryYesSA / AE / BH / KW / QA / OM / EG / OTHERSA
Tax registration numbervat_numberOptionaltext—
Facilitiesfacilities.csvAccount configuration

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

Columns, formats and example values
ColumnRequiredFormatExample
Facility namenameYestextExample Facility
Facility typetypeYeshospital / clinic / polyclinic / laboratory / otherclinic
Facility licenselicense_numberYestextEXAMPLE-LICENSE-001
AddressaddressYestextExample training address
PhonephoneYestext+966500000000
Time zonetimezoneYesAsia/Riyadh / Asia/Dubai / Asia/Qatar / Africa/Cairo / UTCAsia/Riyadh
Departmentsdepartments.csvAccount configuration

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

Columns, formats and example values
ColumnRequiredFormatExample
Facility number (starting at 1)facilityYesinteger 1–10001
Department namenameYestextExample Department
Rooms, wards and bedslocations.csvAccount configuration

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

Columns, formats and example values
ColumnRequiredFormatExample
Facility numberfacilityYesinteger 1–10001
Location namenameYestextExample Room
TypekindYesroom / ward / bedroom
Inside location (optional)parentOptionaltext—
Planned teamstaff.csvAccount configuration

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.

Columns, formats and example values
ColumnRequiredFormatExample
NamenameYestextExample Staff
Work emailemailYesemailstaff@example.invalid
Clinical roleroleYesfacility_admin / doctor / nurse / pharmacist / reception / billing / memberdoctor
Assets, devices & hardwareassets_devices.csvAccount configuration

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

Columns, formats and example values
ColumnRequiredFormatExample
Unique asset codeasset_codeYestextEXAMPLE-LAB-001
Facility numberfacilityYesinteger 1–10001
DepartmentdepartmentYestextExample Department
LocationlocationYestextExample Room
Device namenameYestextTraining laboratory analyser
ManufacturermanufacturerYestextExample manufacturer
ModelmodelYestextEXAMPLE-MODEL
Serial numberserial_numberYestextEXAMPLE-SERIAL
Product / department purposecare_typeYestextlaboratory
Interface protocol and versionprotocolOptionaltextTO-CONFIRM
Maintenance duemaintenance_dueOptionalYYYY-MM-DD2027-10-09
Function settings · scheduling closuresproduct_settings.csvAccount configuration

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

Columns, formats and example values
ColumnRequiredFormatExample
Facility numberfacilityYesinteger 1–10001
Selected feature IDfeatureYesschedulingscheduling
Function settingfunction_keyYesscheduling.closuresscheduling.closures
Closure namenameYestextExample closure
First closed datevalid_fromYesYYYY-MM-DD2026-12-01
Last closed datevalid_toYesYYYY-MM-DD2026-12-01
Closed fromstart_timeYesHH:MM08:00
Closed untilend_timeYesHH:MM17:00
Room (blank closes the whole facility)locationOptionaltextExample Room
Project scopeproject_scope.csvImplementation record

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.

Columns, formats and example values
ColumnRequiredFormatExample
Catalogue product IDproduct_idYestextoutpatient
Agreed releasereleaseYestextTO-CONFIRM
Operating modemodeYesnative / connectednative
Facility scopefacility_scopeYestextall
Included in this projectincludedYestrue / falsetrue
Accountable roleowner_roleYestextProject owner
Acceptance evidenceacceptance_testYestextApproved end-to-end test
Approval referenceapproval_referenceYestextEXAMPLE-REF-001
Access & approvalsaccess_matrix.csvImplementation record

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

Columns, formats and example values
ColumnRequiredFormatExample
RoleroleYestextdoctor
Facility scopefacility_scopeYestextEXAMPLE-FACILITY-001
ResourceresourceYestextPatient record
ActionactionYestextread
AllowedallowedYestrue / falsetrue
Approverapprover_roleYestextSecurity owner
Test evidenceevidence_referenceYestextEXAMPLE-REF-001
Service catalogueservice_catalogue.csvMigration preparation

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

Columns, formats and example values
ColumnRequiredFormatExample
Local service codeservice_codeYestextEXAMPLE-SVC-001
English namename_enYestextExample service
Arabic namename_arYestextخدمة تدريبية
Department codedepartment_codeYestextEXAMPLE-DEPT-001
Unit of serviceunitYestextTO-CONFIRM
Code systemcode_systemYestextTO-CONFIRM
Catalogue releasereleaseYestextTO-CONFIRM
Approved external mappingexternal_codeYestextTO-CONFIRM
Effective fromeffective_fromYesYYYY-MM-DD2026-10-09
Clinical workflow configurationclinical_workflows.csvImplementation record

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

Columns, formats and example values
ColumnRequiredFormatExample
Workflow IDworkflow_idYestextEXAMPLE-WF-001
Product IDproduct_idYestextoutpatient
Entry evententry_eventYestextPatient arrival
Responsible roleresponsible_roleYestextNurse
Required informationrequired_informationYestextVerified identity and visit context
Next eventnext_eventYestextClinical consultation
Handover ownerhandover_ownerYestextDoctor
Exception pathexception_pathYestextIdentity mismatch to review
Workflow approvalapproval_referenceYestextEXAMPLE-REF-001
Interface specificationinterfaces.csvImplementation record

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

Columns, formats and example values
ColumnRequiredFormatExample
Interface IDinterface_idYestextEXAMPLE-IF-001
Source systemsource_systemYestextSRC-EPIC-001
Target systemtarget_systemYestextMANSOQ
DirectiondirectionYesinbound / outbound / bidirectionalinbound
Protocol and versionprotocol_versionYestextTO-CONFIRM
Message scopemessage_scopeYestextTO-CONFIRM
Identifier mappingidentifier_mappingYestextTO-CONFIRM
Secret manager referencesecret_referenceYestextREFERENCE-ONLY
Retry and duplicate policyretry_policyYestextTO-CONFIRM
Failure ownerfailure_ownerYestextIntegration owner
Test evidencetest_referenceYestextEXAMPLE-REF-001
Acceptance testsuat_cases.csvImplementation record

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

Columns, formats and example values
ColumnRequiredFormatExample
Test IDtest_idYestextUAT-001
Product IDproduct_idYestextoutpatient
ScenarioscenarioYestextVisit from arrival to financial follow-up
PreconditionspreconditionsYestextApproved setup and synthetic data
Exact actionsactionsYestextTO-CONFIRM
Expected resultexpected_resultYestextTO-CONFIRM
Actual resultactual_resultYestextNOT-RUN
StatusstatusYesnot_run / pass / fail / blockednot_run
Evidence referenceevidence_referenceYestextEXAMPLE-REF-001
Approverapprover_roleYestextProduct owner
Existing systems & versionssource_systems.csvImplementation record

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

Columns, formats and example values
ColumnRequiredFormatExample
System IDsystem_idYestextSRC-EPIC-001
VendorvendorYestextEpic
Installed productproductYestextEpic EHR
Installed releasereleaseYestextTO-CONFIRM
EnvironmentenvironmentYestest / production / archivetest
Facilities coveredfacility_scopeYestextEXAMPLE-FACILITY-001
Source administrator rolesource_ownerYestextSource EHR administrator
Approved extraction routeexport_routeYestextEHI export assessment pending
Licence/access evidencelicence_referenceYestextEXAMPLE-REF-001
Release-specific specificationspecification_referenceYestexthttps://open.epic.com/TechnicalSpecifications
Open the full implementation handbook: assumptions, migration, interfaces, acceptance and cutover
03

Illustrative operating cases

Two cases. Every handover explained.

01Illustrative scenario

External diagnostic result exchange

An external diagnostic system returns accepted reports to the MANSOQ clinical context.

Prepare first
Accepted protocol and version, patient/encounter crosswalk, test codes, units and response rules.
  1. Define message direction, required fields and the owner of each source identifier.
  2. Test matched, invalid, duplicate and delayed results in the accepted environment.
  3. Approve production exchange only after mappings and reconciliation pass.
  4. Monitor pending messages and confirm each accepted report’s clinical destination.

Acceptance evidence

Every accepted result has an identifiable source, business identity and receiving patient/encounter.

02Illustrative scenario

Outage, duplicate retry and mapping change

A source replays messages after downtime while its terminology edition is changing.

Prepare first
Message trace, duplicate policy, mapping versions, recovery owner and representative test cases.
  1. Retain original message identities and investigate receipt before retrying.
  2. Separate already accepted messages from unprocessed work under the agreed duplicate rules.
  3. Version the terminology change and test historical and new codes.
  4. Reconcile recovered records and approve the change before regular operation resumes.

Acceptance evidence

Recovery does not create unexplained duplicates, and source-to-target mapping changes are traceable.

04

Worked operating scenarios

When the normal path changes.

Duplicate message or missing acknowledgement

Check the original business identity and accepted idempotency rules; reconcile the target before deciding whether to retry.

Source terminology changes

Version the mapping, review affected records and test both old and new values before activating the change.

05

Delivery boundary

Know what connects, and what needs approval.

Available protocols and adapters are release-specific. A third-party system name or standards logo is not proof of an active connector; accept the exact data, direction, license and support scope.

Operating modes
Native · Connected
Product readiness
Scope review required for your release
Supported release
Confirm in the accepted scope

Your questions, answered.

What does MANSOQ System & Device Interfaces cover?

Actual HIS, LIS, RIS/PACS, identity, device or API connections, protocols, licenses and delivery scope are specified individually. Define the exchange: Name source and target systems, message types, direction, protocol and version. Agree whether the connection carries identity, encounters, orders, results, devices or financial activity and identify its owners. Map identifiers & data: Map patient, facility, practitioner and encounter identifiers alongside service codes, units, timestamps and statuses. Define required fields, transformations and the treatment of unsupported values. Test & accept: Use the agreed test environment, credentials and endpoint. Verify valid, invalid, duplicate and delayed messages, acknowledgements, ordering and reconciliation before approving production access. Operate & recover: Monitor failed and pending exchanges and assign support responsibility. Follow approved retry and duplicate rules, then reconcile records after downtime, credential rotation or interface version changes.

Explore the details
What setup data does System & Device Interfaces need?

Configure the selected release using the account templates, then validate references and preview before import. Required planning and setup files include Interface specification (interfaces.csv); Assets, devices & hardware (assets_devices.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 details
How does System & Device Interfaces handle exceptions?

Duplicate message or missing acknowledgement Check the original business identity and accepted idempotency rules; reconcile the target before deciding whether to retry. Source terminology changes Version the mapping, review affected records and test both old and new values before activating the change.

Explore the details
How does System & Device Interfaces connect with other systems?

Available protocols and adapters are release-specific. A third-party system name or standards logo is not proof of an active connector; accept the exact data, direction, license and support scope.

Explore the details
Explore all frequently asked questions