How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Nedap

Nedap Openehr.Composition Wrapper API

The openehr.CompositionWrapper API from Nedap — 23 operation(s) for openehr.compositionwrapper.

Documentation Provider Profile APIs.io OpenAPI GitHub

Nedap Openehr.Composition Wrapper API is one of 269 APIs that Nedap publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 31 operations across 23 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 0.0.0.

Requests are made against a single base URL, https://api-development.ons.io.

31 operations 23 paths 28 schemas 4 DELETE15 GET10 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.0
Base URL
https://api.ons.io
Resource Areas
1

Paths & Operations 31

Across 23 paths, the API surfaces 31 operations — 4 DELETE, 15 GET, 10 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

openehr.CompositionWrapper 31
GET
/t/openehr/composition_wrappersdeprecated
Finds all CompositionWrappers of all clients that are an instance of the given…
openehr.CompositionWrapperAPI.all 13 params → 200400404
POST
/t/openehr/composition_wrappersdeprecated
Create CompositionWrapper
openehr.CompositionWrapperAPI.createV2 1 param body → 200400
DELETE
/t/openehr/composition_wrappersdeprecated
Deletes multiple Compositions by given id's
openehr.CompositionWrapperAPI.deleteMultiple 1 param → 204404
GET
/t/openehr/composition_wrappers/alldeprecated
Finds all CompositionWrappers of all clients that are an instance of the given…
openehr.CompositionWrapperAPI.all2 13 params → 200400404
GET
/t/openehr/composition_wrappers/{id}deprecated
Finds a compositionWrapper in the requested form
openehr.CompositionWrapperAPI.byId 2 params → 200404
PUT
/t/openehr/composition_wrappers/{id}deprecated
Updates the given CompositionWrapper
openehr.CompositionWrapperAPI.updateV2 2 params body → 200400404
DELETE
/t/openehr/composition_wrappers/{id}deprecated
Deletes the CompositionWrapper with given id
openehr.CompositionWrapperAPI.delete 1 param → 200404
GET
/t/openehr/composition_wrappers/{id}/composition_versionsdeprecated
Finds all CompositionVersionWrappers of a given composition
openehr.CompositionWrapperAPI.compositionVersions 6 params → 200400
GET
/t/openehr/composition_wrappers/{id}/incoming_linksdeprecated
Finds all reference model objects linking to given composition that are an…
openehr.CompositionWrapperAPI.incomingLinks 9 params → 200400404
POST
/t/openehr/composition_wrappers/by_item_tagsdeprecated
Returns all compositions that contain all given item tags
openehr.CompositionWrapperAPI.byItemTags 6 params body → 200400
POST
/t/openehr/composition_wrappers/evaluatedeprecated
Posts a compositionWrapper and returns the ruleEvaluation
openehr.CompositionWrapperAPI.evaluate 1 param body → 200
GET
/t/openehr/composition_wrappers/export_to_xlsxdeprecated
Returns an XLSX file with the content of all compositions within a clients ehr…
openehr.CompositionWrapperAPI.exportToXLSX 1 param → 200404
GET
/t/openehr/composition_wrappers/plan_elementsdeprecated
Lists all plan element compositions associated with the requested executor…
openehr.CompositionWrapperAPI.planElementCompositions 8 params → 200400
POST
/t/openehr/composition_wrappers/selected_valuesdeprecated
Query composition data by archetype and path
openehr.CompositionWrapperAPI.selectedValues 5 params body → 200
GET
/t/openehr/vvt_care_profiles/{careplan_id}deprecated
Finds a VVT care profile compositionWrapper in the requested form
openehr.CompositionWrapperAPI.byVvtCareProfileCareplanId 2 params → 200404
POST
/t/openehr/vvt_care_profiles/{careplan_id}/copydeprecated
Copies a VVT care profile compositionWrapper to a new careplan
openehr.CompositionWrapperAPI.copyVvtCareProfile 3 params → 200404
GET
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers
Finds all CompositionWrappers of all clients that are an instance of the given…
getV0OpenehrDossierBackChannelUnauthorizedCompositionWrappers 13 params → 200400404
POST
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers
Create CompositionWrapper
postV0OpenehrDossierBackChannelUnauthorizedCompositionWrappers 1 param body → 200400
DELETE
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers
Deletes multiple Compositions by given id's
deleteV0OpenehrDossierBackChannelUnauthorizedCompositionWrappers 1 param → 204404
GET
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/{id}
Finds a compositionWrapper in the requested form
getV0OpenehrDossierBackChannelUnauthorizedCompositionWrappersById 2 params → 200404
PUT
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/{id}
Updates the given CompositionWrapper
putV0OpenehrDossierBackChannelUnauthorizedCompositionWrappersById 2 params body → 200400404
DELETE
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/{id}
Deletes the CompositionWrapper with given id
deleteV0OpenehrDossierBackChannelUnauthorizedCompositionWrappersById 1 param → 200404
GET
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/{id}/composition_versions
Finds all CompositionVersionWrappers of a given composition
getV0OpenehrDossierBackChannelUnauthorizedCompositionWrappersByIdCompositionVersions 6 params → 200400
GET
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/{id}/incoming_links
Finds all reference model objects linking to given composition that are an…
getV0OpenehrDossierBackChannelUnauthorizedCompositionWrappersByIdIncomingLinks 9 params → 200400404
POST
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/by_item_tags
Returns all compositions that contain all given item tags
postV0OpenehrDossierBackChannelUnauthorizedCompositionWrappersByItemTags 6 params body → 200400
POST
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/evaluate
Posts a compositionWrapper and returns the ruleEvaluation
postV0OpenehrDossierBackChannelUnauthorizedCompositionWrappersEvaluate 1 param body → 200
GET
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/export_to_xlsx
Returns an XLSX file with the content of all compositions within a clients ehr…
getV0OpenehrDossierBackChannelUnauthorizedCompositionWrappersExportToXlsx 1 param → 200404
GET
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/plan_elements
Lists all plan element compositions associated with the requested executor…
getV0OpenehrDossierBackChannelUnauthorizedCompositionWrappersPlanElements 8 params → 200400
POST
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/selected_values
Query composition data by archetype and path
postV0OpenehrDossierBackChannelUnauthorizedCompositionWrappersSelectedValues 5 params body → 200
GET
/v0/openehr_dossier/back_channel/unauthorized/vvt_care_profiles/{careplan_id}
Finds a VVT care profile compositionWrapper in the requested form
getV0OpenehrDossierBackChannelUnauthorizedVvtCareProfilesByCareplanId 2 params → 200404
POST
/v0/openehr_dossier/back_channel/unauthorized/vvt_care_profiles/{careplan_id}/copy
Copies a VVT care profile compositionWrapper to a new careplan
postV0OpenehrDossierBackChannelUnauthorizedVvtCareProfilesByCareplanIdCopy 3 params → 200404

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are openehr.ReferenceModelObjectWrapper (22 properties), openehr.CompositionVersionWrapper (17 properties), openehr.CompositionValues (16 properties), openehr.EmployeeGroup (13 properties). Each schema is shown below with its type and property counts.

