### Prepare Frontend Module for E2E Tests

Source: https://github.com/samply/blaze/blob/main/modules/frontend-e2e/README.md

Execute these commands within the frontend module directory to install dependencies, test data, and Playwright, then start the Docker Compose services and upload necessary files.

```sh
make install
make -C test-data install
make install-playwright
docker compose up --wait
./upload.sh
```

--------------------------------

### Start Distributed Backend with Docker Compose

Source: https://github.com/samply/blaze/blob/main/docs/deployment/distributed-backend.md

Use this command to start the distributed backend system including Kafka and Cassandra. Ensure you are in the `docs/deployment/distributed` directory.

```bash
docker compose up -d
```

--------------------------------

### Start Keycloak

Source: https://github.com/samply/blaze/blob/main/modules/frontend/README.md

Start the Keycloak service using Docker Compose. Use the --wait flag to ensure it's ready before proceeding.

```sh
docker compose up --wait
```

--------------------------------

### Configure KV Resource Store

Source: https://github.com/samply/blaze/blob/main/modules/db-resource-store/README.md

Configuration example for the KV implementation of the Resource Store. It shows how to set up the key-value store, parsing context, and executor. The In-Memory Key Value Store is used as an example, but other implementations are possible.

```clojure
:blaze.db.resource-store/kv
   {:kv-store #blaze/ref :blaze.db/resource-kv-store
    :parsing-context #blaze/ref :blaze.fhir/parsing-context
    :executor #blaze/ref :blaze.db.resource-store.kv/executor}

:blaze.db.resource-store.kv/executor {}

[:blaze.db.kv/mem :blaze.db/resource-kv-store] {:column-families {}}
```

--------------------------------

### Start Copy Docker Compose

Source: https://github.com/samply/blaze/blob/main/docs/data-sync.md

Starts the Docker Compose environment for source and destination Blaze servers to test full data cloning.

```sh
docker compose -f docs/data-sync/copy/docker-compose.yml up
```

--------------------------------

### Start Keycloak for Authentication Testing

Source: https://github.com/samply/blaze/blob/main/docs/authentication.md

Use this command to start the Keycloak service, which acts as the OpenID Connect provider for testing Blaze's authentication.

```sh
docker compose up keycloak
```

--------------------------------

### Start Blaze with Authentication Enabled

Source: https://github.com/samply/blaze/blob/main/docs/authentication.md

After Keycloak is running, use this command to start Blaze. Ensure the OPENID_PROVIDER_URL environment variable is set for authentication to be active.

```sh
docker compose up blaze
```

--------------------------------

### Start Subscription Docker Compose

Source: https://github.com/samply/blaze/blob/main/docs/data-sync.md

Starts the Docker Compose environment for HAPI and Blaze servers to test FHIR subscription synchronization.

```sh
docker compose -f docs/data-sync/subscription/docker-compose.yml up
```

--------------------------------

### Build SUSHI IG

Source: https://github.com/samply/blaze/blob/main/DEVELOPMENT.md

Execute the make command to build the SUSHI Implementation Guide.

```shell
make build-job-ig
```

--------------------------------

### Nginx Ingress Configuration

Source: https://github.com/samply/blaze/blob/main/docs/deployment/full-standalone.md

Example configuration for the nginx ingress component. This setup is a guideline and not recommended for direct production use. It configures environment variables for Blaze and Keycloak hosts and mounts necessary certificates.

```yaml
ingress:
  image: "nginx:1.27.2"
  environment:
    BLAZE_HOST: "blaze.localhost"
    KEYCLOAK_HOST: "keycloak.localhost"
  ports:
  - "443:443"
  volumes:
  - "../../../modules/ingress/default.conf.template:/etc/nginx/templates/default.conf.template:ro"
  - "../../../modules/ingress/blaze-cert.pem:/etc/nginx/conf.d/blaze-cert.pem:ro"
  - "../../../modules/ingress/blaze-key.pem:/etc/nginx/conf.d/blaze-key.pem:ro"
  - "../../../modules/ingress/keycloak-cert.pem:/etc/nginx/conf.d/keycloak-cert.pem:ro"
  - "../../../modules/ingress/keycloak-key.pem:/etc/nginx/conf.d/keycloak-key.pem:ro"
```

