EHR Integration

Create or update EHR integration configuration

Creates or updates the authenticated organization's local EHR integration configuration using redacted setup metadata.

PUTPublic reference baselineExternal or credentialedEHR IntegrationoperationId: upsertEhrIntegrationConfighttps://dev-api.quickintell.com/api/v1/ehr-integration/config

Public reference baselineExternal or credentialedIntegrations

Route status

Public reference baseline

Generated endpoint contract may be shown with caveats, but external publication still needs route registry and release evidence.

Publication status

Baseline reference only

Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.

Authentication

Bearer API key declared

OpenAPI declares bearer API-key security for this operation.

Tenant context

API-key organization

API-key organization context is authoritative; request organizationId is not a public tenant selector.

Side-effect summary

External or credentialed

May touch credentials, webhooks, SFTP, EHRs, payers, portals, clearinghouses, or other external systems.

Source artifact

docs/openapi/openapi.json

OpenAPI 3.1.0; API 1.0.0.

When to use this endpoint

Use this page as an internal baseline for the integrations contract generated for PUT /api/v1/ehr-integration/config. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Documents the generated PUT /api/v1/ehr-integration/config contract as a external or credentialed baseline endpoint.

What this does not do

Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior. Mutating behavior still needs side-effect and retry evidence.

Not public from this page

Live external side effects, file contents, credentials, webhooks, SDK promises, and production recipes are still gated.

Headers and tenancy

Current headers and tenant authority. Target headers stay labeled as future until OpenAPI and release evidence declare them.

Header	Required	Current status	Notes
Authorization	Yes	Current	Bearer <QUICKRCM_API_KEY>. OpenAPI security: bearerAuth.
Idempotency-Key	No	Target/future	Do not claim universal header support until E3 and OpenAPI metadata exist.
X-Request-Id	No	Target/future	Use for support correlation only after approved; not declared as a standard OpenAPI header today.

Required scopes

Unclassified until E6 route metadata exists; do not infer scopes from route names.

Wrong-org behavior

Tenant-safe 404, empty list, or 403 is endpoint-specific and remains an evidence gap until E1 is closed.

Actor and audit

No public actor, audit, or correlation contract is published from OpenAPI alone.

Idempotency and retries

Retry behavior is documented conservatively because universal idempotency headers are not declared.

Topic	Status	Guidance
Current idempotency	No idempotency mechanism is declared.	Do not retry blindly. Check resource, status, batch, or job state before repeating the request.
Universal header	Not declared	Do not document universal Idempotency-Key support until OpenAPI and E3 evidence declare it.
Conflict behavior	Unresolved	Same-key changed-payload, in-flight retry, fingerprint scope, and TTL behavior remain endpoint-specific evidence gaps.

Async jobs and polling

Queued work is accepted work, not proof of completed workflow execution.

Topic	Status	Guidance
Immediate response	No 202 response declared	OpenAPI does not declare HTTP 202 for this operation.
Polling and terminal states	Not indicated by OpenAPI	No generic polling contract is published from this page.
Later side effects	Not proven	Do not infer background execution beyond the documented response.

Files and artifacts

File-like routes need content-class, ownership, scanning, retention, and URL policy evidence before public recipes.

Topic	Status	Guidance
Content class	No file/artifact class inferred	OpenAPI text does not indicate file or artifact handling for this endpoint.
Ownership and storage keys	Not applicable unless a file field is present	Tenant ownership must be proven before retrieval or upload docs. Never expose storage keys as public identifiers.
URLs, scanning, and retention	Unresolved unless endpoint-specific evidence exists	Short-lived URLs, MIME limits, checksums, scanner status, retention, expiration, and legal hold behavior are not implied by OpenAPI examples.

Publication warnings

Universal Idempotency-Key header support is not declared; retry only after checking endpoint-specific state.
External or credentialed behavior needs vendor trust, credential, webhook, and callback evidence before publication.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness Side-Effect Modes Idempotency

Evidence

