Cadasto

Cadasto Episode API

CRUD on episodes within an EHR and status changes (activate/deactivate). Episodes group medical data around a clinical problem or episode of care across time and encounters.

GitHub OpenAPI

Operations 7

GET /extra/v1/ehr/{ehrUid}/episode List episodes #
POST /extra/v1/ehr/{ehrUid}/episode Create episode #
GET /extra/v1/ehr/{ehrUid}/episode/{uid} Get episode #
PUT /extra/v1/ehr/{ehrUid}/episode/{uid} Update episode #
DELETE /extra/v1/ehr/{ehrUid}/episode/{uid} Delete episode #
PUT /extra/v1/ehr/{ehrUid}/episode/{uid}/activate Activate episode #
PUT /extra/v1/ehr/{ehrUid}/episode/{uid}/deactivate Deactivate episode #

Documentation

📖
Documentation
https://docs.cadasto.io/docs/overview
📖
APIReference
https://docs.cadasto.io/ehr-api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/cadasto/refs/heads/main/authentication/cadasto-authentication.yml
📖
APIReference
https://docs.cadasto.io/query-api
📖
Documentation
https://docs.cadasto.io/docs/guides/aql-archetype-query-language
📖
APIReference
https://docs.cadasto.io/definition-api
📖
APIReference
https://docs.cadasto.io/demographic-api
📖
APIReference
https://docs.cadasto.io/admin-api
📖
APIReference
https://docs.cadasto.io/system-api
📖
APIReference
https://docs.cadasto.io/extra-api
📖
APIReference
https://docs.cadasto.io/smart-on-openehr

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cadasto/refs/heads/main/openapi/cadasto-episode-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/cadasto/refs/heads/main/data-model/cadasto-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/cadasto/refs/heads/main/errors/cadasto-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/cadasto/refs/heads/main/conventions/cadasto-conventions.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cadasto-episode-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cadasto-episode-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cadasto Additional Episode API
  version: 1.0.0
  description: 'Additional API on top of the openEHR REST API, specific to Cadasto.

    The endpoints in this specification are Cadasto-specific and are intended

    to make it easier for app builders to interact with openEHR (e.g. datamaps).

    This API only works within Cadasto.'
servers:
- url: https://api.customer.cadasto.io
security:
- bearerAuth: []
tags:
- name: Episode
  description: 'CRUD on episodes within an EHR and status changes (activate/deactivate).

    Episodes group medical data around a clinical problem or episode of care

    across time and encounters.'
paths:
  /extra/v1/ehr/{ehrUid}/episode:
    parameters:
    - $ref: '#/components/parameters/ehrUidPath'
    get:
      tags:
      - Episode
      summary: List episodes
      description: Returns episodes that group medical data for the given EHR.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
              examples:
                default:
                  value:
                  - uid: <redacted>
                    episodeId: E0100016
                    active: true
                    startsAt: '2025-12-04T15:46:53+01:00'
                  - uid: <redacted>
                    episodeId: E0126870
                    active: true
                    startsAt: '2025-12-04T15:46:53+01:00'
      operationId: getExtraV1EhrByEhrUidEpisode
      x-operation-id-source: derived
    post:
      tags:
      - Episode
      summary: Create episode
      description: 'Creates a new episode to group related medical data.

        `urgency` allowed values: `at0012` (Crisis), `at0013` (Spoed), `at0014` (Regulier).

        `careCircuit` is a coded value from terminology subset `care_circuit`.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              default:
                value:
                  name: Episode name
                  active: true
                  urgency: at0012
                  careCircuit: '5'
                  startsAt: '2025-12-04T15:46:53+01:00'
                  endsAt: '2025-12-10T11:30:00+01:00'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
              examples:
                default:
                  value:
                    uid: <redacted>
                    episodeId: E0126870
                    active: true
                    startsAt: '2025-12-04T15:46:53+01:00'
        '400':
          description: Bad request
        '404':
          description: Not found
      operationId: postExtraV1EhrByEhrUidEpisode
      x-operation-id-source: derived
  /extra/v1/ehr/{ehrUid}/episode/{uid}:
    parameters:
    - $ref: '#/components/parameters/ehrUidPath'
    - $ref: '#/components/parameters/uid'
    get:
      tags:
      - Episode
      summary: Get episode
      description: Retrieves a single episode, which groups related medical data.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              examples:
                default:
                  value:
                    uid: <redacted>
                    episodeId: E0100016
                    active: true
                    startsAt: '2025-12-04T15:46:53+01:00'
        '404':
          description: Not found
      operationId: getExtraV1EhrByEhrUidEpisodeByUid
      x-operation-id-source: derived
    put:
      tags:
      - Episode
      summary: Update episode
      description: 'Updates an episode that groups related medical data.

        `urgency` allowed values: `at0012` (Crisis), `at0013` (Spoed), `at0014` (Regulier).

        `careCircuit` is a coded value from terminology subset `care_circuit`.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              default:
                value:
                  name: Updated episode name
                  active: false
                  urgency: at0012
                  careCircuit: '5'
                  startsAt: '2025-12-04T15:46:53+01:00'
                  endsAt: '2025-12-12T12:00:00+01:00'
      responses:
        '200':
          description: OK
        '400':
          description: Bad request
        '404':
          description: Not found
      operationId: putExtraV1EhrByEhrUidEpisodeByUid
      x-operation-id-source: derived
    delete:
      tags:
      - Episode
      summary: Delete episode
      description: Deletes an episode by UID.
      responses:
        '200':
          description: Deleted
        '404':
          description: Not found
      operationId: deleteExtraV1EhrByEhrUidEpisodeByUid
      x-operation-id-source: derived
  /extra/v1/ehr/{ehrUid}/episode/{uid}/activate:
    parameters:
    - $ref: '#/components/parameters/ehrUidPath'
    - $ref: '#/components/parameters/uid'
    put:
      tags:
      - Episode
      summary: Activate episode
      description: Sets the episode status to active.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              examples:
                default:
                  value: {}
        '404':
          description: Not found
      operationId: putExtraV1EhrByEhrUidEpisodeByUidActivate
      x-operation-id-source: derived
  /extra/v1/ehr/{ehrUid}/episode/{uid}/deactivate:
    parameters:
    - $ref: '#/components/parameters/ehrUidPath'
    - $ref: '#/components/parameters/uid'
    put:
      tags:
      - Episode
      summary: Deactivate episode
      description: Sets the episode status to inactive.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              examples:
                default:
                  value: {}
        '404':
          description: Not found
      operationId: putExtraV1EhrByEhrUidEpisodeByUidDeactivate
      x-operation-id-source: derived
components:
  parameters:
    uid:
      name: uid
      in: path
      required: true
      schema:
        type: string
    ehrUidPath:
      name: ehrUid
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-ext-urls: {}