The openEHR ITS-REST EHR API as implemented and published by Cadasto: create and read EHRs, read and update EHR_STATUS, commit/retrieve/update/logically-delete versioned COMPOSITIONs, manage the DIRECTORY (folder) structure, create and read CONTRIBUTIONs for atomic multi-object commits, and read/write ITEM_TAGs. 33 operations. Updates use RFC 7232 If-Match optimistic concurrency; deletes are logical and preserve version history for audit.
This API exposes
33 operations
across 23 paths,
organized into 6 resource areas,
and defines 108 schemas.
It is described by OpenAPI 3.1.1, at version latest.
Requests are made against a single base URL, https://{baseUrl}/openehr/v1.
33 operations23 paths108 schemas4 DELETE19 GET4 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Across 23 paths, the API surfaces 33 operations — 4 DELETE, 19 GET, 4 POST, 6 PUT. They span 6 resource areas: EHR, EHR_STATUS, COMPOSITION, DIRECTORY, CONTRIBUTION, ITEM_TAG. Each is listed below with its method, path, parameters, and response codes.
EHR 4
Management of [EHRs](https://specifications.openehr.org/releases/RM/latest/ehr.htmlehrclass). Actions upon resources of this group are also formally described in the [IEHRSERVICE]…
POST
/ehr
Create EHR
ehr_create2 paramsbody→ 201400409422
GET
/ehr
Get EHR by subject id
ehr_get_by_subject2 params→ 200404
PUT
/ehr/{ehr_id}
Create EHR with id
ehr_create_with_id3 paramsbody→ 201400409422
GET
/ehr/{ehr_id}
Get EHR by id
ehr_get_by_id2 params→ 200404
EHR_STATUS 7
Management of [EHRSTATUS](https://specifications.openehr.org/releases/RM/latest/ehr.htmlehrstatusclass) and [VERSIONEDEHRSTATUS](https://specifications.openehr.org/releases/RM/lat…
Management of [COMPOSITION](https://specifications.openehr.org/releases/RM/latest/ehr.htmlcompositionclass) and [VERSIONEDCOMPOSITION](https://specifications.openehr.org/releases/…
Management of the [directory](https://specifications.openehr.org/releases/RM/latest/ehr.htmldirectory) [FOLDER](https://specifications.openehr.org/releases/RM/latest/common.htmlfo…
POST
/ehr/{ehr_id}/directory
Create directory
directory_create→ 501
PUT
/ehr/{ehr_id}/directory
Update directory
directory_update3 paramsbody→ 200204400404412
DELETE
/ehr/{ehr_id}/directory
Delete directory
directory_delete→ 501
GET
/ehr/{ehr_id}/directory
Get folder in directory version at time
directory_get_at_time3 params→ 200204404
GET
/ehr/{ehr_id}/directory/{version_uid}
Get folder in directory version
directory_get_by_version_id3 params→ 200404
CONTRIBUTION 2
Management of [CONTRIBUTION](https://specifications.openehr.org/releases/RM/latest/common.htmlcontributionclass) resource. Actions upon resources of this group are also formally d…
POST
/ehr/{ehr_id}/contribution
Create CONTRIBUTION
contribution_create2 paramsbody→ 201400404409
GET
/ehr/{ehr_id}/contribution/{contribution_uid}
Get CONTRIBUTION by id
contribution_get2 params→ 200404
ITEM_TAG 7
Management of [ITEMTAG](https://specifications.openehr.org/releases/RM/latest/common.htmlitemtagclass) resources for compositions and EHRSTATUS within an EHR. Tags can also be set…
The contract defines 108 schemas that model the data the API accepts and returns. The most detailed are UMAction (19 properties), UMInstruction (19 properties), UMObservation (17 properties), UMEvaluation (16 properties). Each schema is shown below with its type and property counts.
UAbstractItemStructure
object
UAbstractContentItem
object
HierObjectId
object
2 properties1 required
ArchetypeId
object
2 properties1 required
UMArchetypeId
object
2 properties2 required
TemplateId
object
2 properties1 required
UMTemplateId
object
2 properties2 required
TerminologyId
object
2 properties1 required
UMTerminologyId
object
2 properties2 required
UMGenericId
object
3 properties3 required
UMHierObjectId
object
2 properties2 required
ObjectVersionId
object
2 properties1 required
UMObjectVersionId
object
2 properties2 required
UObjectId
ObjectRef
object
3 properties3 required
CodePhrase
object
3 properties2 required
DvInterval
object
5 properties4 required
UMDvUri
object
2 properties2 required
DvEhrUri
object
2 properties1 required
UMDvEhrUri
object
2 properties2 required
UDvUri
DvCodedText
object
8 properties2 required
TermMapping
object
3 properties2 required
UMDvText
object
7 properties2 required
UMDvCodedText
object
8 properties3 required
UDvText
ReferenceRange
object
2 properties2 required
DvDuration
object
1 property
DvDateTime
object
2 properties1 required
Ehr
object
An EHR resource
5 properties
UUidBasedId
Link
object
3 properties3 required
Archetyped
object
3 properties2 required
DvIdentifier
object
Type for representing identifiers of real-world entities. Typical identifiers include drivers licence number, social security number, veterans affairs number,…
4 properties1 required
DvMultimedia
object
12 properties3 required
UMDvMultimedia
object
12 properties3 required
DvParsable
object
5 properties3 required
UMDvParsable
object
5 properties3 required
UDvEncapsulated
PartyRef
object
Identifier for parties in a demographic or identity service.
3 properties3 required
UMPartyIdentified
object
3 properties1 required
UMPartyRelated
object
4 properties2 required
UPartyIdentified
UMPartySelf
object
2 properties1 required
UPartyProxy
UMDvBoolean
object
2 properties2 required
UMDvCount
object
2 properties2 required
DvDate
object
2 properties1 required
UMDvDate
object
2 properties2 required
UMDvDateTime
object
2 properties2 required
UMDvDuration
object
1 property1 required
UMDvIdentifier
object
5 properties2 required
UMDvOrdinal
object
3 properties3 required
UMDvProportion
object
5 properties4 required
UMDvQuantity
object
6 properties3 required
UMDvScale
object
3 properties3 required
UMDvState
object
3 properties3 required
UMDvTime
object
2 properties2 required
UDataValue
Element
object
10 properties2 required
ItemSingle
object
8 properties3 required
ItemList
object
8 properties2 required
Clstr
object
8 properties3 required
UItem
ItemTable
object
8 properties2 required
ItemTree
object
8 properties2 required
UItemStructure
FeederAuditDetails
object
7 properties1 required
FeederAudit
object
5 properties1 required
EhrStatus
object
An EHRSTATUS resource
10 properties5 required
VersionedEhrStatus
object
A VERSIONEDEHRSTATUS resource
4 properties3 required
AuditDetails
object
The set of attributes required to document the committal of an information item to a repository.
6 properties4 required
RevisionHistoryItem
object
A REVISIONHISTORYITEM resource
2 properties2 required
RevisionHistory
object
A REVISIONHISTORY resource
1 property1 required
DvIntervalOfDateTime
object
7 properties4 required
Participation
object
4 properties2 required
EventContext
object
7 properties2 required
UMAdminEntry
object
14 properties7 required
Event
object
10 properties4 required
History
object
12 properties3 required
UMObservation
object
17 properties7 required
UMEvaluation
object
16 properties7 required
Activity
object
10 properties4 required
UMInstruction
object
19 properties7 required
IsmTransition
object
5 properties1 required
LocatableRef
object
4 properties3 required
InstructionDetails
object
4 properties2 required
UMAction
object
19 properties9 required
UContentItem
Composition
object
A COMPOSITION resource
13 properties8 required
UVersionable
Attestation
object
11 properties6 required
OriginalVersion
object
10 properties5 required
UMOriginalVersion
object
10 properties6 required
UMImportedVersion
object
6 properties5 required
UVersion
Error
object
2 properties2 required
VersionedComposition
object
A VERSIONEDCOMPOSITION resource
4 properties3 required
Folder
object
A FOLDER resource
10 properties2 required
TerminologyCode
object
4 properties2 required
UpdateAudit
object
The set of attributes required to document the committal of an information item to a repository. Used by the server to create an AUDITDETAILS object.
4 properties2 required
UpdateAttestation
object
9 properties4 required
UpdateVersion
object
6 properties3 required
NewContribution
object
A new (un-committed) CONTRIBUTION resource
3 properties2 required
Contribution
object
A CONTRIBUTION resource
3 properties3 required
UpdateItemTag
object
3 properties1 required
ItemTagOfComposition
object
5 properties3 required
ItemTagOfEhrStatus
object
5 properties3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Cadasto EHR API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.