# Clinia

## Docs

- [Browse accross resource or relationship collections in the data partition](https://docs.clinia.com/api-reference/browse/browse-accross-resource-or-relationship-collections-in-the-data-partition.md): Browse across resource or relationship collections in the data partition. This endpoint only accept federated search paths, which means that when using an operator it expects the collection type and collection key to be specified in the path. For example, `resources.<collectionKey>.<propertyKey>`.
- [Browse accross resource or relationship collections in the registry](https://docs.clinia.com/api-reference/browse/browse-accross-resource-or-relationship-collections-in-the-registry.md): Browse across resource or relationship collections in the registry. This endpoint only accept federated search paths, which means that when using an operator it expects the collection type and collection key to be specified in the path. For example, `resources.<collectionKey>.<propertyKey>`.
- [Bulk create, upsert, or delete relationships](https://docs.clinia.com/api-reference/bulk/bulk-create-upsert-or-delete-relationships.md): Bulk create, upsert, or delete relationships. The request body should contain a list of operations. All operations will be processed even if some of them fail.
- [Bulk create, upsert, or delete resources](https://docs.clinia.com/api-reference/bulk/bulk-create-upsert-or-delete-resources.md): Bulk create, upsert, or delete resources. The request body should contain a list of operations. All operations will be processed even if some of them fail.
- [Get the result of a bulk relationship request](https://docs.clinia.com/api-reference/bulk/get-the-result-of-a-bulk-relationship-request.md): Get the status of a bulk relationship request. Deprecated. Use the `GetTask` endpoint instead.
- [Get the result of a bulk resource request](https://docs.clinia.com/api-reference/bulk/get-the-result-of-a-bulk-resource-request.md): Get the status of a bulk resource request. Deprecated. Use the `GetTask` endpoint instead.
- [Bundle resource and relationship operations to be processed](https://docs.clinia.com/api-reference/bundle/bundle-resource-and-relationship-operations-to-be-processed.md): Send a bundle of operations, including resource and relationship operations, to be processed atomically by the system.
- [Create a collection in the MDM](https://docs.clinia.com/api-reference/collections/create-a-collection-in-the-mdm.md): Create a collection in the MDM.
- [Execute a entity resolution preview for a given set of data (resolution properties) and identifiers](https://docs.clinia.com/api-reference/collections/execute-a-entity-resolution-preview-for-a-given-set-of-data-resolution-properties-and-identifiers.md): This endpoint allows you to preview/simulate the outcome of the entity resolution process for the given collection. It returns a list of hits/matches to unified records in the system based the resolution rule of the collection, using the provided data and identifiers. Use this endpoint to understand…
- [Get a collection in the MDM](https://docs.clinia.com/api-reference/collections/get-a-collection-in-the-mdm.md): Get the collection with given key in the MDM.
- [Get the collection profile](https://docs.clinia.com/api-reference/collections/get-the-collection-profile.md): Get the profile for the given collection key.
- [List all collections in a source](https://docs.clinia.com/api-reference/collections/list-all-collections-in-a-source.md): List all collections in a registry.
- [List collections in the MDM](https://docs.clinia.com/api-reference/collections/list-collections-in-the-mdm.md): List collections in the MDM.
- [Retrieve a unified resource from mdm collection using its id](https://docs.clinia.com/api-reference/collections/retrieve-a-unified-resource-from-mdm-collection-using-its-id.md): Retrieve a unified resource from mdm collection using its id.
- [Get ingestion workflow status](https://docs.clinia.com/api-reference/ingest/get-ingestion-workflow-status.md): Poll the status for an ingestion run.
- [Start ingestion workflow](https://docs.clinia.com/api-reference/ingest/start-ingestion-workflow.md): Ingest either an unstructured document (multipart/form-data) or a FHIR bundle (application/json).
- [Create an object](https://docs.clinia.com/api-reference/objects/create-an-object.md): Create an object.
- [Get an object file from the registry](https://docs.clinia.com/api-reference/objects/get-an-object-file-from-the-registry.md): Get a object file from the registry.
- [Get an object from the registry](https://docs.clinia.com/api-reference/objects/get-an-object-from-the-registry.md): Get a resource from the registry.
- [Create a data partition](https://docs.clinia.com/api-reference/partitions/create-a-data-partition.md): Create a data partition.
- [Get a data partition](https://docs.clinia.com/api-reference/partitions/get-a-data-partition.md): Get a data partition.
- [List the data partitions](https://docs.clinia.com/api-reference/partitions/list-the-data-partitions.md): List the data partitions.
- [Get a pipeline execution](https://docs.clinia.com/api-reference/pipeline-executions/get-a-pipeline-execution.md): Get a pipeline execution.
- [Query pipeline executions](https://docs.clinia.com/api-reference/pipeline-executions/query-pipeline-executions.md): Query the pipeline executions of a source. The fields that can be used to filter or sort pipeline executions are: - `id`: The pipeline execution id. - `pipelineDefinitionId`: The pipeline definition id. - `createdAt`: The pipeline execution creation timestamp. - `updatedAt`: The pipeline execution l…
- [Create or update a Profile in the registry](https://docs.clinia.com/api-reference/profiles/create-or-update-a-profile-in-the-registry.md): Create a profile or update an existing one. Returns 201 on create, 200 on update.
- [Get a Profile from the registry](https://docs.clinia.com/api-reference/profiles/get-a-profile-from-the-registry.md): Get a Profile from the registry.
- [List all available Profiles in the registry](https://docs.clinia.com/api-reference/profiles/list-all-available-profiles-in-the-registry.md): List all available Profiles in the registry.
- [Get the result of a purge request](https://docs.clinia.com/api-reference/purge/get-the-result-of-a-purge-request.md): Get the result of a purge request.
- [List purge operations](https://docs.clinia.com/api-reference/purge/list-purge-operations.md): List purge operations.
- [Purge operation request for resources or relationships](https://docs.clinia.com/api-reference/purge/purge-operation-request-for-resources-or-relationships.md): Purge operation request for resources or relationships.
- [Create a relationship definition in the registry](https://docs.clinia.com/api-reference/relationship-definitions/create-a-relationship-definition-in-the-registry.md): Create a relationship definition in the registry.
- [Get a relationship definition from the mdm](https://docs.clinia.com/api-reference/relationship-definitions/get-a-relationship-definition-from-the-mdm.md): Get a relationship definition from the mdm.
- [Get a relationship definition from the registry](https://docs.clinia.com/api-reference/relationship-definitions/get-a-relationship-definition-from-the-registry.md): Get a relationship definition from the registry.
- [List relationship definitions in the mdm](https://docs.clinia.com/api-reference/relationship-definitions/list-relationship-definitions-in-the-mdm.md): List relationship definitions in the mdm.
- [List relationship definitions in the registry](https://docs.clinia.com/api-reference/relationship-definitions/list-relationship-definitions-in-the-registry.md): List relationship definitions in the registry.
- [Create a relationship between two resources in the registry](https://docs.clinia.com/api-reference/relationships/create-a-relationship-between-two-resources-in-the-registry.md): Create a relationship between two resources in the registry.
- [Delete a relationship between two resources in the registry](https://docs.clinia.com/api-reference/relationships/delete-a-relationship-between-two-resources-in-the-registry.md): Delete a relationship between two resources in the registry.
- [Get a relationship from the registry](https://docs.clinia.com/api-reference/relationships/get-a-relationship-from-the-registry.md): Get a relationship from the registry.
- [Retrieve a relationship from a data partition](https://docs.clinia.com/api-reference/relationships/retrieve-a-relationship-from-a-data-partition.md): Retrieve a relationship from a data partition.
- [Update a relationship between two resources in the registry](https://docs.clinia.com/api-reference/relationships/update-a-relationship-between-two-resources-in-the-registry.md): Update a relationship between two resources in the registry. The `from` and `to` fields in the body are ignored in favor of respecting the `id` path argument.
- [Get a relative identity definition from the mdm](https://docs.clinia.com/api-reference/relativeidentity/get-a-relative-identity-definition-from-the-mdm.md): Get a relative identity definition from the mdm.
- [List relative identity collections in the MDM](https://docs.clinia.com/api-reference/relativeidentity/list-relative-identity-collections-in-the-mdm.md): List relative identity collections in the MDM.
- [Browse across a resource includes](https://docs.clinia.com/api-reference/resources/browse-across-a-resource-includes.md): Browse across a given resource's includes in the data partition.
- [Create a contained resource in registry](https://docs.clinia.com/api-reference/resources/create-a-contained-resource-in-registry.md): Create a contained resource in registry.
- [Create a resource in the registry](https://docs.clinia.com/api-reference/resources/create-a-resource-in-the-registry.md): Create a resource in the registry.
- [Delete a contained resource in the registry](https://docs.clinia.com/api-reference/resources/delete-a-contained-resource-in-the-registry.md): Delete a contained resource in the registry.
- [Delete a resource from the registry](https://docs.clinia.com/api-reference/resources/delete-a-resource-from-the-registry.md): Delete a resource from the registry.
- [Get a contain resource from the registry](https://docs.clinia.com/api-reference/resources/get-a-contain-resource-from-the-registry.md): Get a contain resource from the registry.
- [Get a resource from the registry](https://docs.clinia.com/api-reference/resources/get-a-resource-from-the-registry.md): Get a resource from the registry.
- [Retrieve a resource from a data partition](https://docs.clinia.com/api-reference/resources/retrieve-a-resource-from-a-data-partition.md): Retrieve a resource from a data partition.
- [Upsert a contained resource in the registry](https://docs.clinia.com/api-reference/resources/upsert-a-contained-resource-in-the-registry.md): Upsert a contained resource in the registry.
- [Upsert a resource in the registry](https://docs.clinia.com/api-reference/resources/upsert-a-resource-in-the-registry.md): Upsert a resource in the registry.
- [Run multiple queries](https://docs.clinia.com/api-reference/search/run-multiple-queries.md): Execute several queries within a single request. It is possible to send multiple query items, where each of the item can be either a regular query or a federated query. To trigger a federated query, one must specify more then one collection key in the item.
- [Search accross resource or relationship collections in the data partition](https://docs.clinia.com/api-reference/search/search-accross-resource-or-relationship-collections-in-the-data-partition.md): Search across resource or relationship collections in the data partition. This endpoint only accepts federated search paths, which means that one using an operator it expects the collection type and collection key to be specified in the path. For example, `resources.<collectionKey>.<propertyKey>`. F…
- [Search accross resource, relationship or object collections in the registry](https://docs.clinia.com/api-reference/search/search-accross-resource-relationship-or-object-collections-in-the-registry.md): Search across resource, relationship or object collections in the registry. This endpoint suppport both regular and federated search depending on the number of collection keys specified in the path. If the search is done on one multiple collections are specified, it must use federated search paths.…
- [Search relationships of a specific type in the data partition](https://docs.clinia.com/api-reference/search/search-relationships-of-a-specific-type-in-the-data-partition.md): Search relationships of a specific type in the data partition.
- [Search resources of a specific collection in the data partition](https://docs.clinia.com/api-reference/search/search-resources-of-a-specific-collection-in-the-data-partition.md): Search resources of a specific collection in the data partition.
- [Create a data source](https://docs.clinia.com/api-reference/sources/create-a-data-source.md): Create a data source.
- [Get a data source](https://docs.clinia.com/api-reference/sources/get-a-data-source.md): Get the data source with the given key.
- [List the data sources](https://docs.clinia.com/api-reference/sources/list-the-data-sources.md): List the data sources.
- [Create a clinical summary for a given patient](https://docs.clinia.com/api-reference/summaries/create-a-clinical-summary-for-a-given-patient.md): Starts summary generation workflow and streams workflow events as SSE.
- [Delete a summary by id](https://docs.clinia.com/api-reference/summaries/delete-a-summary-by-id.md): Delete a summary by its id.
- [Get a summary by id](https://docs.clinia.com/api-reference/summaries/get-a-summary-by-id.md): Retrieve a summary by its id.
- [List summaries](https://docs.clinia.com/api-reference/summaries/list-summaries.md): Retrieve a list of summaries with optional filtering and pagination.
- [Generate a summary for the provided context](https://docs.clinia.com/api-reference/summarization/generate-a-summary-for-the-provided-context.md): Generate a summary for the provided context. This is similar to the `Complete` endpoint, but is designed for summarization tasks. it does not require a conversation ID and does not store the conversation history.
- [List summary templates](https://docs.clinia.com/api-reference/summary-templates/list-summary-templates.md): Retrieve a paginated list of summary templates.
- [Get a task from the registry](https://docs.clinia.com/api-reference/task/get-a-task-from-the-registry.md): Get the operation receipts related to a task id.
- [Get a specific history item](https://docs.clinia.com/api-reference/versionhistory/get-a-specific-history-item.md): Get a single version history entry by its operation ID. The full data payload of the entity at that point in time can optionally be included.
- [Get the history for a record or relationship](https://docs.clinia.com/api-reference/versionhistory/get-the-history-for-a-record-or-relationship.md): Retrieves a list of all operations performed on a specific source entity (record or relationship). Results can be paginated and filtered by a date range.
- [Bulk upsert or delete vocabularies](https://docs.clinia.com/api-reference/vocabularies/bulk-upsert-or-delete-vocabularies.md): Bulk upsert or delete vocabularies. Bulk operations are processed synchronously.
- [Bulk upsert, update or delete concepts](https://docs.clinia.com/api-reference/vocabularies/bulk-upsert-update-or-delete-concepts.md): Bulk upsert, update or delete concepts. Bulk operations are processed synchronously.
- [Delete a concept from a vocabulary](https://docs.clinia.com/api-reference/vocabularies/delete-a-concept-from-a-vocabulary.md): Delete a concept from a vocabulary.
- [Delete a vocabulary from the terminology](https://docs.clinia.com/api-reference/vocabularies/delete-a-vocabulary-from-the-terminology.md): Delete a vocabulary from the terminology.
- [Get a concept from a vocabulary](https://docs.clinia.com/api-reference/vocabularies/get-a-concept-from-a-vocabulary.md): Get a concept from a vocabulary.
- [Get a vocabulary from the terminology](https://docs.clinia.com/api-reference/vocabularies/get-a-vocabulary-from-the-terminology.md): Get a vocabulary from the terminology.
- [List all the vocabularies in the terminology](https://docs.clinia.com/api-reference/vocabularies/list-all-the-vocabularies-in-the-terminology.md): List all the vocabularies in the terminology.
- [Search for concepts in the terminology](https://docs.clinia.com/api-reference/vocabularies/search-for-concepts-in-the-terminology.md): Search for concepts in the terminology.
- [Upsert a concept in a vocabulary](https://docs.clinia.com/api-reference/vocabularies/upsert-a-concept-in-a-vocabulary.md): Upsert a concept in a vocabulary.
- [Upsert a vocabulary in the terminology](https://docs.clinia.com/api-reference/vocabularies/upsert-a-vocabulary-in-the-terminology.md): Upsert a vocabulary in the terminology.
- [Chunker Changelog](https://docs.clinia.com/changelogs/models/chunk.md): Updates about our chunker model
- [Medical Text Embeddings (MTE) Changelog](https://docs.clinia.com/changelogs/models/mte.md): Updates about our MTE suite of models
- [Clinia Platform Changelogs](https://docs.clinia.com/changelogs/platform.md): Product updates and announcements
- [What is an Agent?](https://docs.clinia.com/explanation/agents/intro.md): Understanding stateful agents and their role in the Clinia platform
- [Agent Memory](https://docs.clinia.com/explanation/agents/memory.md): How Clinia agents remember and learn over time
- [Monitoring and Benchmarking](https://docs.clinia.com/explanation/agents/monitoring.md): Tracing, coaching and evaluating Clinia agents
- [Authentication](https://docs.clinia.com/explanation/authentication.md): Learn how to authenticate with Clinia's API using API keys.
- [Concepts](https://docs.clinia.com/explanation/concepts.md): Understanding clinical concepts as the fundamental units of terminology in Clinia
- [Data Sources](https://docs.clinia.com/explanation/data-model/data-sources.md): Understand how sources organize resources, relationships, and objects before they enter the registry
- [Partitions](https://docs.clinia.com/explanation/data-model/partitions.md): See how to use partitions and exposes data for search and consumption
- [Profiles & Relationships](https://docs.clinia.com/explanation/data-model/profiles-relationships.md): Learn how to define schemas, contained resources, and validation rules in each source
- [Traversed Properties](https://docs.clinia.com/explanation/data-model/traversed-property.md): Learn how to configure traversal rules for your MDM partitions without denormalizing data.
- [Base Data Types](https://docs.clinia.com/explanation/data-types/base-types.md): Explore the primitive and composite types that power Clinia schemas
- [Clinia Complex Types](https://docs.clinia.com/explanation/data-types/clinia-types.md): Discover the opinionated data structures Clinia provides for healthcare interoperability
- [Error Codes and Types](https://docs.clinia.com/explanation/errors.md): Common error codes and types returned by Clinia's API.
- [Conditional Validation](https://docs.clinia.com/explanation/field-validation/advanced.md): Apply conditional logic, nested constraints, and cardinality to Clinia schemas
- [Basics](https://docs.clinia.com/explanation/field-validation/basic.md): Understand the core validation rules available on Clinia profiles and relationship definitions
- [Vocabulary Validation](https://docs.clinia.com/explanation/field-validation/vocabulary.md): Bind fields to vocabularies to enforce controlled terminology
- [Basics](https://docs.clinia.com/explanation/ingestion-pipeline/basics.md): Understand how Clinia pipelines process data between ingestion and persistence
- [Built-in Processors](https://docs.clinia.com/explanation/ingestion-pipeline/built-in-processors.md): Catalog of processors available out of the box in Clinia ingestion pipelines
- [Custom Processors](https://docs.clinia.com/explanation/ingestion-pipeline/custom-processor.md): Extend ingestion pipelines with bespoke logic when built-in processors are not enough
- [Resolution Outcomes](https://docs.clinia.com/explanation/mdm/entity-resolution/outcome.md): Understanding no match, definitive match, and possible match outcomes and queue handling
- [Overview](https://docs.clinia.com/explanation/mdm/entity-resolution/overview.md): How Clinia identifies and links records across sources to represent a single real‑world entity
- [Resolution Preview](https://docs.clinia.com/explanation/mdm/entity-resolution/preview.md): Preview resolution outcomes before ingestion to validate rules and anticipate matches
- [What is Master Data Management?](https://docs.clinia.com/explanation/mdm/overview.md): Overview of Clinia’s MDM module for unified collections, entity resolution, queues, and relative identities
- [Relative Identity Collection](https://docs.clinia.com/explanation/mdm/relative-identities/collection.md): Configuration governing relative identity sequences, differentiators, and source mappings
- [Identity Migration](https://docs.clinia.com/explanation/mdm/relative-identities/migration.md): Migrate legacy identifiers via external identifiers and assign them to unified records
- [Overview](https://docs.clinia.com/explanation/mdm/relative-identities/overview.md): Generate contextual identifiers based on differentiator properties across unified records
- [Model Catalog](https://docs.clinia.com/explanation/model-catalog.md): Overview of Clinia's models and when to use them
- [Operators](https://docs.clinia.com/explanation/operator.md): Understand how Clinia's operators enable precise search and filtering across the platform
- [MDM partitions](https://docs.clinia.com/explanation/partitions/mdm-partition.md): Serve unified records reconciled from multiple sources through the data partition API.
- [Source partitions](https://docs.clinia.com/explanation/partitions/source-partition.md): Expose raw collections and relationships from a single data source to downstream consumers.
- [Search Parameters](https://docs.clinia.com/explanation/search.md): Understand how to structure and use search parameters for comprehensive querying in Clinia's Data Partition API
- [Data sources](https://docs.clinia.com/explanation/sources/data-source.md): Define the upstream systems that own records, schemas, and synchronization rules.
- [Profiles](https://docs.clinia.com/explanation/sources/profile.md): Model resource schemas, validation, and contained components for each data source.
- [Relationship definitions](https://docs.clinia.com/explanation/sources/relationship.md): Model how profiles connect, including include keys, cardinalities, and relationship properties.
- [Vocabularies](https://docs.clinia.com/explanation/vocabularies.md): Understanding vocabularies as containers for clinical terminology concepts in Clinia
- [Ingest files with OCR](https://docs.clinia.com/guides/how-to/file-ingestion-ocr.md): Configure an object collection, attach the Optical Character Recognition (OCR) pipeline, and ingest files that are automatically transcribed into searchable text. Then search on them!
- [Provider Search](https://docs.clinia.com/guides/journeys/provider-search.md): How-to setup a provider search experience for your patient portal.
- [Browse](https://docs.clinia.com/guides/managing-data/browse.md): Iterate through large datasets in selected partitions using a cursor-based snapshot for consistent bulk extraction with filtering and property selection.
- [Historical Import](https://docs.clinia.com/guides/managing-data/historical-import.md): Specifying metadata information on resources, relationships, and objects creation
- [Purge](https://docs.clinia.com/guides/managing-data/purge.md): Bulk delete all resources, relationships, or objects of a specific type from a data source using the Purge API endpoint
- [Tasks](https://docs.clinia.com/guides/managing-data/tasks.md): Process large volumes of registry operations efficiently using the bulk API or ensure atomicity with bundle requests
- [Hybrid Search](https://docs.clinia.com/guides/search/hybrid-search.md): Combine lexical and semantic retrieval for high recall and precision.
- [Highlighting](https://docs.clinia.com/guides/search/search-highlights.md): How to highlight search results
- [Transactional Search](https://docs.clinia.com/guides/search/traversed-property.md): Use traversed properties in the Search API to answer transactional questions in real time.
- [Clinical Summarization](https://docs.clinia.com/guides/summarization/clinical.md): How to generate clinical summaries using the AI Engine.
- [Overview](https://docs.clinia.com/iam/iam-overview.md): Overview of Clinia's Identity and Access Management (IAM) module, including users, service accounts, roles, and permissions.
- [Overview](https://docs.clinia.com/iam/roles.md): How roles work in Clinia IAM, including built-in roles and guidance on assigning and managing role-based access.
- [System-Defined Permissions](https://docs.clinia.com/iam/system-defined-permissions.md): Predefined permissions that compose roles, with notes on wildcards and when to use user-defined policies for granular access.
- [User-Defined Policies](https://docs.clinia.com/iam/user-defined-policies.md): Fine-grained access controls that constrain system-defined permissions to specific entities like data sources, profiles, or partitions.
- [Users and Service Accounts](https://docs.clinia.com/iam/users.md): Differences between user accounts and service accounts in Clinia IAM and how they authenticate and access the platform.
- [Clinia Platform](https://docs.clinia.com/index.md): A composable health data platform combining the Data Fabric, AI Engine, and Health Memory Layer to power trusted clinical applications.

## OpenAPI Specs

- [hermes](https://docs.clinia.com/api-reference/hermes.yml)
- [terminology](https://docs.clinia.com/api-reference/terminology.yml)
- [registry](https://docs.clinia.com/api-reference/registry.yml)
- [mdm](https://docs.clinia.com/api-reference/mdm.yml)
- [datapartition](https://docs.clinia.com/api-reference/datapartition.yml)
- [datacatalog](https://docs.clinia.com/api-reference/datacatalog.yml)
- [ai](https://docs.clinia.com/api-reference/ai.yml)