3. Development

This section gives information about the Development of EHRbase and documents the software in detail.

• 3.1. Developing
• 3.2. Testing
  • 3.2.1. EHRbase Integration Tests with Robot Framework
    • 3.2.1.1. Prerequisites
    • 3.2.1.2. Test Environment & SUT
    • 3.2.1.3. Test Execution (under Linux, Mac & Windows)
      • 3.2.1.3.1. With Robot Command
      • 3.2.1.3.2. With Shell Script
      • 3.2.1.3.3. Example Content Of Shell Script (run_local_tests.sh)
    • 3.2.1.4. Local SUT / Manually Controlled SUT
    • 3.2.1.5. Remote SUT / OR how to execute the tests against other systems
      • 3.2.1.5.1. Run all tests at one (not recommended)
      • 3.2.1.5.2. Run single test suites, one by one (recommended)
    • 3.2.1.6. Execution Control - Test Suites & Tags
    • 3.2.1.7. CI/CD Pipeline (on CircleCI)
    • 3.2.1.8. Errors And Warnings
    • 3.2.1.9. Auto-Generated Test Report Summary And Detailed Log
  • 3.2.2. RESTORE KEYCLOAK FROM PREVIOUSLY EXPORTED CONFIGURATION
  • 3.2.3. EXPORT COMPLETE KEYCLOAK CONFIGURATION
  • 3.2.4. CI/CD
    • 3.2.4.1. Continuous Integration
    • 3.2.4.2. Pipeline workflow 1/3 - build-and-test
    • 3.2.4.3. Pipeline workflow 2/3 - release
    • 3.2.4.4. Pipeline workflow 3/3 - synced-feature-check
• 3.3. Deploying
• 3.4. Docker Images
  • 3.4.1. EHRbase Docker Image
    • 3.4.1.1. Build EHRbase Image
      • 3.4.1.1.1. Build Image From Dockerfile
      • 3.4.1.1.2. Why To Build Own Image?
    • 3.4.1.2. Use EHRbase Image
      • 3.4.1.2.1. Run EHRbase in Docker
      • 3.4.1.2.2. Run EHRbase + DB with Docker-Compose
      • 3.4.1.2.3. Docker environment examples
    • 3.4.1.3. Publish EHRbase Image
      • 3.4.1.3.1. Docker Hub Autobuilds
      • 3.4.1.3.2. Docker Hub Configuration
  • 3.4.2. EHRbase DB Docker Image
    • 3.4.2.1. Build DB Image
      • 3.4.2.1.1. Build Image From Dockerfile
    • 3.4.2.2. Use DB Image
      • 3.4.2.2.1. Run DB with default parameters
      • 3.4.2.2.2. Customization
• 3.5. Technical Documentation
  • 3.5.1. Overview
  • 3.5.2. Service Layer
    • 3.5.2.1. General
    • 3.5.2.2. openEHR Platform Abstract Service Model
      • 3.5.2.2.1. EHR
      • 3.5.2.2.2. EHR_STATUS
      • 3.5.2.2.3. DIRECTORY
      • 3.5.2.2.4. COMPOSITION
      • 3.5.2.2.5. CONTRIBUTION
  • 3.5.3. New Contain Clause Resolution Strategy
  • 3.5.4. Backgroud
    • 3.5.4.1. Previous Approach
    • 3.5.4.2. New Approach
      • 3.5.4.2.1. Assumptions
      • 3.5.4.2.2. Objectives
      • 3.5.4.2.3. Technical Approach
• 3.6. Security
• 3.7. Admin API
  • 3.7.1. Security
    • 3.7.1.1. General
    • 3.7.1.2. Role based access control
    • 3.7.1.3. Security related response codes
  • 3.7.2. /admin/ehr
    • 3.7.2.1. DELETE /admin/ehr/{:ehr_id}
      • 3.7.2.1.1. Request format
      • 3.7.2.1.2. Response format
  • 3.7.3. /admin/{:ehr_id}/composition
    • 3.7.3.1. DELETE /admin/{:ehr_id}/composition/{:composition_id}
      • 3.7.3.1.1. Request format
      • 3.7.3.1.2. Response format
  • 3.7.4. /admin/{:ehr_id}/contribution
    • 3.7.4.1. DELETE /admin/{:ehr_id}/contribution/{:contribution_id}
      • 3.7.4.1.1. Request format
      • 3.7.4.1.2. Response format
  • 3.7.5. /admin/{:ehr_id}/directory
    • 3.7.5.1. DELETE /admin/{:ehr_id}/directory/{:folder_id}
      • 3.7.5.1.1. Request format
      • 3.7.5.1.2. Response format
  • 3.7.6. /admin/template
    • 3.7.6.1. PUT /admin/template/:template_id
      • 3.7.6.1.1. Request format
      • 3.7.6.1.2. Response format
    • 3.7.6.2. DELETE /admin/template/:template_id
      • 3.7.6.2.1. Request format
      • 3.7.6.2.2. Response format
    • 3.7.6.3. DELETE /admin/template/all
      • 3.7.6.3.1. Request format
      • 3.7.6.3.2. Response format
• 3.8. Status and Metrics
  • 3.8.1. Security
  • 3.8.2. Usage
  • 3.8.3. /management/env
  • 3.8.4. /management/health
  • 3.8.5. /management/info
  • 3.8.6. /management/metrics
  • 3.8.7. /management/prometheus
• 3.9. Attribute-based Access Control
  • 3.9.1. Concept
  • 3.9.2. Configuration
  • 3.9.3. Detailed endpoint overview
    • 3.9.3.1. EHR
    • 3.9.3.2. EHR Status
    • 3.9.3.3. Composition
    • 3.9.3.4. Contribution
    • 3.9.3.5. Query
• 3.10. Plugin system (WIP)
  • 3.10.1. Concept
  • 3.10.2. Using plugins
  • 3.10.3. Example plugins
  • 3.10.4. Developing plugins
    • 3.10.4.1. Plugin project setup
    • 3.10.4.2. Dependencies
    • 3.10.4.3. Plugin entrypoint
    • 3.10.4.4. Extension points
    • 3.10.4.5. Plugin configuration