openehr.RuleEvaluationResult
object
OpenEHR RuleEvaluationResult model. Object to return an RuleEvaluationResult, which checks the rules of an archetype. Created on 18/06/2018.
3 properties
openehr.list.LinkedReferenceModelObjectWrapperList
object
List of wrapper openEHR LinkedReferenceModelObjects.
1 property
ErrorResponseEntry
object
Error response entry model
3 properties
openehr.ArchetypeSelection
object
Requested archetype id and the paths to get the values for, optionally limited by a start and/or end date/time.
5 properties
openehr.CompositionValuesForPath
object
Combination of requested path and its values in this composition
2 properties
openehr.CompositionValidationErrorResponse
object
Returned when a composition could not be created or updated because it failed validation. Contains one entry per validation error found. The property is named…
1 property
openehr.CompositionVersionWrapper
object
CompositionVersionWrapper model (no description)
17 properties 5 required
openehr.Instruction
object
Contains metadata of an ons-ehr-db Instruction like it's path within a composition, the aggregated state and the receivers of the Instruction.
8 properties
ErrorResponse
object
Error response model
1 property
openehr.CompositionValuesForArchetype
object
The requested archetype id and returned composition data including values for requested paths
2 properties
openehr.LifecycleState
string
The lifecycle state of a composition version.
openehr.LinkedReferenceModelObjectWrapper
object
OpenEHR Linked Reference Model Object Wrapper model. Object to return an LinkedReferenceModelObjectWrapper. This object includes additional information about l…
5 properties
openehr.EmployeeGroup
object
Employee group used for authorizations in {@link ArchetypeWrapper} and {@link CompositionWrapper}. Employee groups can be based on {@link com.nedap.healthcare.…
13 properties
openehr.CompositionWrapper
object
OpenEHR CompositionWrapper model, including relevant metadata. Object to return an CompositionWrapper, which extends from the ReferenceModelObjectWrapper See a…
2 properties
openehr.list.ItemTagList
object
List of openEHR ItemTags.
1 property
openehr.ItemTag
object
OpenEHR ItemTag, which is a tag with a key and optional value that is associated with a target ReferenceModelObjectWrapper.
4 properties 1 required
openehr.list.ArchetypeSelectionList
object
List of archetypes and paths to request the values of
1 property
openehr.ReferenceModelObjectWrapper
object
OpenEHR Reference Model Object Wrapper model. Object to return an ReferenceModelObjectWrapper. This is the superclass of every object in an EHR, such as Stored…
22 properties
AuditedBase
object
AuditedBase model (no description)
3 properties
openehr.ReferenceModelObjectForm
string
ReferenceModelObjectForm enum. METADATA: Return only the metadata. referenceModelObject and pathsAndValues will be empty. PATHSANDVALUES: Return the pathsAndVa…
openehr.list.CompositionVersionWrapperList
object
CompositionVersionWrapperList model (no description)
1 property
openehr.Receiver
object
Contains information about the receiving ons-ehr-db Person or EmployeeGroup.
6 properties
openehr.CompositionValues
object
Values of a specific Composition, including the values for the requested path
16 properties
openehr.CompositionValidationErrorEntryType
string
The kind of validation error reported by a composition validation error entry. The message of an entry is raw output of the openEHR validator and is not unders…
openehr.list.CompositionValuesForArchetypeList
object
List of the requested archetype ids and the values for the matching compositions. Will contain one entry for each of the requested archetype ids.
1 property
openehr.InstructionState
string
The aggregated state of the instruction.
openehr.list.CompositionWrapperList
object
List of wrapper openEHR Compositions.
1 property
openehr.CompositionValidationErrorEntry
object
A single validation error found while creating or updating a composition.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nedap-openehr-compositionwrapper-api-openapi.yml Raw ↑

Other APIs Nedap publishes across the network.

Nedap Retail iD Cloud API
AE Profile APIs.io
Nedap Address API
AE Profile APIs.io
Nedap Admin.Background Image API
AE Profile APIs.io
Nedap Admin.License API
AE Profile APIs.io
Nedap Admin.Logo Image API
AE Profile APIs.io
Nedap Admin.Timesheet Config API
AE Profile APIs.io
Nedap Admin.Version API
AE Profile APIs.io
Nedap Agbcode API
AE Profile APIs.io
Nedap Agenda.Agenda Occurrence API
AE Profile APIs.io
Nedap Agenda.Agenda Series API
AE Profile APIs.io
Nedap Agenda.Client Absence Occurrence API
AE Profile APIs.io
Nedap Agenda.Label API
AE Profile APIs.io
← Back to N APIs
API Details
ID
nedap:nedap-openehr-compositionwrapper-api
Base URL
https://api.ons.io
Docs
https://ons-api.nl/english/english.html
Provider
Nedap
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

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.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=nedap-openehr-compositionwrapper-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/nedap-openehr-compositionwrapper-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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 Nedap Openehr.Composition Wrapper 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.