Evidence	Status	Caveat
OpenAPI artifact	docs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.	Generated baseline contract only.
Route registry	Public reference baseline from documentation classification overlay.	E6 route registry evidence is still required before external publication.
Example validation	Generated examples are internal baseline aids.	No external publication claim; examples must pass no-PHI/no-secret/no-raw-payload/no-storage-key checks.
Last reviewed	Implementation run 20260619T-docs-impl; source boardroom packet 20260619T064820Z.	Refresh this evidence for release workspaces.
Release evidence	E9 required.	No SDK readiness, production readiness, or expanded external docs claim from this endpoint page.

EHR Integration public API.

EHR Integration public APIs expose the tenant-scoped control plane for an organization's configured EHR connection: sanitized configuration summaries, local activation state, field and facility mappings, sync-log visibility, queue-only sync requests, dry-run validation, and conflict-resolution metadata. These endpoints are not raw Fast Healthcare Interoperability Resources (FHIR) proxy routes. Public docs should distinguish returned local metadata from omitted sensitive identifiers. Local ids such as organizationId, config ids, mapping ids, syncLogId, integrationConfigId, entityConfigId, facilityId, and conflictId may be returned, and FACILITY mapping responses intentionally include externalFacilityId and externalSiteId. Raw vendor payload identifiers, sync-log internalId/externalId, conflict localData/remoteData values, raw request/response payloads, patient/source-record identifiers, credentials, endpoint URLs, transformConfig, webhook secrets, and patient demographics should not be documented as returned unless an endpoint schema explicitly does so. Authentication is bearer API-key based. Read endpoints accept EHR Integration read access, while configuration mutations, mapping mutations, queue endpoints, validation endpoints, and conflict resolution require write-level EHR Integration access plus tenant authorization and role-based access control (RBAC). The API key selects the organization; public docs should not present organizationId as a caller-supplied tenant selector. Side-effect language should be precise. `testEhrConnection`, `validateEhrRecordSync`, and `validateEhrFullResync` are validation-only/dry-run routes. `activateEhrIntegrationConfig` and `deactivateEhrIntegrationConfig` are local database-only state transitions. `queueEhrManualSync` and `queueEpicBulkImport` return HTTP 202 queue acknowledgements and do not prove that an external EHR accepted or completed work. Manual sync is publicly allowed only for PATIENT, APPOINTMENT, INSURANCE, and ENCOUNTER even though the shared entityType schema lists additional values for other EHR workflows.

What this endpoint does

Use case

Use this during onboarding or admin configuration changes to set vendor, base URL, API preference, active flag, retry/rate-limit controls, batch size, webhook-enabled flag, and redacted credential-status indicators.

Before calling

Collect non-secret configuration values and decide whether the local config should be active. Do not include raw API keys, client secrets, private keys, JWK contents, webhook secrets, access tokens, refresh tokens, or raw SMART/FHIR responses.

Request and response behavior

Request guidance

`baseUrl` is required and must be a URI. `ehrSystem` defaults to OPENEMR and accepts OPENEMR, EPIC, CERNER, ECLINICALWORKS, ATHENA, MEDITECH, or OTHER. `apiPreference` defaults to HYBRID. `authType` defaults to OAUTH2_CLIENT_CREDENTIALS and accepts OAUTH2_CLIENT_CREDENTIALS, OAUTH2_PASSWORD, or OAUTH2_AUTHORIZATION_CODE. `siteId` is 1-100 characters and defaults to `default`; `ehrVersion` is optional and 1-100 characters. Numeric limits are bounded: `rateLimitPerMinute` 1-600, `retryMaxAttempts` 0-10, `retryBackoffMs` 0-60000, and `syncBatchSize` 1-500. `credentialStatus.scopes` accepts up to 50 non-empty strings. `credentialStatus` accepts flags/scopes and request metadata such as `epicBulkGroupId`; it is not a secret transport.

`baseUrl` is required in the request but intentionally omitted from the response.
`siteId`, `authType`, and `credentialStatus` are accepted in the request but omitted from sanitized config responses.
`credentialStatus.epicBulkGroupId` is request metadata; connection-test responses expose only `epicBulkGroupIdConfigured`.
Do not document credential rotation or secret storage behavior unless a separate supported secret-management workflow is cited.

