imednet.endpoints package¶

Endpoints package for the iMedNet SDK.

This package contains all API endpoint implementations for accessing iMedNet resources.

class imednet.endpoints.AsyncCodingsEndpoint[source]¶

Bases: CodingsOperationDef, EdcAsyncListGetEndpoint[Coding]

Asynchronous endpoint for managing Codings.

class imednet.endpoints.AsyncFormsEndpoint[source]¶

Bases: FormsOperationDef, EdcAsyncListGetEndpoint[Form]

Asynchronous endpoint for managing Forms.

class imednet.endpoints.AsyncIntervalsEndpoint[source]¶

Bases: IntervalsOperationDef, EdcAsyncListGetEndpoint[Interval]

Asynchronous endpoint for managing Intervals.

class imednet.endpoints.AsyncJobsEndpoint[source]¶

Bases: JobsOperationDef, EdcAsyncListGetEndpoint[JobStatus]

Asynchronous endpoint for managing Jobs.

class imednet.endpoints.AsyncQueriesEndpoint[source]¶

Bases: QueriesOperationDef, EdcAsyncListGetEndpoint[Query]

Asynchronous endpoint for managing Queries.

class imednet.endpoints.AsyncRecordRevisionsEndpoint[source]¶

Bases: RecordRevisionsOperationDef, EdcAsyncListGetEndpoint[RecordRevision]

Asynchronous endpoint for managing Record Revisions.

class imednet.endpoints.AsyncRecordsEndpoint[source]¶

Bases: RecordsOperationDef, EdcAsyncListGetEndpoint[Record]

Async API endpoint for interacting with records (eCRF instances).

class imednet.endpoints.AsyncSitesEndpoint[source]¶

Bases: SitesOperationDef, EdcAsyncListGetEndpoint[Site]

Asynchronous endpoint for managing Sites.

class imednet.endpoints.AsyncStudiesEndpoint[source]¶

Bases: StudiesOperationDef, EdcAsyncListGetEndpoint[Study]

Asynchronous endpoint for managing Studies.

class imednet.endpoints.AsyncSubjectsEndpoint[source]¶

Bases: SubjectsOperationDef, EdcAsyncListGetEndpoint[Subject]

Asynchronous endpoint for managing Subjects.

class imednet.endpoints.AsyncUsersEndpoint[source]¶

Bases: UsersOperationDef, EdcAsyncListGetEndpoint[User]

Asynchronous endpoint for managing Users.

class imednet.endpoints.AsyncVariablesEndpoint[source]¶

Bases: VariablesOperationDef, EdcAsyncListGetEndpoint[Variable]

Asynchronous endpoint for managing Variables.

class imednet.endpoints.AsyncVisitsEndpoint[source]¶

Bases: VisitsOperationDef, EdcAsyncListGetEndpoint[Visit]

Asynchronous endpoint for managing Visits.

class imednet.endpoints.CodingsEndpoint[source]¶

Bases: CodingsOperationDef, EdcSyncListGetEndpoint[Coding]

Synchronous endpoint for managing Codings.

class imednet.endpoints.FormsEndpoint[source]¶

Bases: FormsOperationDef, EdcSyncListGetEndpoint[Form]

Synchronous endpoint for managing Forms.

class imednet.endpoints.IntervalsEndpoint[source]¶

Bases: IntervalsOperationDef, EdcSyncListGetEndpoint[Interval]

Synchronous endpoint for managing Intervals.

class imednet.endpoints.JobsEndpoint[source]¶

Bases: JobsOperationDef, EdcSyncListGetEndpoint[JobStatus]

Synchronous endpoint for managing Jobs.

class imednet.endpoints.QueriesEndpoint[source]¶

Bases: QueriesOperationDef, EdcSyncListGetEndpoint[Query]

Synchronous endpoint for managing Queries.

class imednet.endpoints.RecordRevisionsEndpoint[source]¶

Bases: RecordRevisionsOperationDef, EdcSyncListGetEndpoint[RecordRevision]

Synchronous endpoint for managing Record Revisions.

class imednet.endpoints.RecordsEndpoint[source]¶

Bases: RecordsOperationDef, EdcSyncListGetEndpoint[Record]

API endpoint for interacting with records (eCRF instances).

class imednet.endpoints.SitesEndpoint[source]¶

Bases: SitesOperationDef, EdcSyncListGetEndpoint[Site]

Synchronous endpoint for managing Sites.

class imednet.endpoints.StudiesEndpoint[source]¶

Bases: StudiesOperationDef, EdcSyncListGetEndpoint[Study]

Synchronous endpoint for managing Studies.

class imednet.endpoints.SubjectsEndpoint[source]¶

Bases: SubjectsOperationDef, EdcSyncListGetEndpoint[Subject]

Synchronous endpoint for managing Subjects.

class imednet.endpoints.UsersEndpoint[source]¶

Bases: UsersOperationDef, EdcSyncListGetEndpoint[User]