--------------------------------

### Build Blaze Frontend

Source: https://github.com/samply/blaze/blob/main/modules/frontend/README.md

Run this command to install NPM dependencies and build the frontend.

```sh
make clean build
```

--------------------------------

### Start Keycloak with Docker Compose

Source: https://github.com/samply/blaze/blob/main/docs/deployment/full-standalone.md

Initiate the Keycloak service first to ensure it's fully operational before starting other Blaze components. This prevents delays in fetching Keycloak configuration.

```sh
docker compose up -d keycloak
```

--------------------------------

### Basic Docker Compose Configuration

Source: https://context7.com/samply/blaze/llms.txt

Example docker-compose.yml for a standalone Blaze instance with Nginx as ingress.

```yaml
services:
  ingress:
    image: "nginx:1.27.2"
    ports:
      - "443:443"
    volumes:
      - "./nginx.conf:/etc/nginx/conf.d/default.conf:ro"
      - "./tls-cert.pem:/etc/nginx/tls-cert.pem:ro"
      - "./tls-key.pem:/etc/nginx/tls-key.pem:ro"

  frontend:
    image: "samply/blaze-frontend:1.7.0"
    environment:
      ORIGIN: "https://blaze.example.com"
      BACKEND_BASE_URL: "http://backend:8080"
      AUTH_CLIENT_ID: "blaze-frontend"
      AUTH_CLIENT_SECRET: "your-client-secret"
      AUTH_ISSUER: "https://keycloak.example.com/realms/blaze"
      AUTH_SECRET: "$(openssl rand -hex 32)"  # min 32 chars
      PROTOCOL_HEADER: "x-forwarded-proto"
      HOST_HEADER: "x-forwarded-host"

  backend:
    image: "samply/blaze:1.7.0"
    environment:
      JAVA_TOOL_OPTIONS: "-Xmx8g"
      BASE_URL: "https://blaze.example.com"
      OPENID_PROVIDER_URL: "https://keycloak.example.com/realms/blaze"
      OPENID_PROVIDER_ISSUER: "https://keycloak.example.com/realms/blaze"
      OPENID_AUDIENCE: "blaze-frontend"
      ENABLE_ADMIN_API: "true"
      DB_BLOCK_CACHE_SIZE: "8192"
      CQL_EXPR_CACHE_SIZE: "1024"
    volumes:
      - "blaze-data:/app/data"

  keycloak:
    image: "quay.io/keycloak/keycloak:24.0.1"
    command: "start --import-realm --hostname=keycloak.example.com --proxy-headers forwarded --http-enabled true"
    environment:
      KEYCLOAK_ADMIN: admin
      KEYCLOAK_ADMIN_PASSWORD: admin
    volumes:
      - "./keycloak/import:/opt/keycloak/data/import"

volumes:
  blaze-data:

```

--------------------------------

### Install cljfmt Tool

Source: https://github.com/samply/blaze/blob/main/DEVELOPMENT.md

Install the cljfmt code formatter using Clojure CLI tools. Ensure you use the latest stable release tag for cljfmt.

