Connector Details
Type
Virtual machines, Single VM , BYOL
Runs on
Google Compute Engine
Last Update
24 October, 2024
Category
Health Services
Saudi Health Council Connector
Overview
The Saudi Health Council Open Data Connector enables seamless integration with the Saudi Health Council’s Open Data API, providing structured access to healthcare-related datasets such as council decisions, clinics, medical centers, budget allocations, employee statistics, and more. The connector facilitates real-time data retrieval to support health analytics, reporting dashboards, and public transparency initiatives
Integration Overview
This document outlines each integration point, its purpose, parameters, and usage patterns using the Saudi Health Council Open Data Connector.
Supported Integration Action Points
- getCouncilDecisions: Retrieves a list of council decisions.
- getEarlyDetectionHospitals:: Retrieves early diagnosis clinics in general hospitals.
- getEarlyDetectionClinics: Retrieves early diagnosis clinics in primary care centers.
- getMedicalDiagnosticCenters: Retrieves medical diagnostic centers.
- getRehabilitationCenters: Retrieves early intervention and rehabilitation service centers.
- getBudgetData: Retrieves fiscal year budget data.
- getExpenditureData:Retrieves detailed expenditure information.
- getEServicesList: Retrieves a list of electronic services.
- getEServicesData:Retrieves usage statistics and success rates for e-services.
- getTenderData: Retrieves public tender information.
- getTechSpecializations: Retrieves information on certified technical specialists.
- getTotalEmployees: Retrieves total employee counts by department and gender.
- getTrainingData: Retrieves training program data.
Detailed Integration Documentation
Council Decisions Retrieval
Action
getCouncilDecisions
Purpose
Retrieves a comprehensive list of Saudi Health Council decisions.
Parameters
- Required: None.
- Optional:None
Configuration
Ensure the connector is properly authenticated and pointed to the production server.
Output
- Successful:Returns an array of council decision objects, including DecisionID, DecisionTitle, DecisionText, DecisionCategory, etc.
- Failure: Returns error details (e.g., server error).
Workflow Example
- Execute the getCouncilDecisions action.
- Parse the list of decisions for reporting or dashboard display.
Early Detection Clinics – Hospitals
Action
getEarlyDetectionHospitals
Purpose
Retrieves data on early diagnosis clinics located within general hospitals.
Parameters
- Required: None.
- Optional: None.
Output
- Successful: Returns a list of hospitals with clinic services and associated fields like HospitalName, Location, and ServicesOffered.
- Failure: Returns error details (e.g., upstream connectivity issue).
Workflow Example
- Execute getEarlyDetectionHospitals.
- Display results on a public health services portal.
Early Detection Clinics – Primary Care
Action
getEarlyDetectionClinics
Purpose
Retrieves data on early diagnosis clinics in primary care centers.
Output
- Successful: Returns clinic data including ClinicName, Region, AvailableTests, and OperatingHours.
- Failure: Returns error details.
Workflow Example
Execute the action and list primary care clinics by region.
Medical Diagnostic Centers
Action
getMedicalDiagnosticCenters
Purpose
Retrieves operational medical diagnostic centers and their capabilities.
Output
- Successful: Returns fields such as CenterName, Specialization, and EquipmentList.
- Failure: Returns error information.
Workflow Example
Fetch diagnostic center data for integration into healthcare locator tools.
Rehabilitation Centers
Action
getRehabilitationCenters
Purpose
Retrieves information on early intervention and rehabilitation service centers
Output
- Successful: Returns data including CenterName, Services, AgeGroupsServed, and InsuranceAccepted.
- Failure: Returns error details.
Workflow Example
Use the API to populate maps or directories for parents seeking services for children with disabilities.
Budget Data Retrieval
Action
getBudgetData
Purpose
Retrieves fiscal budget allocation data filtered by year.
Parameters
- Optional:fiscalYear – Filter data by year (e.g., “2023”).
Output
- Successful: Returns budget data with AllocatedAmount, Expenditure, and PercentageUtilized.
- Failure: Returns error details.
Workflow Example
Set fiscalYear=2023 to analyze current year funding across healthcare projects.
Expenditure Data Retrieval
Action
getExpenditureData
Purpose
Retrieves actual expenditure amounts per category.
Output
- Successful: Returns records with ExpenseCategory, AmountSpent, and PercentageOfBudget.
- Failure: Returns error details.
Workflow Example
Compare budget allocation vs. actual spending using visual dashboards.
Electronic Services Listing
Action
getEServicesList
Purpose
Retrieves a catalog of all SHC e-services.
Output
- Successful:Returns service details including ServiceName, Category, and OnlineAvailability.
- Failure:Returns error details.
Workflow Example
List available services with average processing times for user portals.
Electronic Services Data
Action
getEServicesData
Purpose
Retrieves e-service usage statistics such as number of users and success rates.
Output
- Successful: Returns metrics like MonthlyUsers, SuccessRate, and CommonIssues.
- Failure: Returns error details.
Workflow Example
Display service performance metrics in government transparency dashboards.
Tender Data Retrieval
Action
getTenderData
Purpose
Retrieves data on SHC tenders, with optional filtering.
Parameters
- Optional:status – Filter tenders by status (open, closed, awarded).
Output
- Successful:Returns fields such as TenderID, Title, PublishDate, Status, and Budget.
- Failure: Returns error details.
Workflow Example
Execute with status=open to show active tenders on procurement platforms.
Technical Specializations
Action
getTechSpecializations
Purpose
Retrieves certified technical specialist information.
Output
- Successful:Returns data including SpecializationName, NumberOfCertifiedSpecialists, and CertificationBody.
- Failure:Returns error details.
Workflow Example
Use the results to assess workforce readiness across technical areas.
Total Employees
Action
getTotalEmployees
Purpose
Retrieves the total number of employees across departments.
Output
- Successful:Returns overall counts and breakdowns by Department and Gender.
- Failure: Returns error details.
Workflow Example
Integrate with HR analytics to visualize workforce composition.
Training Programs
Action
getTrainingData
Purpose
Retrieves data on conducted training programs.
Parameters
- Optional:year – Filter by training year (e.g., “2023”).
Output
- Successful:Returns training records including ProgramName, Participants, and AccreditationHours.
- Failure:Returns error details.
Workflow Example
Fetch training stats by year to report on capacity-building initiatives.
Dataset GPX Export
Action
exportRecordsGPX
Purpose
Exports a dataset in GPX format. This is suitable for geographic data visualization and GPS applications.
Parameters
- Required:dataset_id.
- Optional:
- name_field, description_field_list, use_extension (boolean, default: true), and others as in exportRecords.
Configuration
Ensure the connector is configured with the correct base URL.
Output
- Successful:Returns a GPX file.
- Failure:Returns error details (e.g., invalid parameters).
Workflow Example
1. Execute the exportRecordsGPX action with dataset_id=lands-sales and name_field=name.
2. Save the GPX file.
3. Use the file for geographic data visualization.
Dataset Facets Retrieval
Action
getRecordsFacets
Purpose
Retrieves facet values for records in a specific dataset. This aids in filtering and navigating dataset records effectively.
Parameters
- Required:dataset_id.
- Optional:
- facet, where, refine, exclude, lang, timezone, apikey.
Configuration
Ensure the connector is configured with the correct base URL.
Output
- Successful:Returns a JSON object with links and facets arrays.
- Failure:Returns error details (e.g., invalid facet).
Workflow Example
1. Use the getDataset action to select lands-sales.
2. Execute the getRecordsFacets action with dataset_id=lands-sales and facet=transaction_type.
3. Use facet values to refine record queries.
Dataset Attachments Retrieval
Action
getDatasetAttachments
Purpose
Retrieves files or attachments related to a specific dataset. This provides access to supplementary data or resources.
Parameters
- Required:dataset_id.
- Optional:
- None.
Configuration
Ensure the connector is configured with the correct base URL.
Output
- Successful:Returns a JSON object with links and attachments arrays (e.g., href, mime-type, title).
- Failure:Returns error details (e.g., invalid dataset_id).
Workflow Example
1. Use the getDataset action to select lands-sales.
2. Execute the getDatasetAttachments action with dataset_id=lands-sales.
3. Download attachments (e.g., lands_sales_archive.zip) for further use.
Workflow Creation with the Connector
Extracting Healthcare Council Insights
Retrieve Council Decisions
- Use getCouncilDecisions to list all formal decisions.
- Store or categorize decisions by DecisionCategory.
Access Budget and Spending
- Use getBudgetData for fiscal allocations.
- Use getExpenditureData to compare against actual spending.
Analyze Human Resources
- Use getEServicesList to fetch services offered.
- Use getEServicesData to monitor performance and identify common issues.
Monitor E-Service Usage
- Encode the dataset in CSV format using the exportRecordsCSV action with dataset_id=lands-sales.
- Export the dataset in Parquet format via the exportRecordsParquet action for analytical processing.
- Generate a GPX file for geographic visualization using the exportRecordsGPX action with name_field=name.
Locate Public Health Facilities
- Fetch primary and hospital-based clinics using getEarlyDetectionClinics and getEarlyDetectionHospitals.
- Get diagnostic and rehabilitation centers with getMedicalDiagnosticCenters and getRehabilitationCenters.
Pricing
iSolution logo - white - transparent 250 px