Synchronous endpoint for managing Users.

class imednet.endpoints.VariablesEndpoint[source]¶

Bases: VariablesOperationDef, EdcSyncListGetEndpoint[Variable]

Synchronous endpoint for managing Variables.

class imednet.endpoints.VisitsEndpoint[source]¶

Bases: VisitsOperationDef, EdcSyncListGetEndpoint[Visit]

Synchronous endpoint for managing Visits.

Submodules¶

imednet.endpoints.codings module¶

Endpoint for managing codings (medical coding) in a study.

class imednet.endpoints.codings.AsyncCodingsEndpoint[source]¶

Bases: CodingsOperationDef, EdcAsyncListGetEndpoint[Coding]

Asynchronous endpoint for managing Codings.

class imednet.endpoints.codings.CodingsEndpoint[source]¶

Bases: CodingsOperationDef, EdcSyncListGetEndpoint[Coding]

Synchronous endpoint for managing Codings.

class imednet.endpoints.codings.CodingsOperationDef[source]¶

Bases: object

Definition for Coding operations.

MODEL¶: alias of Coding

imednet.endpoints.forms module¶

Endpoint for managing forms (eCRFs) in a study.

class imednet.endpoints.forms.AsyncFormsEndpoint[source]¶

Bases: FormsOperationDef, EdcAsyncListGetEndpoint[Form]

Asynchronous endpoint for managing Forms.

class imednet.endpoints.forms.FormsEndpoint[source]¶

Bases: FormsOperationDef, EdcSyncListGetEndpoint[Form]

Synchronous endpoint for managing Forms.

class imednet.endpoints.forms.FormsOperationDef[source]¶

Bases: object

Definition for Form operations.

MODEL¶: alias of Form

imednet.endpoints.intervals module¶

Endpoint for managing intervals (visit definitions) in a study.

class imednet.endpoints.intervals.AsyncIntervalsEndpoint[source]¶

Bases: IntervalsOperationDef, EdcAsyncListGetEndpoint[Interval]

Asynchronous endpoint for managing Intervals.

class imednet.endpoints.intervals.IntervalsEndpoint[source]¶

Bases: IntervalsOperationDef, EdcSyncListGetEndpoint[Interval]

Synchronous endpoint for managing Intervals.

class imednet.endpoints.intervals.IntervalsOperationDef[source]¶

Bases: object

Definition for Interval operations.

MODEL¶: alias of Interval

imednet.endpoints.jobs module¶

Endpoint for checking job status in a study.

class imednet.endpoints.jobs.AsyncJobsEndpoint[source]¶

Bases: JobsOperationDef, EdcAsyncListGetEndpoint[JobStatus]

Asynchronous endpoint for managing Jobs.

class imednet.endpoints.jobs.JobsEndpoint[source]¶

Bases: JobsOperationDef, EdcSyncListGetEndpoint[JobStatus]

Synchronous endpoint for managing Jobs.

class imednet.endpoints.jobs.JobsOperationDef[source]¶

Bases: object

Definition for Job operations.

ASYNC_PAGINATOR_CLS¶: alias of AsyncJsonListPaginator

MODEL¶: alias of JobStatus

PAGINATOR_CLS¶: alias of JsonListPaginator

imednet.endpoints.queries module¶

Endpoint for managing queries (dialogue/questions) in a study.

class imednet.endpoints.queries.AsyncQueriesEndpoint[source]¶

Bases: QueriesOperationDef, EdcAsyncListGetEndpoint[Query]

Asynchronous endpoint for managing Queries.

class imednet.endpoints.queries.QueriesEndpoint[source]¶

Bases: QueriesOperationDef, EdcSyncListGetEndpoint[Query]

Synchronous endpoint for managing Queries.

class imednet.endpoints.queries.QueriesOperationDef[source]¶

Bases: object

Definition for Query operations.

MODEL¶: alias of Query

imednet.endpoints.record_revisions module¶

Endpoint for retrieving record revision history in a study.

class imednet.endpoints.record_revisions.AsyncRecordRevisionsEndpoint[source]¶

Bases: RecordRevisionsOperationDef, EdcAsyncListGetEndpoint[RecordRevision]

Asynchronous endpoint for managing Record Revisions.

class imednet.endpoints.record_revisions.RecordRevisionsEndpoint[source]¶

Bases: RecordRevisionsOperationDef, EdcSyncListGetEndpoint[RecordRevision]

Synchronous endpoint for managing Record Revisions.

class imednet.endpoints.record_revisions.RecordRevisionsOperationDef[source]¶

Bases: object

Definition for Record Revision operations.

MODEL¶: alias of RecordRevision

imednet.endpoints.records module¶

Endpoint for managing records (eCRF instances) in a study.

class imednet.endpoints.records.AsyncRecordsEndpoint[source]¶

Bases: RecordsOperationDef, EdcAsyncListGetEndpoint[Record]

Async API endpoint for interacting with records (eCRF instances).