Response semantics

HTTP 200 returns the sanitized config after create/update. The response does not prove live EHR connectivity and does not return baseUrl, siteId, authType, credentialStatus, credential values, webhook secrets, endpoint URLs, or custom vendor config.

Returns the same sanitized config shape as getEhrIntegrationConfig.
Use testEhrConnection only for redacted request-shape validation; use health monitoring for live availability.
Vendor enum values do not imply public write support for every vendor/resource.

Errors and retries

Fix 400 validation errors before retrying. After an ambiguous timeout, call getEhrIntegrationConfig before repeating the upsert to avoid overwriting a successful update with stale values.

400 can indicate an invalid URL, enum, strict-body extra property, or out-of-range numeric setting.
403 means the caller lacks EHR Integration write permission or tenant authorization.
Retry 429/5xx with backoff; do not retry malformed payloads unchanged.

Template boundary before examples

The route class, authentication state, tenancy rule, side-effect mode, idempotency status, async behavior, file policy, warnings, links, and evidence above are part of the endpoint contract. Treat generated examples below as internal baseline aids until release evidence closes.

Path parameters

This endpoint does not define path parameters.

Query parameters

This endpoint does not define query parameters.

OpenAPI-declared header parameters

Standard platform header guidance appears in the governance panel. This table only lists operation-specific headers declared in OpenAPI.

This endpoint does not define operation-specific header parameters.

Request body

JSON fields from the generated OpenAPI schema with pilot enrichment applied where available. Nested object fields are shown with dotted paths.

Name	Location	Required	Type	Description	Validation and safety notes
ehrSystem	body	No	OPENEMR \| EPIC \| CERNER \| ECLINICALWORKS \| ATHENA \| MEDITECH \| OTHER	Configured vendor enum. Defaults to OPENEMR; accepted values are OPENEMR, EPIC, CERNER, ECLINICALWORKS, ATHENA, MEDITECH, and OTHER.	Enum values are declared in the Type column. Default: OPENEMR. Potential PHI; use synthetic examples and avoid logging raw values.
ehrVersion	body	No	string	Optional version or environment label, 1-100 characters when supplied. It is returned as nullable metadata, not as a live capability statement.	Minimum length: 1. Maximum length: 100.
baseUrl	body	Yes	string (uri)	Vendor endpoint base URI accepted in the request. It is sensitive operational metadata and is not returned.	Format: uri.
siteId	body	No	string	Optional site identifier, 1-100 characters, defaulting to default. It is accepted in the request and omitted from sanitized config responses.	Minimum length: 1. Maximum length: 100. Default: default.
authType	body	No	OAUTH2_CLIENT_CREDENTIALS \| OAUTH2_PASSWORD \| OAUTH2_AUTHORIZATION_CODE	OAuth flow metadata. Defaults to OAUTH2_CLIENT_CREDENTIALS; accepted values are OAUTH2_CLIENT_CREDENTIALS, OAUTH2_PASSWORD, and OAUTH2_AUTHORIZATION_CODE. It is not returned in sanitized config responses.	Enum values are declared in the Type column. Default: OAUTH2_CLIENT_CREDENTIALS. Sensitive credential or storage-adjacent value; use placeholders only.
apiPreference	body	No	STANDARD_REST \| FHIR_R4 \| HYBRID	Configured EHR API mode. Defaults to HYBRID; accepted values are STANDARD_REST, FHIR_R4, and HYBRID.	Enum values are declared in the Type column. Default: HYBRID.
credentialStatus	body	No	object	Redacted credential metadata flags/scopes. It must not include secret values.	Default: [object Object]. Sensitive credential or storage-adjacent value; use placeholders only.
credentialStatus.hasClientSecret	body	No	boolean	OpenAPI description is missing; publication gap.	Default: false. Sensitive credential or storage-adjacent value; use placeholders only.
credentialStatus.hasPrivateKey	body	No	boolean	OpenAPI description is missing; publication gap.	Default: false. Sensitive credential or storage-adjacent value; use placeholders only.
credentialStatus.hasJwk	body	No	boolean	OpenAPI description is missing; publication gap.	Default: false. Sensitive credential or storage-adjacent value; use placeholders only.
credentialStatus.tokenUrlConfigured	body	No	boolean	OpenAPI description is missing; publication gap.	Default: false. Sensitive credential or storage-adjacent value; use placeholders only.
credentialStatus.scopes	body	No	string[]	Array of up to 50 non-empty scope strings used as redacted credential metadata; do not include tokens or secrets.	Default: . Sensitive credential or storage-adjacent value; use placeholders only.
credentialStatus.epicBulkGroupId	body	No	string	Optional request metadata indicating the Epic bulk group id is configured; the public connection-test response returns only a boolean configured flag.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.
isActive	body	No	boolean	Schedule active-state boolean. Schedule create defaults to true; pause/resume endpoints also mutate active state.	Default: false.
rateLimitPerMinute	body	No	integer	Local per-minute budget for EHR integration work; accepted range is 1 to 600.	Minimum value: 1. Maximum value: 600. Default: 60.
retryMaxAttempts	body	No	integer	OpenAPI description is missing; publication gap.	Minimum value: 0. Maximum value: 10. Default: 3.
retryBackoffMs	body	No	integer	OpenAPI description is missing; publication gap.	Minimum value: 0. Maximum value: 60000. Default: 1000.
syncBatchSize	body	No	integer	Maximum records per sync batch; accepted range is 1 to 500.	Minimum value: 1. Maximum value: 500. Default: 50.
enableWebhooks	body	No	boolean	OpenAPI description is missing; publication gap.	Default: false.

