Skip to main content
POST
Create activity definition

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
status
enum<string>
required
Available options:
draft,
active,
retired
name
string
Maximum string length: 500
title
string
Maximum string length: 500
description
string
Maximum string length: 5000
purpose
string
Maximum string length: 5000
usage
string
Maximum string length: 5000
kind
string
Maximum string length: 100
code
Maximum string length: 200
intent
enum<string>
Available options:
proposal,
plan,
directive,
order
priority
enum<string>
Available options:
routine,
urgent,
asap,
stat
doNotPerform
boolean
timingDateTime
string
Maximum string length: 30
timingPeriod
object
locationId
string
Maximum string length: 128
participant
object[]
Maximum array length: 20
quantity
object
bodySite
string[]
Maximum array length: 10
Maximum string length: 200
publisher
string
Maximum string length: 500
date
string
Maximum string length: 30
version
string
Maximum string length: 100
url
string
Maximum string length: 2000
experimental
boolean
topic
string[]
Maximum array length: 10
Maximum string length: 200

Response

201

Activity definition created