imednet.discovery module

Runtime helpers that locate study metadata for tests and scripts. When required identifiers are not provided, these utilities query the first available study, form, site, subject, or interval.

discover_study_key

discover_study_key(sdk: ImednetSDK) → str

Return the first study key available for the provided SDK.

Parameters:

sdk – Authenticated ImednetSDK instance.

Returns:

Study key of the first available study.

Raises:

imednet.discovery.NoLiveDataError – When no studies exist.

from imednet import ImednetSDK
from imednet.discovery import discover_study_key

sdk = ImednetSDK(base_url, (username, token))
study_key = discover_study_key(sdk)

discover_form_key

discover_form_key(sdk: ImednetSDK, study_key: str) → str

Return the first subject record form key for study_key.

Parameters:

  • sdk – Authenticated SDK.

  • study_key – Identifier of the study to query.

Returns:

First form key supporting subject records.

Raises:

imednet.discovery.NoLiveDataError – When no suitable forms exist.

form_key = discover_form_key(sdk, study_key)

discover_site_name

discover_site_name(sdk: ImednetSDK, study_key: str) → str

Return the first active site name for study_key.

Parameters:

  • sdk – Authenticated SDK.

  • study_key – Identifier of the study to query.

Returns:

Name of the first active site.

Raises:

imednet.discovery.NoLiveDataError – When no active sites exist.

site_name = discover_site_name(sdk, study_key)

discover_subject_key

discover_subject_key(sdk: ImednetSDK, study_key: str) → str

Return the first active subject key for study_key.

Parameters:

  • sdk – Authenticated SDK.

  • study_key – Identifier of the study to query.

Returns:

Key for the first active subject.

Raises:

imednet.discovery.NoLiveDataError – When no active subjects exist.

subject_key = discover_subject_key(sdk, study_key)

discover_interval_name

discover_interval_name(sdk: ImednetSDK, study_key: str) → str

Return the first non-disabled interval name for study_key.

Parameters:

  • sdk – Authenticated SDK.

  • study_key – Identifier of the study to query.

Returns:

Name of the first active interval.

Raises:

imednet.discovery.NoLiveDataError – When no active intervals exist.

interval_name = discover_interval_name(sdk, study_key)