class imednet.endpoints.records.RecordsEndpoint[source]¶

Bases: RecordsOperationDef, EdcSyncListGetEndpoint[Record]

API endpoint for interacting with records (eCRF instances).

class imednet.endpoints.records.RecordsOperationDef[source]¶

Bases: object

Definition for Record operations.

MODEL¶: alias of Record

imednet.endpoints.registry module¶

Registry for all available API endpoints.

This module decouples the endpoint implementations from the main SDK class, allowing for easier extension and maintenance.

imednet.endpoints.sites module¶

Endpoint for managing sites (study locations) in a study.

class imednet.endpoints.sites.AsyncSitesEndpoint[source]¶

Bases: SitesOperationDef, EdcAsyncListGetEndpoint[Site]

Asynchronous endpoint for managing Sites.

class imednet.endpoints.sites.SitesEndpoint[source]¶

Bases: SitesOperationDef, EdcSyncListGetEndpoint[Site]

Synchronous endpoint for managing Sites.

class imednet.endpoints.sites.SitesOperationDef[source]¶

Bases: object

Definition for Site operations.

MODEL¶: alias of Site

imednet.endpoints.studies module¶

Endpoint for managing studies in the iMedNet system.

class imednet.endpoints.studies.AsyncStudiesEndpoint[source]¶

Bases: StudiesOperationDef, EdcAsyncListGetEndpoint[Study]

Asynchronous endpoint for managing Studies.

class imednet.endpoints.studies.StudiesEndpoint[source]¶

Bases: StudiesOperationDef, EdcSyncListGetEndpoint[Study]

Synchronous endpoint for managing Studies.

class imednet.endpoints.studies.StudiesOperationDef[source]¶

Bases: object

Definition for Study operations.

MODEL¶: alias of Study

imednet.endpoints.subjects module¶

Endpoint for managing subjects in a study.

class imednet.endpoints.subjects.AsyncSubjectsEndpoint[source]¶

Bases: SubjectsOperationDef, EdcAsyncListGetEndpoint[Subject]

Asynchronous endpoint for managing Subjects.

class imednet.endpoints.subjects.ListBySiteOperation[source]¶

Bases: object

List by site operation.

__init__(endpoint, study_key, site_id)[source]¶

Initialize.

Parameters:

endpoint (Any) –
study_key (str) –
site_id (str | int) –

async execute_async(client, parse_func=None)[source]¶

Execute async.

Return type:

list[Subject]

Parameters:

client (Any) –
parse_func (Any | None) –

execute_sync(client, parse_func=None)[source]¶

Execute sync.

Return type:

list[Subject]

Parameters:

client (Any) –
parse_func (Any | None) –

class imednet.endpoints.subjects.SubjectsEndpoint[source]¶

Bases: SubjectsOperationDef, EdcSyncListGetEndpoint[Subject]

Synchronous endpoint for managing Subjects.

class imednet.endpoints.subjects.SubjectsOperationDef[source]¶

Bases: object

Definition for Subject operations.

MODEL¶: alias of Subject

imednet.endpoints.users module¶

Endpoint for managing users in a study.

class imednet.endpoints.users.AsyncUsersEndpoint[source]¶

Bases: UsersOperationDef, EdcAsyncListGetEndpoint[User]

Asynchronous endpoint for managing Users.

class imednet.endpoints.users.UsersEndpoint[source]¶

Bases: UsersOperationDef, EdcSyncListGetEndpoint[User]

Synchronous endpoint for managing Users.

class imednet.endpoints.users.UsersOperationDef[source]¶

Bases: object

Definition for User operations.

MODEL¶: alias of User

imednet.endpoints.variables module¶

Endpoint for managing variables (data points on eCRFs) in a study.

class imednet.endpoints.variables.AsyncVariablesEndpoint[source]¶

Bases: VariablesOperationDef, EdcAsyncListGetEndpoint[Variable]

Asynchronous endpoint for managing Variables.

class imednet.endpoints.variables.VariablesEndpoint[source]¶

Bases: VariablesOperationDef, EdcSyncListGetEndpoint[Variable]

Synchronous endpoint for managing Variables.

class imednet.endpoints.variables.VariablesOperationDef[source]¶

Bases: object

Definition for Variable operations.

MODEL¶: alias of Variable

imednet.endpoints.visits module¶

Endpoint for managing visits (interval instances) in a study.

class imednet.endpoints.visits.AsyncVisitsEndpoint[source]¶

Bases: VisitsOperationDef, EdcAsyncListGetEndpoint[Visit]

Asynchronous endpoint for managing Visits.

class imednet.endpoints.visits.VisitsEndpoint[source]¶

Bases: VisitsOperationDef, EdcSyncListGetEndpoint[Visit]

Synchronous endpoint for managing Visits.

class imednet.endpoints.visits.VisitsOperationDef[source]¶

Bases: object

Definition for Visit operations.

MODEL¶: alias of Visit