# Ovok primitives

Canonical page: https://docs.ovok.com/primitives

This reference lists core platform routes and FHIR operations exposed by Ovok. Paths use `:type` for a FHIR resource type and `:id` for a resource id.

## Health and discovery [#health-and-discovery]

Use the [Health and discovery](/primitives/health-and-discovery) reference for cURL examples, response examples, and explanations of the returned fields.

| Operation | Method | Path |
| --- | --- | --- |
| [Health check](/primitives/health-and-discovery#health-check) | `GET` | `/healthcheck` |
| [OpenID Connect discovery](/primitives/health-and-discovery#openid-connect-discovery) | `GET` | `/.well-known/openid-configuration` |
| [JSON Web Key Set](/primitives/health-and-discovery#json-web-key-set) | `GET` | `/.well-known/jwks.json` |
| [SMART configuration](/primitives/health-and-discovery#smart-configuration) | `GET` | `/.well-known/smart-configuration` |
| [SMART configuration](/primitives/health-and-discovery#smart-configuration) | `GET` | `/fhir/R4/.well-known/smart-configuration` |
| [FHIR CapabilityStatement](/primitives/health-and-discovery#fhir-capabilitystatement) | `GET` | `/fhir/R4/metadata` |

## Observation and questionnaire operations [#observation-and-questionnaire-operations]

Each operation has its own reference page with request parameters, cURL examples, response examples, and error handling:

| Operation | Method | Path |
| --- | --- | --- |
| [Get last observations](/primitives/last-observations) | `GET` | `/fhir/R4/Observation/$lastn` |
| [Populate a Questionnaire](/primitives/populate-questionnaire) | `POST` | `/fhir/R4/Questionnaire/:id/$populate` |
| [Extract Observations from a QuestionnaireResponse](/primitives/extract-observations) | `POST` | `/fhir/R4/QuestionnaireResponse/:id/$extract` |

## Signals operations [#signals-operations]

Use this operation to enroll an existing Patient in Signals. See [Working with Signals](/signals/connected-ovok) for the full Signals workflow and related routes.

| Operation | Method | Path |
| --- | --- | --- |
| [Enable Signals for a Patient](/primitives/enable-signals-patient) | `POST` | `/fhir/R4/Patient/:id/$enable-signals` |

## FHIR resource operations [#fhir-resource-operations]

| Operation | Method | Path |
| --- | --- | --- |
| [Validate a resource](/primitives/validate-resource) | `POST` | `/fhir/R4/:type/$validate` |
| [Expunge a resource](/primitives/expunge-resource) | `POST` | `/fhir/R4/:type/:id/$expunge` |
| [Export a resource type as CSV](/primitives/export-csv) | `GET` | `/fhir/R4/:type/$csv` |
| [Reindex a resource](/primitives/reindex-resource) | `POST` | `/fhir/R4/:type/:id/$reindex` |
| [Get a resource graph](/primitives/resource-graph) | `GET` | `/fhir/R4/:type/:id/$graph` |
| [Get everything for a Patient](/primitives/patient-everything) | `GET` | `/fhir/R4/Patient/:id/$everything` |
| [Set accounts for a Patient](/primitives/set-accounts-patient) | `POST` | `/fhir/R4/Patient/:id/$set-accounts` |
| [Set accounts for a resource](/primitives/set-accounts-resource) | `POST` | `/fhir/R4/:type/:id/$set-accounts` |
| [Resend a resource](/primitives/resend-resource) | `POST` | `/fhir/R4/:type/:id/$resend` |
| [Merge resources by type](/primitives/merge-resources-by-type) | `POST` | `/fhir/R4/:type/$merge` |
| [Merge a resource by id](/primitives/merge-resource-by-id) | `POST` | `/fhir/R4/:type/:id/$merge` |
| [Execute a Bot by id](/primitives/execute-bot-by-id) | `POST` | `/fhir/R4/Bot/:id/$execute` |
| [Deploy a Bot](/primitives/deploy-bot) | `POST` | `/fhir/R4/Bot/:id/$deploy` |
| [Execute a Bot by identifier](/primitives/execute-bot-by-identifier) | `POST` | `/fhir/R4/Bot/$execute?identifier=` |
| [Clone a Project](/primitives/clone-project) | `POST` | `/fhir/R4/Project/:id/$clone` |
| [Apply a PlanDefinition](/primitives/apply-plan-definition) | `POST` | `/fhir/R4/PlanDefinition/:id/$apply` |
| [Apply an ActivityDefinition](/primitives/apply-activity-definition) | `POST` | `/fhir/R4/ActivityDefinition/:id/$apply` |

## Bulk Data operations [#bulk-data-operations]

| Operation | Method | Path |
| --- | --- | --- |
| [Export system data](/primitives/export-system-data) | `GET` | `/fhir/R4/$export` |
| [Export Patient data](/primitives/export-patient-data) | `GET` | `/fhir/R4/Patient/$export` |
| [Export Group data](/primitives/export-group-data) | `GET` | `/fhir/R4/Group/:id/$export` |
| [Check bulk export status](/primitives/check-bulk-export-status) | `GET` | `/fhir/R4/bulkdata/export/:id` |
| [Import data](/primitives/import-data) | `POST` | `/fhir/R4/$import` |
| [Check asynchronous job status](/primitives/check-async-job-status) | `GET` | `/fhir/R4/job/:id/status` |

## Terminology operations [#terminology-operations]

| Operation | Method | Path |
| --- | --- | --- |
| [Expand a ValueSet](/primitives/expand-valueset) | `GET` or `POST` | `/fhir/R4/ValueSet/$expand` |
| [Validate a code against a ValueSet](/primitives/validate-valueset-code) | `GET` or `POST` | `/fhir/R4/ValueSet/$validate-code` |
| [Look up a CodeSystem concept](/primitives/lookup-codesystem) | `GET` or `POST` | `/fhir/R4/CodeSystem/$lookup` |
| [Validate a CodeSystem code](/primitives/validate-codesystem-code) | `GET` or `POST` | `/fhir/R4/CodeSystem/$validate-code` |
| [Test CodeSystem subsumption](/primitives/subsumes-codesystem) | `GET` or `POST` | `/fhir/R4/CodeSystem/$subsumes` |
| [Import a CodeSystem](/primitives/import-codesystem) | `POST` | `/fhir/R4/CodeSystem/$import` |
| [Translate a concept using a ConceptMap](/primitives/translate-concept) | `GET` or `POST` | `/fhir/R4/ConceptMap/$translate` |

`CodeSystem/$import` changes terminology data, so it is documented as a `POST` operation. To inspect the CodeSystem after importing, use the separate `GET /fhir/R4/CodeSystem` search shown on its page.
