Skip to main content
GET
Retrieve an existing definition.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

quality_program
string
required
definition_id
string
required

Query Parameters

practice_id
string

Response

Successful Response

name
string
required

Human readable name for the definition

indicator
enum<string>
required

Indicator of the definition

Available options:
info,
warning,
critical
source
Source · object
required

Source of the definition

selection_behavior
enum<string>
required

Selection Behavior of the definition

Available options:
any,
at-most-one
start_date
string<date>
required

Start date for period

end_date
string<date>
required

End date for period

suggestions
ExistingSuggestion · object[]
required

List of suggestions to take action on with this definition that includes a uuid

id
string
required

UUID that identifies this definition

quality_program
string

Quality program this definition is associated with.

closing_codes
Coding · object[]

List of closing codes.

description
string

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

Practice id this definition is authorized for.

override_reasons
Coding · object[]

Override reasons written as codings for the definition

Relevant links for the definition

additional_documentation
DocSection · object[]

Additional documentation sections for reference in the EHR. Allowed HTML tags: a, abbr, acronym

external_id
string

Identifer for linking to external systems