Extensions
Connect the agreed Saudi invoicing workflow to financial work.
ZATCA E-invoicing
Confirm the legal taxpayer, VAT identifier, applicable invoicing phase and invoice type. Assign the invoicing owner and record the approved tax and document identity rules.
Prepare the selected invoice unit, endpoint and securely managed credential references. Complete required onboarding and testing evidence; sample credentials or sandbox success do not authorize live submission.
Link the supported invoice to billing activity, document identity and tax treatment. Verify required invoice data and the selected reporting or clearance route before transmission.
Keep the supported response and trace with the invoice. Follow approved rejection, retry, credit-note and credential-renewal procedures and reconcile submitted documents to the billing ledger.
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 |
Draft charge definitions with release-bound SBS codes
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: Services & department catalogue
| Column | Required | Format | Example |
|---|---|---|---|
Facility numberfacility | Yes | integer 1–1000 | 1 |
Local service codeservice_code | Yes | text | EXAMPLE-SVC-001 |
Gross price in minor currency unitsgross_price_minor | Yes | integer 0–2147483647 | 15000 |
Currencycurrency | Yes | SAR | SAR |
SBS codesbs_code | Optional | text | — |
SBS releasesbs_release | Optional | text | — |
Mapping approval referencemapping_evidence | Optional | text | — |
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 |
Create the legal payer, insurer, administrator/TPA and provider counterparties that every downstream contract, policy, tariff and integration route names.
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 |
|---|---|---|---|
internal codeinternal_code | Yes | Source-backed value | TO-CONFIRM |
legal name arlegal_name_ar | Yes | Source-backed value | TO-CONFIRM |
legal name enlegal_name_en | Yes | Source-backed value | TO-CONFIRM |
country codecountry_code | Yes | Source-backed value | SA |
statusstatus | Yes | Readiness condition: status=active | draft |
evidence stateevidence_state | Yes | Readiness condition: evidence_state in activation-grade evidence | absent |
commercial registrationcommercial_registration | Optional | Source-backed value | TO-CONFIRM |
tax numbertax_number | Optional | Source-backed value | TO-CONFIRM |
license numberlicense_number | Optional | Source-backed value | TO-CONFIRM |
parent organizationparent_organization | Optional | Source-backed value | TO-CONFIRM |
contact directorycontact_directory | Optional | Source-backed value | TO-CONFIRM |
Approval referenceapproval_reference | Yes | text | EXAMPLE-REF-001 |
Mark which organization is the risk-bearing payer/insurer so policy, claim and settlement decisions do not infer that a TPA is the payer.
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: organizations
| Column | Required | Format | Example |
|---|---|---|---|
organizationorganization | Yes | Source-backed value | TO-CONFIRM |
rolerole | Yes | Readiness condition: role=insurer | insurer |
effective fromeffective_from | Yes | Source-backed value | 2026-10-09 |
statusstatus | Yes | Readiness condition: status=active | draft |
evidence stateevidence_state | Yes | Readiness condition: evidence_state in activation-grade evidence | absent |
effective toeffective_to | Optional | Source-backed value | 2026-10-09 |
network scopenetwork_scope | Optional | Source-backed value | TO-CONFIRM |
notesnotes | Optional | Source-backed value | TO-CONFIRM |
Approval referenceapproval_reference | Yes | text | EXAMPLE-REF-001 |
Record the signed hospital-provider commercial contract that gives authority for allowed pricing, billing windows and settlement terms.
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: organizations · insurer roles
| Column | Required | Format | Example |
|---|---|---|---|
payer or insurer orgpayer_or_insurer_org | Yes | Source-backed value | TO-CONFIRM |
provider facilityprovider_facility | Yes | Source-backed value | TO-CONFIRM |
contract numbercontract_number | Yes | Source-backed value | EXAMPLE-CONTRACT-001 |
effective fromeffective_from | Yes | Source-backed value | 2026-10-09 |
currencycurrency | Yes | Source-backed value | SAR |
statusstatus | Yes | Readiness condition: status=active | draft |
evidence stateevidence_state | Yes | Readiness condition: evidence_state in activation-grade evidence | absent |
effective toeffective_to | Optional | Source-backed value | 2026-10-09 |
network tiernetwork_tier | Optional | Source-backed value | TO-CONFIRM |
claim submission deadlineclaim_submission_deadline | Optional | Source-backed value | TO-CONFIRM |
payment termspayment_terms | Optional | Source-backed value | TO-CONFIRM |
appeal termsappeal_terms | Optional | Source-backed value | TO-CONFIRM |
Approval referenceapproval_reference | Yes | text | EXAMPLE-REF-001 |
Bind each legal taxpayer to ZATCA solution certificate and CSID secret references for legal invoice clearance/reporting.
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: organizations
| Column | Required | Format | Example |
|---|---|---|---|
taxpayer organizationtaxpayer_organization | Yes | Source-backed value | TO-CONFIRM |
vat registration numbervat_registration_number | Yes | Source-backed value | TO-CONFIRM |
environmentenvironment | Yes | Readiness condition: environment=production | TO-CONFIRM |
solution certificate referencesolution_certificate_reference | Yes | Source-backed value | EXAMPLE-REF-001 |
csid secret referencecsid_secret_reference | Yes | Source-backed value | EXAMPLE-SECRET-REF-001 |
statusstatus | Yes | Readiness condition: status=active | draft |
effective toeffective_to | Optional | Source-backed value | 2026-10-09 |
invoice type scopeinvoice_type_scope | Optional | Source-backed value | TO-CONFIRM |
phase wave referencephase_wave_reference | Optional | Source-backed value | EXAMPLE-REF-002 |
clearance endpointclearance_endpoint | Optional | Source-backed value | TO-CONFIRM |
reporting endpointreporting_endpoint | Optional | Source-backed value | TO-CONFIRM |
Approval referenceapproval_reference | Yes | text | EXAMPLE-REF-003 |
Reconcile normal, denied, partially paid, reversed and unmatched activity with explicit finance ownership.
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: Service prices & SBS mapping · provider contracts · Acceptance tests
| Column | Required | Format | Example |
|---|---|---|---|
Control codecontrol_code | Yes | text | EXAMPLE-FIN-01 |
Transaction typetransaction_type | Yes | charge / invoice / claim / remittance / reversal / refund / write_off | claim |
Currencycurrency | Yes | ISO 4217 | SAR |
Expected source totalsource_total | Yes | decimal | 1000.00 |
Observed target totaltarget_total | Yes | decimal | 1000.00 |
Approved tolerancetolerance | Yes | decimal; do not assume a tolerance | 0.00 |
Exception queue / ownerexception_route | Yes | text | Finance review |
Reconciliation evidenceevidence_reference | Yes | text | EXAMPLE-REF-001 |
Approval referenceapproval_reference | Yes | text | EXAMPLE-REF-002 |
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
An onboarded taxpayer submits a supported invoice through the agreed e-invoicing route.
Invoice, submission response and billing records reconcile under the agreed phase.
Submission is interrupted and an invoice needs correction under the accepted document rules.
The correction and renewal have evidence and no pending document is silently lost or assumed accepted.
Worked operating scenarios
Retain the response and original document identity, assign correction to the tax owner and use the accepted correction procedure.
Invoke the accepted continuity and renewal procedure and reconcile pending documents after recovery.
Delivery boundary
E-invoice scope, phase, document types and production onboarding are explicitly agreed. This module description is not a certification or compliance claim.
Supported e-invoice integration and onboarding, with applicable phase, configuration and operational responsibilities stated. Define taxpayer & phase: Confirm the legal taxpayer, VAT identifier, applicable invoicing phase and invoice type. Assign the invoicing owner and record the approved tax and document identity rules. Onboard the connection: Prepare the selected invoice unit, endpoint and securely managed credential references. Complete required onboarding and testing evidence; sample credentials or sandbox success do not authorize live submission. Prepare & validate invoice: Link the supported invoice to billing activity, document identity and tax treatment. Verify required invoice data and the selected reporting or clearance route before transmission. Submit & retain evidence: Keep the supported response and trace with the invoice. Follow approved rejection, retry, credit-note and credential-renewal procedures and reconcile submitted documents to the billing ledger.
Explore the detailsConfigure the selected release using the account templates, then validate references and preview before import. Required planning and setup files include zatca onboardings (rcm_zatca_onboardings.csv); Revenue & reconciliation controls (rcm_financial_controls.csv); Interface specification (interfaces.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 detailsInvoice rejected or required field missing Retain the response and original document identity, assign correction to the tax owner and use the accepted correction procedure. Credential expired or endpoint unavailable Invoke the accepted continuity and renewal procedure and reconcile pending documents after recovery.
Explore the detailsE-invoice scope, phase, document types and production onboarding are explicitly agreed. This module description is not a certification or compliance claim.
Explore the details