Skip to main content
POST
/
v1
/
measures
Create measure
curl --request POST \
  --url https://api.clinikapi.com/v1/measures \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "title": "<string>",
  "description": "<string>",
  "purpose": "<string>",
  "usage": "<string>",
  "publisher": "<string>",
  "date": "<string>",
  "version": "<string>",
  "url": "<string>",
  "experimental": true,
  "scoring": "<string>",
  "type": [
    "<string>"
  ],
  "riskAdjustment": "<string>",
  "rationale": "<string>",
  "clinicalRecommendationStatement": "<string>",
  "guidance": "<string>",
  "topic": [
    "<string>"
  ],
  "group": [
    {
      "code": "<string>",
      "description": "<string>"
    }
  ]
}
'

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
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
scoring
string

proportion, ratio, continuous-variable, cohort

Maximum string length: 200
type
string[]

process, outcome, structure, patient-reported-outcome, composite

Maximum array length: 10
Maximum string length: 200
riskAdjustment
string
Maximum string length: 5000
rationale
string
Maximum string length: 5000
clinicalRecommendationStatement
string
Maximum string length: 5000
guidance
string
Maximum string length: 5000
topic
string[]
Maximum array length: 10
Maximum string length: 200
group
object[]
Maximum array length: 20

Response

201

Measure created