Cardinal Introductory Tutorial

This repository contains the example code used in the introductory tutorial. It showcases several self-contained use cases that highlight the main features of the Cardinal SDK, including:

• Creating a patient.
• Generating medical data for that patient (simulating a medical examination with multiple exams).
• Searching through the medical data.
• Sharing the medical data with other doctors and patients.
• Utilizing codifications such as SNOMED-CT and LOINC.

The tutorial code is available in Kotlin, Python, and TypeScript. Below you will find instructions for running the code in all three languages. For further explanations and examples, check the Cardinal documentation.

Launching the Tutorial in Kotlin

To run the tutorial in Kotlin, clone this repository:

git clone https://github.com/icure/cardinal-introductory-tutorial.git

Then, open the folder in IntelliJ and run the main function

Launching the Tutorial in Python

To run the tutorial in Python, clone this repository:

git clone https://github.com/icure/cardinal-introductory-tutorial.git
cd cardinal-introductory-tutorial

It is recommended to use a virtual environment, to avoid conflicting dependencies. The minimum supported Python version is 3.9.

cd python
python3 -m venv venv
source venv/bin/activate

Then, install the Cardinal SDK from PyPI.

pip install cardinal-sdk

Finally, run the example Python code.

python src/main.py

Launching the Tutorial in Typescript

To run the tutorial in Typescript, clone this repository:

git clone https://github.com/icure/cardinal-introductory-tutorial.git
cd cardinal-introductory-tutorial

The minimum supported Node version is 19. You can install it using nvm.

nvm install 19
nvm use 19

Then, you can navigate to the typescript directory and install the required dependencies using yarn.

cd typescript
yarn install

Finally, run the example Typescript code using yarn:

yarn ts-node --esm src/main.ts