```shell
clj -Ttools install io.github.weavejester/cljfmt '{:git/tag "`[`<latest-stable-release>`](https://github.com/weavejester/cljfmt/releases/latest)`"}' :as cljfmt
```

--------------------------------

### Example List Resource with Patient References

Source: https://github.com/samply/blaze/blob/main/docs/cql-queries/api.md

A sample List resource showing patient references. Each 'entry.item.reference' points to a Patient resource.

```json
{
  "resourceType": "List",
  "id": "C6QKSKQ2V7DAF3X6",
  "meta": {
    "versionId": "913",
    "lastUpdated": "2021-06-14T12:50:19.711Z"
  },
  "status": "current",
  "mode": "working",
  "entry": [
    {
      "item": {
        "reference": "Patient/C6QKGRHBFJIQ3B5U"
      }
    },
    {
      "item": {
        "reference": "Patient/C6QKGROQ5G5NCKUY"
      }
    }
  ]
}
```

--------------------------------

### Example Type Query

Source: https://github.com/samply/blaze/blob/main/docs/implementation/database.md

This query demonstrates how to retrieve resources of a specific type that match multiple token search parameters. The query planner optimizes by choosing the most selective parameter for the initial scan.

```clojure
(d/type-query db "Observation" [["status" "final"] ["code" "http://loinc.org|9843-4"]])
```

--------------------------------

### Asynchronous Request Example

Source: https://github.com/samply/blaze/blob/main/docs/api.md

Initiates a request that will be processed asynchronously.

```APIDOC
## Initiating an Asynchronous Request

### Description
To initiate a synchronous request, the HTTP header `Prefer` has to set to `respond-async`.

### Method
GET

### Endpoint
[base]/[resource]?parameters

### Headers
- **Prefer**: respond-async

### Request Example
```sh
curl -svH 'Prefer: respond-async' "http://localhost:8080/fhir/Observation?code=http://loinc.org|8310-5&_summary=count"
```

### Response (202 Accepted)

### Response Example
```text
HTTP/1.1 202 Accepted
Content-Location: http://localhost:8080/fhir/__async-status/DD7MLX6H7OGJN7SD
```
```

--------------------------------

### Run System REPL with Makefile

Source: https://github.com/samply/blaze/blob/main/DEVELOPMENT.md

Use this Makefile alias to start a REPL for running Blaze as a system. Refer to the Makefile, deps.edn, and dev/blaze/dev.clj for more details.

```makefile
emacs-repl
```

--------------------------------

### Compact Operation using blazectl

Source: https://github.com/samply/blaze/blob/main/docs/api/operation/compact.md

Example of how to execute the $compact operation using the blazectl command-line tool. Specify the server and the database and column family to compact.

```sh
blazectl --server http://localhost:8080/fhir compact index resource-as-of-index
```

--------------------------------

### Requesting a Query Plan

Source: https://github.com/samply/blaze/blob/main/docs/api/interaction/search-type.md

Append `__explain=true` to any search request to get the query plan. The plan is returned as a diagnostics string within an `OperationOutcome` resource.

```http
GET /Observation?status=final&date=2025&__explain=true
```

```http
GET /Observation?status=final&code=http://loinc.org|9843-4&__explain=true
```

--------------------------------

### View GitHub Issue Details

Source: https://github.com/samply/blaze/blob/main/AGENTS.md

Use this command to fetch detailed information about a specific GitHub issue. This is helpful when starting work on an issue.

```bash
gh issue view <issue-number>
```

--------------------------------

### Sample Prometheus Metrics Output

Source: https://context7.com/samply/blaze/llms.txt

Example output of Prometheus metrics exposed by Blaze.

```text
blaze_db_resource_count{type="Patient"} 42837
blaze_db_resource_count{type="Observation"} 1284729
blaze_cql_evaluate_measure_duration_seconds_bucket{le="0.5"} 12
blaze_http_requests_total{method="GET",status="200"} 4820
```

--------------------------------

### Run Load Tests Locally with k6

Source: https://github.com/samply/blaze/blob/main/modules/load-test/README.md

Set the base URL and access token, then run the patient everything test and generate a report. Ensure k6 is installed locally.

```sh
export BASE="http://localhost:8080/fhir"
export ACCESS_TOKEN=...
make run-patient-everything
make report
```

--------------------------------

### Query Plan Format Example 1

Source: https://github.com/samply/blaze/blob/main/docs/api/interaction/search-type.md

This query plan indicates that the `status` parameter is used for index scanning (ordered) and the `date` parameter is used for seeking.

```text
SCANS: status(ordered); SEEKS: date
```

--------------------------------

### Bundle with Included Patient Resources

Source: https://github.com/samply/blaze/blob/main/docs/cql-queries/api.md

An example Bundle returned when using the '_include=List:item' parameter. It contains the List resource and the included Patient resources.

```json
{
  "resourceType": "Bundle",
  "id": "C6QKZUY3NTTIU5M5",
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "http://localhost:8080/fhir/List/C6QKSKQ2V7DAF3X6",
      "resource": {
        "resourceType": "List",
        "id": "C6QKSKQ2V7DAF3X6",
        "meta": {
          "versionId": "913",
          "lastUpdated": "2021-06-14T12:50:19.711Z"
        },
        "status": "current",
        "mode": "working",
        "entry": [
          {
            "item": {
              "reference": "Patient/C6QKGRHBFJIQ3B5U"
            }
          },
          {
            "item": {
              "reference": "Patient/C6QKGROQ5G5NCKUY"
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "http://localhost:8080/fhir/Patient/C6QKGROQ5G5NCKUY",
      "resource": {
        "resourceType": "Patient",
        "id": "C6QKGROQ5G5NCKUY",
        "meta": {
          "versionId": "7",
          "lastUpdated": "2021-06-14T11:07:25.416Z"
        },
        "gender": "male",
        "birthDate": "1913-10-06"
      },
      "search": {
        "mode": "include"
      }
    },
    {
      "fullUrl": "http://localhost:8080/fhir/Patient/C6QKGUT6PPAUX3FV",
      "resource": {
        "resourceType": "Patient",
        "id": "C6QKGUT6PPAUX3FV",
        "meta": {
          "versionId": "59",
          "lastUpdated": "2021-06-14T11:08:13.899Z"
        }, 
        "gender": "male",
        "birthDate": "2006-03-15"
      },
      "search": {
        "mode": "include"
      }
    }
  ]
}
```

--------------------------------

### Basic Search Request

Source: https://github.com/samply/blaze/blob/main/docs/api/interaction/search-system.md

Demonstrates the basic structure of a GET request to the search system. Parameters can be appended to the base URL.

```http
GET [base]?param1=value&...
```

--------------------------------

### Query Plan Format Example 2

Source: https://github.com/samply/blaze/blob/main/docs/api/interaction/search-type.md

This query plan shows that the `code` parameter is chosen for index scanning due to its smaller index segment, while `status` is used for seeking.

```text
SCANS: code(ordered); SEEKS: status
```

--------------------------------

### Start Blaze FHIR Server with Docker

Source: https://context7.com/samply/blaze/llms.txt

Run a standalone Blaze server using Docker. Verify its status with a health check and retrieve the capability statement.

```bash
docker run -d --name blaze -p 8080:8080 samply/blaze:latest

# Verify it's running
curl http://localhost:8080/health

# Get capability statement
curl -H 'Accept: application/fhir+json' http://localhost:8080/fhir/metadata
```

--------------------------------

### Retrieve System History

Source: https://github.com/samply/blaze/blob/main/docs/api/interaction/history-system.md

Use this endpoint to get the history of all resources in the system. The response is a Bundle containing resource versions, sorted by newest first. Paging is supported.

```http
GET [base]/_history
```

--------------------------------

### Docker Compose Configuration for Blaze

Source: https://github.com/samply/blaze/blob/main/docs/deployment/standalone-backend.md

Example Docker Compose configuration for deploying Blaze. It includes image details, environment variables, port mappings, volume mounts, and a health check.

```yaml
services:
  blaze:
    image: "samply/blaze:{{ tag }}@{{ digest }}"
    environment:
      JAVA_TOOL_OPTIONS: "-Xmx2g"
    ports:
    - "8080:8080"
    volumes:
    - "blaze-data:/app/data"
    healthcheck:
      test: [ "CMD", "wget", "--spider", "http://localhost:8080/health" ]
      interval: 10s
      timeout: 5s
      retries: 5
      start_period: 30s
volumes:
  blaze-data:
```

--------------------------------

### Import FHIR Bundles with blazectl

Source: https://context7.com/samply/blaze/llms.txt

Import FHIR bundles from a directory using the `blazectl` command-line tool. Supports parallel uploads and authentication. Ensure blazectl is installed from https://github.com/samply/blazectl.

```bash
# Install blazectl (https://github.com/samply/blazectl)

# Count current resources
blazectl --server http://localhost:8080/fhir count-resources

# Upload directory of FHIR bundles
blazectl --server http://localhost:8080/fhir upload ./fhir-data/
```

```bash
# Upload with authentication
blazectl -k \
  --server https://blaze.example.com/fhir \
  --token "$(curl -s -X POST https://keycloak.example.com/realms/blaze/protocol/openid-connect/token \
    -d 'grant_type=client_credentials&client_id=myapp&client_secret=secret' \
    | jq -r '.access_token')" \
  upload ./synthea-output/
```

```bash
# Download all Patients
blazectl --server http://localhost:8080/fhir download Patient -o patients.ndjson
```

```bash
# Download Conditions with linked Patients
blazectl --server http://localhost:8080/fhir download Condition \
  -q '_include=Condition:subject&_count=1000' \
  -o conditions-with-patients.ndjson
```

--------------------------------

### Execute CQL Search with blazectl

Source: https://github.com/samply/blaze/blob/main/docs/performance/cql/code-date-age-search.md

These commands demonstrate how to execute the compiled CQL queries using the blazectl tool. The first command runs the hemoglobin search, and the second shows an example for a calcium search.

```sh
cql/search.sh hemoglobin-date-age
```

```sh
cql/search.sh calcium-date-age
```

--------------------------------

### Run Frontend in Dev Mode

Source: https://github.com/samply/blaze/blob/main/modules/frontend/README.md

Launch the frontend development server using NPM.

```sh
npm run dev
```

--------------------------------

### FHIR Search URL Example

Source: https://github.com/samply/blaze/blob/main/docs/implementation/api.md

This is an example of a FHIR search URL used for querying observations across multiple patients with a specific code.

```text
[base]/Observation?patient=Patient/1,Patient/2&code=http://loinc.org|26464-8
```

--------------------------------

### Prepare Production Environment for E2E Tests

Source: https://github.com/samply/blaze/blob/main/modules/frontend-e2e/README.md

Run these commands in the root project directory to clean, build, and prepare the job.

```sh
make clean
make build-job-ig
make build-all
```

--------------------------------

### Basic Search

Source: https://github.com/samply/blaze/blob/main/docs/api/interaction/search-type.md

Perform a basic search using GET or POST. The GET method allows for query parameters, while the POST method uses a request body for searching.

```APIDOC
## Basic Search

### Description
Perform a basic search using either the GET or POST method. The GET method appends search parameters to the URL, while the POST method utilizes a request body for search criteria.

### Method
GET, POST

### Endpoint
`GET [base]/[type]?param1=value&...`
`POST [base]/[type]/_search`
```

--------------------------------

### Run Blaze with Docker

Source: https://github.com/samply/blaze/blob/main/docs/deployment.md

Use this command to start a Blaze instance in detached mode. Ensure the port 8080 is available.

```sh-vue
docker run -d --name blaze -p 8080:8080 samply/blaze:{{ tag }}@{{ digest }}
```

--------------------------------

### Fetch Access Token and Request Resources

Source: https://github.com/samply/blaze/blob/main/docs/authentication.md

This command sequence first fetches an access token using the provided script and then uses it to request all resources from Blaze. It demonstrates a successful authenticated request.

```sh
ACCESS_TOKEN=$(./fetch-token.sh) ./request-all-resources.sh
```

--------------------------------

### Search Using Custom Parameter

Source: https://context7.com/samply/blaze/llms.txt

Example curl command to search for patients using a custom search parameter after re-indexing.

```bash
# After deploying, trigger re-index via Admin UI or API
# Then search using the new parameter
curl "http://localhost:8080/fhir/Patient?marital-status=http://terminology.hl7.org/CodeSystem/v3-MaritalStatus|M"

```

--------------------------------

### Querying FHIR Resources

Source: https://context7.com/samply/blaze/llms.txt

Examples of how to query FHIR resources with various parameters like elements, sorting, and profile filtering.

```APIDOC
## GET /fhir/Patient

### Description
Retrieves a list of Patient resources with specified elements and count.

### Method
GET

### Endpoint
http://localhost:8080/fhir/Patient?_elements=id,gender,birthDate&_count=10

### Parameters
#### Query Parameters
- **_elements** (string) - Optional - Comma-separated list of elements to include.
- **_count** (integer) - Optional - Maximum number of resources to return.
```

```APIDOC
## GET /fhir/Patient

### Description
Retrieves a list of Patient resources sorted by last update.

### Method
GET

### Endpoint
http://localhost:8080/fhir/Patient?_sort=-_lastUpdated&_count=20

### Parameters
#### Query Parameters
- **_sort** (string) - Optional - Field to sort by. Prefix with '-' for descending order.
- **_count** (integer) - Optional - Maximum number of resources to return.
```

```APIDOC
## GET /fhir/Patient

### Description
Retrieves Patient resources filtered by a specific profile.

### Method
GET

### Endpoint
http://localhost:8080/fhir/Patient?_profile:below=http://example.com/StructureDefinition/MyPatient|1.2

### Parameters
#### Query Parameters
- **_profile:below** (string) - Optional - Filter by profile definition and version.
```

```APIDOC
## GET /fhir/Observation

### Description
Retrieves Observation resources and explains the query execution plan.

### Method
GET

### Endpoint
http://localhost:8080/fhir/Observation?status=final&date=2025&__explain=true

### Parameters
#### Query Parameters
- **status** (string) - Optional - Filter by observation status.
- **date** (string) - Optional - Filter by observation date.
- **__explain** (boolean) - Optional - Request query execution plan explanation.
```

--------------------------------

### Release Branch Naming Convention

Source: https://github.com/samply/blaze/blob/main/DEVELOPMENT.md

When creating a release branch, follow the naming convention 'release-v<version>', for example, 'release-v0.29.0'.

```text
release-v<version>
```

--------------------------------

### Run All Tests

Source: https://github.com/samply/blaze/blob/main/AGENTS.md

Execute all tests in the project. Use this when changes span multiple modules or the root directory.

```bash
make test
```

--------------------------------

### Format Code with Make

Source: https://github.com/samply/blaze/blob/main/AGENTS.md

Runs the code formatting tool. Ensure your code adheres to the project's formatting standards before committing.

```bash
make fmt
```

--------------------------------

### Run Blaze Docker Container

Source: https://github.com/samply/blaze/blob/main/docs/cql-queries/command-line.md

Start the Blaze FHIR server using Docker. Mount a volume for persistent data storage.

```sh
docker run -p 8080:8080 -v blaze-data:/app/data samply/blaze:{{ tag }}@{{ digest }}
```

--------------------------------

### Terminology — ValueSet $validate-code

Source: https://context7.com/samply/blaze/llms.txt

Validate whether a code, coding, or CodeableConcept is a member of a ValueSet. Can be performed via GET or POST.

```APIDOC
## Terminology — ValueSet $validate-code

Validate whether a code/coding/CodeableConcept is a member of a ValueSet.

### Validate a code (GET)
```bash
curl "http://localhost:8080/fhir/ValueSet/$validate-code?url=http://hl7.org/fhir/ValueSet/administrative-gender&system=http://hl7.org/fhir/administrative-gender&code=male"
```

### Validate a coding via POST
```bash
curl -s -X POST \
  -H "Content-Type: application/fhir+json" \
  -d 
  '{
    "resourceType": "Parameters",
    "parameter": [
      {"name": "url", "valueUri": "http://hl7.org/fhir/ValueSet/administrative-gender"},
      {"name": "coding", "valueCoding": {
        "system": "http://hl7.org/fhir/administrative-gender",
        "code": "male",
        "display": "Male"
      }}
    ]
  }' \
  "http://localhost:8080/fhir/ValueSet/$validate-code"
```

### Expected
```json
{
  "resourceType": "Parameters",
  "parameter": [
    {"name": "result", "valueBoolean": true},
    {"name": "display", "valueString": "Male"}
  ]
}
```
```

--------------------------------

### Build Synthea Docker Image

Source: https://github.com/samply/blaze/blob/main/docs/performance/synthea/README.md

Build the Synthea Docker image using the provided Dockerfile. This image is used to run the Synthea generator.

```sh
docker build . -t synthea
```

--------------------------------

### Search System Endpoint

Source: https://github.com/samply/blaze/blob/main/docs/api/interaction/search-system.md

This snippet shows the basic structure of a GET request to the Search System API, including placeholder parameters.

```APIDOC
## GET /search

### Description
Allows users to search the system by providing query parameters.

### Method
GET

### Endpoint
`/search`

### Parameters
#### Query Parameters
- **_summary** (string) - Optional - Supported values are `true`, `count`, and `false`.

### Request Example
```
GET /search?_summary=true&param1=value
```

### Response
#### Success Response (200)
- **results** (array) - The search results.
- **total** (integer) - The total number of results.

#### Response Example
```json
{
  "results": [
    {
      "id": "123",
      "name": "Example Item"
    }
  ],
  "total": 100
}
```
```

--------------------------------

### Blaze Node Configuration for Distributed Storage

Source: https://context7.com/samply/blaze/llms.txt

Excerpt from docker-compose.yml showing environment variables and volumes for a Blaze node in a distributed setup.

```yaml
# docker-compose.yml excerpt for each Blaze node
blaze-1:
  image: "samply/blaze:1.7.0"
  environment:
    JAVA_TOOL_OPTIONS: "-Xmx16g"
    STORAGE: "distributed"
    DB_KAFKA_BOOTSTRAP_SERVERS: "kafka-1:9092,kafka-2:9092,kafka-3:9092"
    DB_KAFKA_MAX_REQUEST_SIZE: "10485760"
    DB_KAFKA_COMPRESSION_TYPE: "zstd"
    DB_CASSANDRA_CONTACT_POINTS: "cassandra-1:9042,cassandra-2:9042,cassandra-3:9042"
    DB_CASSANDRA_KEY_SPACE: "blaze"
    DB_CASSANDRA_PUT_CONSISTENCY_LEVEL: "TWO"
    DB_CASSANDRA_REQUEST_TIMEOUT: "60000"
    ENABLE_ADMIN_API: "true"
  volumes:
    - "blaze-1-data:/app/data"

```

--------------------------------

### Build Frontend Docker Image

Source: https://github.com/samply/blaze/blob/main/DEVELOPMENT.md

Build the Docker image for the Blaze frontend using the make build-frontend command.

```shell
make build-frontend
```

--------------------------------

### Create Feature Branch

Source: https://github.com/samply/blaze/blob/main/AGENTS.md

Creates a new feature branch for an issue and checks it out. This command streamlines the process of starting work on a new task.

```bash
gh issue develop <issue-number> --checkout
```

--------------------------------

### Create Interaction

Source: https://github.com/samply/blaze/blob/main/docs/api.md

Creates a new resource instance.

```APIDOC
## POST [base]/[type]

### Description
Creates a new resource instance.

### Method
POST

### Endpoint
[base]/[type]

### Request Body
- **resource** (Resource) - Required - The resource to create.
```

--------------------------------

### MeasureReport with Subject List Type

Source: https://github.com/samply/blaze/blob/main/docs/cql-queries/api.md

Example of a MeasureReport generated with 'type' as 'subject-list'. The 'subjectResults.reference' points to a List resource containing patient references.

```json
{
  "resourceType": "MeasureReport",
  "id": "C6QKSKQ2YWQIY4A2",
  "meta": {
    "versionId": "913",
    "lastUpdated": "2021-06-14T12:50:19.711Z"
  },
  "status": "complete",
  "type": "subject-list",
  "measure": "urn:uuid:49f4c7de-3320-4208-8e60-ecc0d8824e08",
  "date": "2021-06-14T12:50:19.431239Z",
  "period": {
    "start": "2000",
    "end": "2030"
  },
  "group": [
    {
      "population": [
        {
          "code": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/measure-population",
                "code": "initial-population"
              }
            ],
            "count": 57,
            "subjectResults": {
              "reference": "List/C6QKSKQ2V7DAF3X6"
            }
          }
        }
      ]
    }
  ]
}
```

--------------------------------

### Validate Code Against ValueSet

Source: https://context7.com/samply/blaze/llms.txt

Validates if a given code, coding, or CodeableConcept is a member of a specified ValueSet. Can be performed via GET or POST requests.

```bash
# Validate a code
curl "http://localhost:8080/fhir/ValueSet/
$validate-code?url=http://hl7.org/fhir/ValueSet/administrative-gender&system=http://hl7.org/fhir/administrative-gender&code=male"

