Skip to main content
POST
/
v1
/
consents
Sign consent
curl --request POST \
  --url https://api.clinikapi.com/v1/consents \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "patientId": "<string>",
  "scope": "<string>",
  "category": "<string>",
  "dateTime": "2023-11-07T05:31:56Z",
  "performerId": "<string>",
  "organizationId": "<string>",
  "policyUri": "<string>",
  "policies": [
    {
      "authority": "<string>",
      "uri": "<string>"
    }
  ],
  "policyRule": "<string>",
  "sourceAttachment": {
    "contentType": "<string>",
    "data": "<string>",
    "url": "<string>",
    "title": "<string>"
  },
  "sourceReferenceId": "<string>",
  "verification": [
    {
      "verified": true,
      "verifiedWith": "<string>",
      "verificationDate": "<string>"
    }
  ],
  "provision": {
    "period": {
      "start": "<string>",
      "end": "<string>"
    },
    "actor": [
      {
        "role": "<string>",
        "reference": "<string>"
      }
    ],
    "action": [
      {
        "system": "<string>",
        "code": "<string>",
        "display": "<string>"
      }
    ],
    "securityLabel": [
      {
        "system": "<string>",
        "code": "<string>",
        "display": "<string>"
      }
    ],
    "purpose": [
      {
        "system": "<string>",
        "code": "<string>",
        "display": "<string>"
      }
    ],
    "class": [
      {
        "system": "<string>",
        "code": "<string>",
        "display": "<string>"
      }
    ],
    "dataPeriod": {
      "start": "<string>",
      "end": "<string>"
    },
    "data": [
      {
        "reference": "<string>"
      }
    ]
  }
}
'

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
patientId
string
required
scope
string
required

patient-privacy, research, treatment, adr

category
required
status
enum<string>
Available options:
draft,
proposed,
active,
rejected,
inactive
dateTime
string<date-time>
performerId
string

Who is agreeing (practitioner, patient)

organizationId
string

Custodian organization

policyUri
string

Policy URI the consent references

policies
object[]

Multiple policies with authority

policyRule
string

Regulation that this consents to

sourceAttachment
object

Source document (attachment)

sourceReferenceId
string

Source document reference ID

verification
object[]

Verification details (supports multiple)

provision
object

Provision rules (permit/deny) with nested exceptions

Response

201

Consent signed