Sign in

v1

latestOpenAPI 3.1.02026-07-265074203.0 KB
Definitions

Retrieve an existing definition.

Retrieve a specific definition.

get/caregaps/api/{quality_program}/definition/{definition_id}/

Path parameters

quality_programstring required
definition_idstring required

Query parameters

practice_idstring

Response

Successful Response

quality_programstring

Quality program this definition is associated with.

namestring required

Human readable name for the definition

indicator'info' | 'warning' | 'critical' required

An enumeration.

selection_behavior'any' | 'at-most-one' required

An enumeration.

descriptionstring

Sentence that describes the definition. Allowed HTML tags: a, abbr, acronym, b, blockquote, br, code, div, em, h1, h2, h3, h4, h5, h6, i, li, ol, p, strong, u, ul

practice_idstring

Practice id this definition is authorized for.

start_datestring date required

Start date for period

end_datestring date required

End date for period

external_idstring

Identifer for linking to external systems

idstring required

UUID that identifies this definition