Skip to main content

clinik.measures

Measures (FHIR Measure) define quality measures, clinical guidelines, and performance metrics used in healthcare quality reporting.

create

const { data, meta } = await clinik.measures.create(request): Promise<ApiResponse<Measure>>
FieldTypeRequiredDescription
statusstringYesdraft, active, retired
namestringNoComputer-friendly name
titlestringNoHuman-friendly title
descriptionstringNoDescription
purposestringNoWhy this measure is defined
usagestringNoClinical usage description
publisherstringNoPublisher
datestringNoPublication date
versionstringNoBusiness version
urlstringNoCanonical URL
experimentalbooleanNoFor testing purposes
scoringstringNoproportion, ratio, continuous-variable, cohort
typestring[]Noprocess, outcome, structure, patient-reported-outcome, composite
riskAdjustmentstringNoRisk adjustment description
rationalestringNoRationale
clinicalRecommendationStatementstringNoClinical recommendation
guidancestringNoImplementation guidance
topicstring[]NoTopic categories
groupArrayNoMeasure groups
group[].codestringNoGroup code
group[].descriptionstringNoGroup description

Example

const { data } = await clinik.measures.create({
  status: 'active',
  name: 'diabetes-hba1c-control',
  title: 'Diabetes: HbA1c Poor Control (>9%)',
  description: 'Percentage of patients 18-75 with diabetes whose HbA1c was >9.0%',
  scoring: 'proportion',
  type: ['outcome'],
  topic: ['Diabetes', 'Quality Measure'],
  group: [{
    code: 'initial-population',
    description: 'Patients 18-75 with diabetes',
  }],
});
Same pattern as other resources. Update supports status, title, description, version. Search supports status, name, title, topic filters.