Generated request example

Generated examples are baseline contract aids only. They are not external publication evidence and must not include real PHI, credentials, raw vendor payloads, raw EDI, transcripts, storage keys, or signed URLs.

{
  "baseUrl": "https://example.quickintell.com/resource",
  "ehrSystem": "OPENEMR",
  "ehrVersion": "example-ehrversion",
  "siteId": "default",
  "authType": "OAUTH2_CLIENT_CREDENTIALS",
  "apiPreference": "HYBRID",
  "credentialStatus": {},
  "isActive": false,
  "rateLimitPerMinute": 60
}

Successful responses

Generated response examples show the baseline OpenAPI contract. Tenant identifier echo, PHI redaction, pagination, money, date/time, and enum semantics remain endpoint-specific publication checks.

200

Sanitized EHR integration configuration after create/update.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "config": {
      "id": "00000000-0000-4000-8000-000000000001",
      "organizationId": "00000000-0000-4000-8000-000000000001",
      "ehrSystem": "OPENEMR",
      "ehrDisplayName": "Example upsert_ehr_integration_config",
      "ehrVersion": "example-ehrversion",
      "apiPreference": "STANDARD_REST",
      "isActive": true,
      "healthStatus": "HEALTHY",
      "lastHealthCheckAt": "2026-06-08T10:15:30Z",
      "rateLimitPerMinute": 1,
      "retryMaxAttempts": 1,
      "retryBackoffMs": 1,
      "syncBatchSize": 1,
      "enableWebhooks": true,
      "entityConfigs": [
        {
          "id": "00000000-0000-4000-8000-000000000001",
          "entityType": "PATIENT",
          "syncDirection": "READ_ONLY",
          "syncStrategy": "REAL_TIME",
          "syncSchedule": "example-syncschedule",
          "sourceOfTruth": "OPENEMR",
          "conflictResolution": "LAST_WRITE_WINS",
          "isActive": true,
          "createdAt": "2026-06-08T10:15:30Z",
          "updatedAt": "2026-06-08T10:15:30Z"
        }
      ],
      "createdAt": "2026-06-08T10:15:30Z",
      "updatedAt": "2026-06-08T10:15:30Z"
    }
  },
  "meta": {
    "organizationId": "00000000-0000-4000-8000-000000000001"
  }
}

Error responses

Errors must remain sanitized. Do not include raw payer, EHR, SFTP, SMTP, Stripe, LLM/OCR, browser automation, file, transcript, EDI, worker, or vendor payloads.

400

Invalid request.