# Validate a coding via POST
curl -s -X POST \
  -H "Content-Type: application/fhir+json" \
  -d '{
    "resourceType": "Parameters",
    "parameter": [{
      "name": "url", 
      "valueUri": "http://hl7.org/fhir/ValueSet/administrative-gender"
    },{
      "name": "coding", 
      "valueCoding": {
        "system": "http://hl7.org/fhir/administrative-gender",
        "code": "male",
        "display": "Male"
      }
    }]
  }' \
  "http://localhost:8080/fhir/ValueSet/
$validate-code"
```

```json
# Expected
{
  "resourceType": "Parameters",
  "parameter": [
    {"name": "result", "valueBoolean": true},
    {"name": "display", "valueString": "Male"}
  ]
}
```

--------------------------------

### Create Kafka Topic for Distributed Storage

Source: https://context7.com/samply/blaze/llms.txt

Command to create a Kafka topic with specific configurations required for Blaze's distributed storage.

```bash
# Create Kafka topic (must use LogAppendTime)
kafka-topics.sh --bootstrap-server kafka:9092 \
  --create --topic blaze-tx-main \
  --partitions 1 --replication-factor 3 \
  --config message.timestamp.type=LogAppendTime \
  --config retention.ms=-1
```

--------------------------------

### Explain FHIR Query Execution Plan

Source: https://context7.com/samply/blaze/llms.txt

Use the `__explain=true` parameter to get insights into how a FHIR query will be executed. Available since v1.1.0.

```bash
curl "http://localhost:8080/fhir/Observation?status=final&date=2025&__explain=true"
```

--------------------------------

### Cassandra Data Initialization Service

Source: https://github.com/samply/blaze/blob/main/docs/deployment/distributed-backend.md

Configures a service to initialize Cassandra keyspaces and tables using a provided CQL script. It depends on Cassandra nodes being healthy and ready.

```yaml
cassandra-init-data:
  image: "cassandra:4.1.4"
  command: "cqlsh -f /scripts/cassandra-init.cql"
  environment:
    CQLSH_HOST: "cassandra-1"
  volumes:
  - "./cassandra-init.cql:/scripts/cassandra-init.cql:ro"
  depends_on:
    cassandra-1:
      condition: service_healthy
    cassandra-2:
      condition: service_healthy

```

--------------------------------

### OpenID Connect Backend Configuration

Source: https://context7.com/samply/blaze/llms.txt

Environment variables for configuring Blaze backend to use OpenID Connect for authentication.

```bash
# Backend configuration
# OPENID_PROVIDER_URL=https://keycloak.example.com/realms/blaze
# OPENID_PROVIDER_ISSUER=https://keycloak.example.com/realms/blaze
# OPENID_AUDIENCE=blaze-api

```

--------------------------------

### List Data Directories

Source: https://github.com/samply/blaze/blob/main/docs/database/migration.md

Navigate to the data directory and list its contents to identify the index store and other data directories.

```sh
cd /app/data
ls
```