openapi: 3.2.0
info:
title: Cadasto Additional Datamap Definition 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: Datamap Definition
description: 'Management of datamap definitions (XML). Defines what data is available
and how it can be mapped/queried for Cadasto-specific integrations.'
paths:
/extra/v1/definition/datamap:
get:
tags:
- Datamap Definition
summary: List datamap definitions
description: Returns a list of available datamap definitions.
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: string
examples:
default:
value:
- admission_cancelled
- admission_details
- Rapportage
- T0004Dagboek
- Verpleegkundige_Anamnese
- vital_signs
operationId: getExtraV1DefinitionDatamap
x-operation-id-source: derived
/extra/v1/definition/datamap/{datamapName}:
parameters:
- $ref: '#/components/parameters/datamapName'
get:
tags:
- Datamap Definition
summary: Get datamap definition
description: Retrieves the datamap definition (XML) for the given name.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
default:
value:
value: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n"
category: API
name: proactieve_zorgplanning
type: datamap
layer: 1
owner_uid:
timestamp: '2026-02-10 08:40:51'
uid:
comment: ''
'404':
description: Not found
operationId: getExtraV1DefinitionDatamapByDatamapName
x-operation-id-source: derived
put:
tags:
- Datamap Definition
summary: Create or update datamap definition
description: Creates or updates a datamap definition (XML body).
requestBody:
required: true
content:
application/xml:
schema:
type: string
responses:
'200':
description: OK
'400':
description: Bad request
'404':
description: Not found
operationId: putExtraV1DefinitionDatamapByDatamapName
x-operation-id-source: derived
delete:
tags:
- Datamap Definition
summary: Delete datamap definition
description: Deletes the datamap definition with the given name.
responses:
'200':
description: Deleted
'400':
description: Bad request
'404':
description: Not found
operationId: deleteExtraV1DefinitionDatamapByDatamapName
x-operation-id-source: derived
head:
tags:
- Datamap Definition
summary: Check datamap definition exists
description: Checks whether a datamap definition exists.
responses:
'200':
description: Exists
'404':
description: Not found
operationId: headExtraV1DefinitionDatamapByDatamapName
x-operation-id-source: derived
/extra/v1/definition/datamap/{datamapName}/schema:
get:
tags:
- Datamap Definition
summary: Get datamap JSON schema
description: Retrieves the JSON Schema that belongs to the datamap.
parameters:
- $ref: '#/components/parameters/datamapName'
responses:
'200':
description: OK
content:
application/schema+json:
schema:
type: object
examples:
default:
value:
id: Rapportage::datamap::daf4749d-6593-3584-a9e5-778dfe642e67
title: T0016 Rapportage.v1
type: object
properties:
Datum en Tijd:
type: string
rmType: DV_DATE_TIME
dependencies: []
required: true
format: date_time
href: /context/start_time
title: Context start time
Zorgverlener:
type: string
rmType: PARTY_IDENTIFIED/name
dependencies: []
required: false
href: /content/provider/name
title: Rapportage
description: Rapportage Composition
Zorgverlener_uid:
type: unknown
rmType: EVALUATION//provider/external_ref/id/value
dependencies: []
required: true
_exception: Class [OBJECT_ID] not instantiable.
href: /content/provider/external_ref/id/value
title: Rapportage
description: Rapportage Composition
Type Contact:
type: object
rmType: DV_CODED_TEXT
dependencies: []
required: false
oneOf:
- code: at0021
value: Face to face
- code: at0022
value: Ear to ear
- code: at0023
value: Bit to Bit
- code: at0024
value: Geen
minItems: 0
maxItems: 1
href: /context/other_context[at0001]/items[at0020]/value
title: Type contact
description: Type contact
Rapportage:
type: string
rmType: DV_TEXT/value
dependencies: []
required: true
href: /content/data[at0001]/items[at0002]/value/value
title: Unknown
additionalProperties: false
'404':
description: Not found
operationId: getExtraV1DefinitionDatamapByDatamapNameSchema
x-operation-id-source: derived
components:
parameters:
datamapName:
name: datamapName
in: path
required: true
schema:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
x-ext-urls: {}