Sandbox Dashboard

Documentation API Reference Changelog

Introduction
API Principles
Resources
API Reference
Deprecated APIs

API Reference Consent

Create Patient Consent

POST

/api/patients/:id/consent

POST

/api/patients/:id/consent

1 curl -X POST https://app.usebridge.com/api/patients/id/consent \
2      -H "X-API-Key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "type": "ASSIGNMENT_OF_BENEFITS",
6   "version": "v1.2",
7   "consentedAt": "2024-01-15T09:30:00Z"
8 }'

200Successful

1 {
2   "id": "a3f47c9e-8b2d-4f1a-9c3e-2d5f7b6a9e1c",
3   "patientId": "patient-12345",
4   "type": "ASSIGNMENT_OF_BENEFITS",
5   "version": "v1.2",
6   "consentedAt": "2024-01-15T09:30:00Z",
7   "expiresAt": "2025-01-15T09:30:00Z",
8   "status": "ACTIVE"
9 }

Authentication

X-API-Keystring

API Key authentication via header

Path parameters

idstringRequired

Request

This endpoint expects an object.

typeenumRequired

Allowed values:

versionstringRequired

The base document version that was agreed to, available at [Dashboard > Organization > Consent](https://app.usebridge.com/organization/consent) (eg, '2024-01-01')

consentedAtdatetimeRequired

Response

This endpoint returns an object.

idstring

patientIdstring

typeenum

Allowed values:

versionstring

consentedAtdatetime

expiresAtdatetime

statusenum

Allowed values:

Was this page helpful?

List Events

Sandbox Dashboard

The base document version that was agreed to, available at Dashboard > Organization > Consent (eg, ‘2024-01-01’)