Cadasto

Cadasto EHR STATUS API

Management of [EHR_STATUS](https://specifications.openehr.org/releases/RM/latest/ehr.html#_ehr_status_class) and [VERSIONED_EHR_STATUS](https://specifications.openehr.org/releases/RM/latest/ehr.html#_versioned_ehr_status_class) resources. Actions upon resources of this group are also formally described in the [I_EHR_STATUS](https://specifications.openehr.org/releases/SM/latest/openehr_platform.html#_i_ehr_status_interface) Abstract Service Model interface.

GitHub OpenAPI

Operations 7

GET /ehr/{ehr_id}/ehr_status/{version_uid} Get EHR_STATUS by version id #
GET /ehr/{ehr_id}/ehr_status Get EHR_STATUS at time #
PUT /ehr/{ehr_id}/ehr_status Update EHR_STATUS #
GET /ehr/{ehr_id}/versioned_ehr_status Get versioned EHR_STATUS #
GET /ehr/{ehr_id}/versioned_ehr_status/revision_history Get versioned EHR_STATUS revision history #
GET /ehr/{ehr_id}/versioned_ehr_status/version Get versioned EHR_STATUS version at time #
GET /ehr/{ehr_id}/versioned_ehr_status/version/{version_uid} Get versioned EHR_STATUS version by id #

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-ehr-status-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-ehr-status-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-ehr-status-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: EHR STATUS API
  version: latest
  x-status: STABLE
  x-spec: ehr
  description: 'Management of EHR_STATUS and VERSIONED_EHR_STATUS resources.

    Actions upon resources of this group are also formally described in the I_EHR_STATUS Abstract Service Model interface.'
servers:
- url: https://{baseUrl}/openehr/v1
  description: An example openEHR server URL.
  variables:
    baseUrl:
      default: cataniamc.prod.cadasto.com
      description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix.
security: []
tags:
- name: EHR_STATUS
  description: 'Management of EHR_STATUS and VERSIONED_EHR_STATUS resources.

    Actions upon resources of this group are also formally described in the I_EHR_STATUS Abstract Service Model interface.'
paths:
  /ehr/{ehr_id}/ehr_status/{version_uid}:
    get:
      operationId: ehr_status_get_by_version_id
      summary: Get EHR_STATUS by version id
      description: 'Retrieves a particular version of the EHR_STATUS identified by `version_uid` and associated with the EHR identified by `ehr_id`.


        Send `Prefer: include_item_tags` to also receive the `openehr-item-tag` response header with the current tags.'
      tags:
      - EHR_STATUS
      parameters:
      - $ref: '#/components/parameters/ehr_id'
      - $ref: '#/components/parameters/version_uid'
      - $ref: '#/components/parameters/Prefer'
      responses:
        '200':
          $ref: '#/components/responses/200_EHR_STATUS_retrieved'
        '404':
          $ref: '#/components/responses/404_unknown_ehr_id_or_version_uid'
  /ehr/{ehr_id}/ehr_status:
    get:
      operationId: ehr_status_get_at_time
      summary: Get EHR_STATUS at time
      description: 'Retrieves a version of the EHR_STATUS associated with the EHR identified by `ehr_id`.


        If `version_at_time` is supplied, retrieves the version extant _at specified time_, otherwise retrieves the _latest_ EHR_STATUS version.


        Send `Prefer: include_item_tags` to also receive the `openehr-item-tag` response header with the current tags.'
      tags:
      - EHR_STATUS
      parameters:
      - $ref: '#/components/parameters/ehr_id'
      - $ref: '#/components/parameters/version_at_time'
      - $ref: '#/components/parameters/Prefer'
      responses:
        '200':
          $ref: '#/components/responses/200_EHR_STATUS_retrieved'
        '400':
          $ref: '#/components/responses/400_invalid_version_at_time'
        '404':
          $ref: '#/components/responses/404_unknown_ehr_id_or_no_version_at_time'
    put:
      operationId: ehr_status_update
      summary: Update EHR_STATUS
      description: 'Updates EHR_STATUS associated with the EHR identified by `ehr_id`.


        The existing latest `version_uid` of EHR_STATUS resource (i.e. the `preceding_version_uid`) must be specified in the `If-Match` header.


        The response will contain the updated EHR_STATUS resource when the `Prefer` header has a value of `return=representation`.


        The optional `openehr-item-tag` request header replaces all ITEM_TAG resources associated with the target in the same transaction as the update.


        The optional `cadasto-person-uid` request header links the EHR to a PERSON in the

        same contribution. The link is **append-only** here: an EHR that already has a

        link cannot be re-linked via this header (`409 Conflict`). See the

        Cadasto demographic link guide.'
      tags:
      - EHR_STATUS
      parameters:
      - $ref: '#/components/parameters/ehr_id'
      - $ref: '#/components/parameters/If-Match'
      - $ref: '#/components/parameters/Prefer'
      - $ref: '#/components/parameters/openehr-item-tag'
      - $ref: '#/components/parameters/cadasto-person-uid'
      requestBody:
        description: 'The new EHR_STATUS.

          '
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EhrStatus'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/200_EHR_STATUS_updated'
        '204':
          $ref: '#/components/responses/204_EHR_STATUS'
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404_unknown_ehr_id'
        '409':
          $ref: '#/components/responses/409_EHR_STATUS_cadasto_person_uid'
        '412':
          $ref: '#/components/responses/412_EHR_STATUS'
        '422':
          $ref: '#/components/responses/422_cadasto_person_uid_unknown'
  /ehr/{ehr_id}/versioned_ehr_status:
    get:
      operationId: versioned_ehr_status_get
      summary: Get versioned EHR_STATUS
      description: Retrieves a VERSIONED_EHR_STATUS associated with an EHR identified by `ehr_id`.
      tags:
      - EHR_STATUS
      parameters:
      - $ref: '#/components/parameters/ehr_id'
      responses:
        '200':
          $ref: '#/components/responses/200_VERSIONED_EHR_STATUS'
        '404':
          $ref: '#/components/responses/404_unknown_ehr_id'
  /ehr/{ehr_id}/versioned_ehr_status/revision_history:
    get:
      operationId: versioned_ehr_status_revision_history
      summary: Get versioned EHR_STATUS revision history
      description: Retrieves revision history of the VERSIONED_EHR_STATUS associated with the EHR identified by `ehr_id`.
      tags:
      - EHR_STATUS
      parameters:
      - $ref: '#/components/parameters/ehr_id'
      responses:
        '200':
          $ref: '#/components/responses/200_REVISION_HISTORY'
        '404':
          $ref: '#/components/responses/404_unknown_ehr_id'
  /ehr/{ehr_id}/versioned_ehr_status/version:
    get:
      operationId: versioned_ehr_status_version_get_at_time
      summary: Get versioned EHR_STATUS version at time
      description: 'Retrieves a VERSION from the VERSIONED_EHR_STATUS associated with the EHR identified by `ehr_id`.


        If `version_at_time` is supplied, retrieves the VERSION extant _at specified time_, otherwise retrieves the _latest_ VERSION.


        Send `Prefer: include_item_tags` to also receive the `openehr-item-tag` response header with the current tags.'
      tags:
      - EHR_STATUS
      parameters:
      - $ref: '#/components/parameters/ehr_id'
      - $ref: '#/components/parameters/version_at_time'
      - $ref: '#/components/parameters/Prefer'
      responses:
        '200':
          $ref: '#/components/responses/200_VERSION_at_time'
        '400':
          $ref: '#/components/responses/400_invalid_version_at_time'
        '404':
          $ref: '#/components/responses/404_unknown_ehr_id_or_no_version_at_time'
  /ehr/{ehr_id}/versioned_ehr_status/version/{version_uid}:
    get:
      operationId: versioned_ehr_status_version_get_by_id
      summary: Get versioned EHR_STATUS version by id
      description: 'Retrieves a VERSION identified by `version_uid` of an EHR_STATUS associated with the EHR identified by `ehr_id`.


        Send `Prefer: include_item_tags` to also receive the `openehr-item-tag` response header with the current tags.'
      tags:
      - EHR_STATUS
      parameters:
      - $ref: '#/components/parameters/ehr_id'
      - $ref: '#/components/parameters/version_uid'
      - $ref: '#/components/parameters/Prefer'
      responses:
        '200':
          $ref: '#/components/responses/200_VERSION'
        '404':
          $ref: '#/components/responses/404_unknown_ehr_id_or_version_uid'
components:
  schemas:
    UDvUri:
      title: DV_URI
      oneOf:
      - $ref: '#/components/schemas/UMDvUri'
      - $ref: '#/components/schemas/UMDvEhrUri'
      discriminator:
        propertyName: _type
        mapping:
          DV_URI: '#/components/schemas/UMDvUri'
          DV_EHR_URI: '#/components/schemas/UMDvEhrUri'
      examples:
      - _type: DV_URI
        value: https://www.example.com
    UMDvBoolean:
      title: DV_BOOLEAN
      required:
      - value
      - _type
      type: object
      properties:
        _type:
          enum:
          - DV_BOOLEAN
          type: string
        value:
          type: boolean
      x-discriminator-value: DV_BOOLEAN
    Event:
      title: EVENT
      required:
      - name
      - archetype_node_id
      - time
      - data
      type: object
      properties:
        name:
          $ref: '#/components/schemas/UDvText'
        archetype_node_id:
          type: string
          xml:
            attribute: true
        uid:
          $ref: '#/components/schemas/UUidBasedId'
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
        archetype_details:
          $ref: '#/components/schemas/Archetyped'
        feeder_audit:
          $ref: '#/components/schemas/FeederAudit'
        _type:
          type: string
          default: EVENT
        time:
          $ref: '#/components/schemas/DvDateTime'
        state:
          $ref: '#/components/schemas/UItemStructure'
        data:
          $ref: '#/components/schemas/UItemStructure'
      x-discriminator-value: EVENT
    UPartyIdentified:
      title: PARTY_IDENTIFIED
      oneOf:
      - $ref: '#/components/schemas/UMPartyIdentified'
      discriminator:
        propertyName: _type
        mapping:
          PARTY_IDENTIFIED: '#/components/schemas/UMPartyIdentified'
          PARTY_RELATED: '#/components/schemas/UMPartyRelated'
    UVersion:
      title: VERSION
      oneOf:
      - $ref: '#/components/schemas/UMOriginalVersion'
      - $ref: '#/components/schemas/UMImportedVersion'
      discriminator:
        propertyName: _type
        mapping:
          ORIGINAL_VERSION: '#/components/schemas/UMOriginalVersion'
          IMPORTED_VERSION: '#/components/schemas/UMImportedVersion'
    UMEvaluation:
      title: EVALUATION
      required:
      - name
      - archetype_node_id
      - language
      - encoding
      - subject
      - data
      - _type
      type: object
      properties:
        name:
          $ref: '#/components/schemas/UDvText'
        archetype_node_id:
          type: string
          xml:
            attribute: true
        uid:
          $ref: '#/components/schemas/UUidBasedId'
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
        archetype_details:
          $ref: '#/components/schemas/Archetyped'
        feeder_audit:
          $ref: '#/components/schemas/FeederAudit'
        language:
          $ref: '#/components/schemas/CodePhrase'
        encoding:
          $ref: '#/components/schemas/CodePhrase'
        other_participations:
          type: array
          items:
            $ref: '#/components/schemas/Participation'
        workflow_id:
          $ref: '#/components/schemas/ObjectRef'
        subject:
          $ref: '#/components/schemas/UPartyProxy'
        provider:
          $ref: '#/components/schemas/UPartyProxy'
        protocol:
          $ref: '#/components/schemas/UItemStructure'
        guideline_id:
          $ref: '#/components/schemas/ObjectRef'
        _type:
          enum:
          - EVALUATION
          type: string
        data:
          $ref: '#/components/schemas/UItemStructure'
      x-discriminator-value: EVALUATION
    DvMultimedia:
      title: DV_MULTIMEDIA
      required:
      - _type
      - media_type
      - size
      type: object
      properties:
        _type:
          type: string
          default: DV_MULTIMEDIA
        charset:
          $ref: '#/components/schemas/CodePhrase'
        language:
          $ref: '#/components/schemas/CodePhrase'
        alternate_text:
          type: string
        uri:
          $ref: '#/components/schemas/UDvUri'
        data:
          type: string
        media_type:
          $ref: '#/components/schemas/CodePhrase'
        compression_algorithm:
          $ref: '#/components/schemas/CodePhrase'
        integrity_check:
          type: string
        integrity_check_algorithm:
          $ref: '#/components/schemas/CodePhrase'
        thumbnail:
          $ref: '#/components/schemas/DvMultimedia'
        size:
          type: integer
      x-discriminator-value: DV_MULTIMEDIA
    FeederAuditDetails:
      title: FEEDER_AUDIT_DETAILS
      required:
      - system_id
      type: object
      properties:
        system_id:
          type: string
        location:
          $ref: '#/components/schemas/UPartyIdentified'
        subject:
          $ref: '#/components/schemas/UPartyProxy'
        provider:
          $ref: '#/components/schemas/UPartyIdentified'
        time:
          $ref: '#/components/schemas/DvDateTime'
        version_id:
          type: string
        other_details:
          $ref: '#/components/schemas/UItemStructure'
    UMDvState:
      title: DV_STATE
      required:
      - value
      - is_terminal
      - _type
      type: object
      properties:
        _type:
          enum:
          - DV_STATE
          type: string
        value:
          $ref: '#/components/schemas/DvCodedText'
        is_terminal:
          type: boolean
      x-discriminator-value: DV_STATE
    UDataValue:
      title: DATA_VALUE
      oneOf:
      - $ref: '#/components/schemas/UMDvBoolean'
      - $ref: '#/components/schemas/UMDvCodedText'
      - $ref: '#/components/schemas/UMDvCount'
      - $ref: '#/components/schemas/UMDvDate'
      - $ref: '#/components/schemas/UMDvDateTime'
      - $ref: '#/components/schemas/UMDvDuration'
      - $ref: '#/components/schemas/UMDvEhrUri'
      - $ref: '#/components/schemas/UMDvIdentifier'
      - $ref: '#/components/schemas/UMDvMultimedia'
      - $ref: '#/components/schemas/UMDvOrdinal'
      - $ref: '#/components/schemas/UMDvParsable'
      - $ref: '#/components/schemas/UMDvProportion'
      - $ref: '#/components/schemas/UMDvQuantity'
      - $ref: '#/components/schemas/UMDvScale'
      - $ref: '#/components/schemas/UMDvState'
      - $ref: '#/components/schemas/UMDvText'
      - $ref: '#/components/schemas/UMDvUri'
      discriminator:
        propertyName: _type
        mapping:
          DV_BOOLEAN: '#/components/schemas/UMDvBoolean'
          DV_CODED_TEXT: '#/components/schemas/UMDvCodedText'
          DV_COUNT: '#/components/schemas/UMDvCount'
          DV_DATE: '#/components/schemas/UMDvDate'
          DV_DATE_TIME: '#/components/schemas/UMDvDateTime'
          DV_DURATION: '#/components/schemas/UMDvDuration'
          DV_EHR_URI: '#/components/schemas/UMDvEhrUri'
          DV_IDENTIFIER: '#/components/schemas/UMDvIdentifier'
          DV_MULTIMEDIA: '#/components/schemas/UMDvMultimedia'
          DV_ORDINAL: '#/components/schemas/UMDvOrdinal'
          DV_PARSABLE: '#/components/schemas/UMDvParsable'
          DV_PROPORTION: '#/components/schemas/UMDvProportion'
          DV_QUANTITY: '#/components/schemas/UMDvQuantity'
          DV_SCALE: '#/components/schemas/UMDvScale'
          DV_STATE: '#/components/schemas/UMDvState'
          DV_TEXT: '#/components/schemas/UMDvText'
          DV_TIME: '#/components/schemas/UMDvTime'
          DV_URI: '#/components/schemas/UMDvUri'
    EhrStatus:
      title: EHR_STATUS
      required:
      - name
      - archetype_node_id
      - subject
      - is_queryable
      - is_modifiable
      type: object
      properties:
        name:
          $ref: '#/components/schemas/UDvText'
        archetype_node_id:
          type: string
          xml:
            attribute: true
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
        archetype_details:
          $ref: '#/components/schemas/Archetyped'
        feeder_audit:
          $ref: '#/components/schemas/FeederAudit'
        _type:
          type: string
          default: EHR_STATUS
        subject:
          $ref: '#/components/schemas/UPartyProxy'
        is_queryable:
          type: boolean
          default: true
        is_modifiable:
          type: boolean
          default: true
        other_details:
          $ref: '#/components/schemas/UItemStructure'
      description: An EHR_STATUS resource
      x-discriminator-value: EHR_STATUS
      examples:
      - archetype_node_id: openEHR-EHR-EHR_STATUS.generic.v1
        name:
          value: EHR status
        subject:
          _type: PARTY_SELF
        is_queryable: true
        is_modifiable: true
    UMDvIdentifier:
      title: DV_IDENTIFIER
      required:
      - id
      - _type
      type: object
      properties:
        issuer:
          type: string
        assigner:
          type: string
        id:
          type: string
        type:
          type: string
        _type:
          enum:
          - DV_IDENTIFIER
          type: string
      x-discriminator-value: DV_IDENTIFIER
      examples:
      - id: 16b74749-e6aa-4945-b760-b42bdc07098a
        type: Patient
    UMAction:
      title: ACTION
      required:
      - name
      - archetype_node_id
      - language
      - encoding
      - subject
      - time
      - ism_transition
      - description
      - _type
      type: object
      properties:
        name:
          $ref: '#/components/schemas/UDvText'
        archetype_node_id:
          type: string
          xml:
            attribute: true
        uid:
          $ref: '#/components/schemas/UUidBasedId'
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
        archetype_details:
          $ref: '#/components/schemas/Archetyped'
        feeder_audit:
          $ref: '#/components/schemas/FeederAudit'
        language:
          $ref: '#/components/schemas/CodePhrase'
        encoding:
          $ref: '#/components/schemas/CodePhrase'
        other_participations:
          type: array
          items:
            $ref: '#/components/schemas/Participation'
        workflow_id:
          $ref: '#/components/schemas/ObjectRef'
        subject:
          $ref: '#/components/schemas/UPartyProxy'
        provider:
          $ref: '#/components/schemas/UPartyProxy'
        protocol:
          $ref: '#/components/schemas/UItemStructure'
        guideline_id:
          $ref: '#/components/schemas/ObjectRef'
        _type:
          enum:
          - ACTION
          type: string
        time:
          $ref: '#/components/schemas/DvDateTime'
        ism_transition:
          $ref: '#/components/schemas/IsmTransition'
        instruction_details:
          $ref: '#/components/schemas/InstructionDetails'
        description:
          $ref: '#/components/schemas/UItemStructure'
      x-discriminator-value: ACTION
    HierObjectId:
      title: HIER_OBJECT_ID
      required:
      - value
      type: object
      properties:
        _type:
          type: string
          default: UID_BASED_ID
        value:
          type: string
          format: uuid
          examples:
          - 6cb19121-4307-4648-9da0-d62e4d51f19b
      x-discriminator-value: HIER_OBJECT_ID
    OriginalVersion:
      title: ORIGINAL_VERSION
      required:
      - contribution
      - commit_audit
      - data
      - uid
      - lifecycle_state
      type: object
      properties:
        _type:
          type: string
          default: ORIGINAL_VERSION
        contribution:
          $ref: '#/components/schemas/ObjectRef'
        signature:
          type: string
        commit_audit:
          $ref: '#/components/schemas/AuditDetails'
        data:
          $ref: '#/components/schemas/UVersionable'
        uid:
          $ref: '#/components/schemas/ObjectVersionId'
        preceding_version_uid:
          $ref: '#/components/schemas/ObjectVersionId'
        other_input_version_uids:
          type: array
          items:
            $ref: '#/components/schemas/ObjectVersionId'
        lifecycle_state:
          $ref: '#/components/schemas/DvCodedText'
        attestations:
          type: array
          items:
            $ref: '#/components/schemas/Attestation'
      x-discriminator-value: ORIGINAL_VERSION
    Activity:
      title: ACTIVITY
      required:
      - name
      - archetype_node_id
      - action_archetype_id
      - description
      type: object
      properties:
        name:
          $ref: '#/components/schemas/UDvText'
        archetype_node_id:
          type: string
          xml:
            attribute: true
        uid:
          $ref: '#/components/schemas/UUidBasedId'
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
        archetype_details:
          $ref: '#/components/schemas/Archetyped'
        feeder_audit:
          $ref: '#/components/schemas/FeederAudit'
        _type:
          type: string
          default: ACTIVITY
        timing:
          $ref: '#/components/schemas/DvParsable'
        action_archetype_id:
          type: string
        description:
          $ref: '#/components/schemas/UItemStructure'
      x-discriminator-value: ACTIVITY
    UMDvDateTime:
      title: DV_DATE_TIME
      required:
      - value
      - _type
      type: object
      properties:
        _type:
          enum:
          - DV_DATE_TIME
          type: string
        value:
          type: string
          format: date-time
      x-discriminator-value: DV_DATE_TIME
      examples:
      - _type: DV_DATE_TIME
        value: '2017-08-15T10:37:15.422+02:00'
    AuditDetails:
      title: AUDIT_DETAILS
      required:
      - system_id
      - time_committed
      - change_type
      - committer
      type: object
      properties:
        _type:
          type: string
          default: AUDIT_DETAILS
        system_id:
          type: string
        time_committed:
          $ref: '#/components/schemas/DvDateTime'
        change_type:
          $ref: '#/components/schemas/DvCodedText'
        description:
          $ref: '#/components/schemas/UDvText'
        committer:
          $ref: '#/components/schemas/UPartyProxy'
      description: The set of attributes required to document the committal of an information item to a repository.
      x-discriminator-value: AUDIT_DETAILS
      examples:
      - system_id: 9624982A-9F42-41A5-9318-AE13D5F5031F
        committer:
          _type: PARTY_IDENTIFIED
          name: A user name
        time_committed:
          value: '2017-08-15T10:37:15.422+02:00'
        change_type:
          value: creation
          defining_code:
            terminology_id:
              value: openehr
            code_string: '249'
        description:
          value: Description text
    UMTerminologyId:
      title: TERMINOLOGY_ID
      required:
      - value
      - _type
      type: object
      properties:
        _type:
          enum:
          - TERMINOLOGY_ID
          type: string
        value:
          type: string
      x-discriminator-value: TERMINOLOGY_ID
    TermMapping:
      title: TERM_MAPPING
      required:
      - match
      - target
      type: object
      properties:
        match:
          pattern: /^[><=?]$/
          type: string
        purpose:
          $ref: '#/components/schemas/DvCodedText'
        target:
          $ref: '#/components/schemas/CodePhrase'
    FeederAudit:
      title: FEEDER_AUDIT
      required:
      - originating_system_audit
      type: object
      properties:
        originating_system_item_ids:
          type: array
          items:
            $ref: '#/components/schemas/DvIdentifier'
        feeder_system_item_ids:
          type: array
          items:
            $ref: '#/components/schemas/DvIdentifier'
        original_content:
          $ref: '#/components/schemas/UDvEncapsulated'
        originating_system_audit:
          $ref: '#/components/schemas/FeederAuditDetails'
        feeder_system_audit:
          $ref: '#/components/schemas/FeederAuditDetails'
    DvIntervalOfDateTime:
      title: DV_INTERVAL_of_DATE_TIME
      type: object
      properties:
        _type:
          type: string
          default: DV_INTERVAL
        lower_unbounded:
          type: boolean
        upper_unbounded:
          type: boolean
        lower_included:
          type: boolean
        upper_included:
          type: boolean
        lower:
          $ref: '#/components/schemas/UMDvDateTime'
        upper:
          $ref: '#/components/schemas/UMDvDateTime'
      x-discriminator-value: DV_INTERVAL_of_DATE_TIME
      required:
      - lower_unbounded
      - upper_unbounded
      - lower_included
      - upper_included
    ArchetypeId:
      title: ARCHETYPE_ID
      type: object
      properties:
        _type:
          type: string
          default: ARCHETYPE_ID
        value:
          type: string
      x-discriminator-value: ARCHETYPE_ID
      required:
      - value
    DvIdentifier:
      title: DV_IDENTIFIER
      required:
      - id
      type: object
      properties:
        issuer:
          type: string
        assigner:
          type: string
        id:
          type: string
        type:
          type: string
      description: 'Type for representing identifiers of real-world entities. Typical identifiers include drivers licence number, social security number, veterans affairs number, prescription id, order id, and so on.


        DV_IDENTIFIER is used to represent any identifier of a real thing, issued by some authority or agency.

        '
      x-discriminator-value: DV_IDENTIFIER
      examples:
      - id: 16b74749-e6aa-4945-b760-b42bdc07098a
        type: Patient
    UObjectId:
      title: OBJECT_ID
      oneOf:
      - $ref: '#/components/schemas/UMArchetypeId'
      - $ref: '#/components/schemas/UMTemplateId'
      - $ref: '#/components/schemas/UMTerminologyId'
      - $ref: '#/components/schemas/UMGenericId'
      - $ref: '#/components/schemas/UMHierObjectId'
      - $ref: '#/components/schemas/UMObjectVersionId'
      discriminator:
        propertyName: _type
        mapping:
          ARCHETYPE_ID: '#/components/schemas/UMArchetypeId'
          TEMPLATE_ID: '#/components/schemas/UMTemplateId'
          TERMINOLOGY_ID: '#/components/schemas/UMTerminologyId'
          GENERIC_ID: '#/components/schemas/UMGenericId'
          HIER_OBJECT_ID: '#/components/schemas/UMHierObjectId'
          OBJECT_VERSION_ID: '#/components/schemas/UMObjectVersionId'
    UVersionable:
      title: Versionable
      oneOf:
      - $ref: '#/components/schemas/Composition'
      - $ref: '#/components/schemas/EhrStatus'
      discriminator:
        propertyName: _type
        mapping:
          COMPOSITION: '#/components/schemas/Composition'
          EHR_STATUS: '#/components/schemas/EhrStatus'
    RevisionHistoryItem:
      title: REVISION_HISTORY_ITEM
      required:
      - version_id
      - audits
      type: object
      properties:
        version_id:
          $ref: '#/components/schemas/ObjectVersionId'
        audits:
          type: array
          items:
            $ref: '#/components/schemas/AuditDetails'
      description: A REVISION_HISTORY_ITEM resource
      examples:
      - version_id:
          value: 8849182c-82ad-4088-a07f-48ead4180515::cataniamc.prod.cadasto.com::1
        audits:
        - system_id: d60e2348-b083-48ce-93b9-916cef1d3a5a
          time_committed:
            value: '2015-01-20T19:30:22.765+01:00'
          change_type:
            value: creation
            defining_code:
              terminology_id:
                value: openehr
              code_string: '249'
          description:
            value: An optional description string
          committer:
            _type: PARTY_IDENTIFIED
            name: A user name
    UMArchetypeId:
      title: ARCHETYPE_ID
      required:
      - value
      - _type
      type: object
      properties:
        _type:
          enum:
          - ARCHETYPE_ID
          type: string
        value:
          type: string
      x-discriminator-value: ARCHETYPE_ID
    UUidBasedId:
      title: UID_BASED_ID
      oneOf:
      - $ref: '#/components/schemas/UMHierObjectId'
      - $ref: '#/components/schemas/UMObjectVersionId'
      discriminator:
        propertyName: _type
        mapping:
          HIER_OBJECT_ID: '#/components/schemas/UMHierObjectId'
          OBJECT_VERSION_ID: '#/components/schemas/UMObjectVersionId'
    UMDvCount:
      title: DV_COUNT
      required:
      - magnitude
      - _type
      type: object
      properties:
        _type:
          enum:
          - DV_COUNT
          type: string
        magnitude:
          type: integer
      x-discriminator-value: DV_COUNT
    History:
      title: HISTORY
      required:
      - name
      - archetype_node_id
      - origin
      type: object
      properties:
        name:
          $ref: '#/components/schemas/UDvText'
        archetype_node_id:
          type: string
          xml:
            attribute: true
        uid:
          $ref: '#/components/schemas/UUidBasedId'
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
        archetype_details:
          $ref: '#/components/schemas/Archetyped'
        feeder_audit:
          $ref: '#/components/schemas/FeederAudit'
        _type:
          type: string
          default: HISTORY
        origin:
          $ref: '#/components/schemas/DvDateTime'
        period:
          $ref: '#/components/schemas/DvDuration'
        duration:
          $ref: '#/components/schemas/DvDuration'
        summary:
          $ref: '#/components/schemas/UItemStructure'
        events:
          type: array
          items:
            $ref: '#/components/schemas/Event'
      x-discriminator-value: HISTORY
    UMDvUri:
      title: DV_URI
      required:
      - value
      - _type
      type: object
      properties:
        _type:
          enum:
          - DV_URI
          type: string
        value:
          type: string
      x-discriminator-value: DV_URI
    Archetyped:
      title: ARCHETYPED
      required:
      - archetype_id
      - rm_version
      type: object
      properties:
        archetype_id:
          $ref: '#/components/schemas/ArchetypeId'
        template_id:
          $ref: '#/components/schemas/TemplateId'
        rm_version:
          type: string
      additionalProperties: false
      examples:
      - archetype_id:
          value: openEHR-EHR-COMPOSITION.encounter.v1
        template_id:
          value: Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747
        rm_version: 1.0.2
    ObjectVersionId:
      title: OBJECT_VERSION_ID
      required:
      - value
      type: object
      properties:
        _type:
          type: string
          default: UID_BASED_ID
        value:
          type: string
          examples:
          - 6cb19121-4307-4648-9da0-d62e4d51f19b::cataniamc.prod.cadasto.com::2
      x-discriminator-value: OBJECT_VERSION_ID
    UMImportedVersion:
      title: IMPORTED_VERSION
      required:
      - contribution
      - commit_audit
      - data
      - item
      - _type
      type: object
      properties:
        _type:
          enum:
          - IMPORTED_VERSION
          type: string
        contribution:
          $ref: '#/components/schemas/ObjectRef'
        signature:
          type: string
        commit_audit:
          $ref: '#/components/schemas/AuditDetails'
        data:
          $ref: '#/components/schemas/UVersionable'
        item:
          $ref: '#/components/schemas/OriginalVersion'
      x-discriminator-value: IMPORTED_VERSION
    UMHierObjectId:
      title: HIER_OBJECT_ID
      required:
      - value
      - _type
      type: object
      properties:
        _type:
          enum:
          - HIER_OBJECT_ID
          type: string
        value:
          type: string
          format: uuid
          examples:
          - 6cb19121-4307-4648-9da0-d62e4d51f19b
      x-discriminator-value: HIER_OBJECT_ID
      examples:
      - _type: HIER_OBJECT_ID
        value: 6cb19121-4307-4648-9da0-d62e4d51f19b
    ItemTable:
      title: ITEM_TABLE
      type: object
      properties:
        name:
          $ref: '#/components/schemas/UDvText'
        archetype_node_id:
          type: string
          xml:
            attribute: true
        uid:
          $ref: '#/components/schemas/UUidBasedId'
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
        archetype_details:
          $ref: '#/components/schemas/Archetyped'
        feeder_audit:
          $ref: '#/components/schemas/FeederAudit'
        _type:
          type: string
          default: ITEM_TABLE
        items:
          type: array
          items:
            $ref: '#/components/schemas/Clstr'
      x-discriminator-value: ITEM_TABLE
      required:
      - name
      - archetype_node_id
    UMDvDuration:
      title: DV_DURATION
      required:
      - _type
      type: object
      properties:
        _type:
          enum:
      

# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cadasto/refs/heads/main/openapi/cadasto-ehr-status-api-openapi.yml