openapi: 3.0.3 info: title: Huma Platform API version: 1.0.0 description: Huma Platform paths: /.well-known/apple-app-site-association: get: operationId: .well_known_apple_app_site_association_retrieve_[retrieve_deeplink_for_apple_app] description: |- Apple CDN Redirect This is used by Apple CDN to redirect deeplink to ios app. summary: Retrieve Deeplink For Apple App tags: - Misc security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResponseDRF' description: '' /.well-known/assetlinks.json: get: operationId: .well_known_assetlinks.json_retrieve_[retrieve_deeplink_for_android_app] description: |- Android CDN Redirect This is used by Android CDN to redirect deeplink to android app. summary: Retrieve Deeplink For Android App tags: - Misc security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/AndroidAppLinksDRF' description: '' /api/auth/v1/authprofile: post: operationId: api_auth_v1_authprofile_create_[auth_profile] description: |- Retrieve auth profile Retrieve user's auth profile information once they are authenticated. summary: Auth Profile tags: - Auth requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthProfileRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AuthProfileRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/AuthProfileRequestObjectDRF' security: - JWT Auth: [] - jwtAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthProfileResponseObjectDRF' description: '' /api/auth/v1/check-auth-attributes: post: operationId: api_auth_v1_check_auth_attributes_create_[check_auth_attributes] description: |- Check auth attributes Responsible for verifying specific user attributes. summary: Check Auth Attributes tags: - Auth requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckAuthAttributesRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CheckAuthAttributesRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CheckAuthAttributesRequestObjectDRF' required: true security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/CheckAuthAttributesResponseObjectDRF' description: '' /api/auth/v1/confirm: post: operationId: api_auth_v1_confirm_create_[confirmation] description: |- Confirm auth attribute Submitting confirmation of previously requested email or phone number verification summary: Confirmation parameters: - in: header name: userAgent schema: type: string required: true tags: - Auth requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfirmationRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ConfirmationRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ConfirmationRequestObjectDRF' required: true security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConfirmationOutDRF' description: '' /api/auth/v1/me: get: operationId: api_auth_v1_me_retrieve_[me] summary: Me tags: - Auth security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthProfileResponseObjectDRF' description: '' /api/auth/v1/password-reset: post: operationId: api_auth_v1_password_reset_create_[password_reset] description: |- Reset password Reset user password securely with a password reset endpoint. summary: Password Reset tags: - Auth requestBody: content: application/json: schema: $ref: '#/components/schemas/ResetPasswordRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ResetPasswordRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ResetPasswordRequestObjectDRF' required: true security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' /api/auth/v1/private/user/{user_id}/delete-user: delete: operationId: api_auth_v1_private_user_delete_user_destroy_[delete_user] description: |- Delete user Remove user from the system along with all related data. summary: Delete User parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User - Internal security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: {} /api/auth/v1/refreshtoken: post: operationId: api_auth_v1_refreshtoken_create_[refresh_token_v1] description: |- Refresh token Refresh user authentication tokens securely for prolonged user sessions without requiring reauthentication. summary: Refresh Token V1 parameters: - in: header name: userAgent schema: type: string required: true tags: - Auth requestBody: content: application/json: schema: $ref: '#/components/schemas/RefreshTokenRequestObjectV1DRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RefreshTokenRequestObjectV1DRF' multipart/form-data: schema: $ref: '#/components/schemas/RefreshTokenRequestObjectV1DRF' required: true security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/RefreshTokenResponseObjectDRF' description: '' /api/auth/v1/request-code: post: operationId: api_auth_v1_request_code_create_[request_code] description: |- Sign in request code Responsible for sending a verification code to the user for authentication. summary: Request Code parameters: - in: header name: userAgent schema: type: string required: true tags: - Auth requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestSignupCodeRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RequestSignupCodeRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RequestSignupCodeRequestObjectDRF' required: true security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' /api/auth/v1/request-password-reset: post: operationId: api_auth_v1_request_password_reset_create_[request_password_reset] description: |- Request password reset Initiate a secure password reset process for user, ensuring account security and access restoration. summary: Request Password Reset tags: - Auth requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestPasswordResetRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RequestPasswordResetRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RequestPasswordResetRequestObjectDRF' required: true security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' /api/auth/v1/sendverificationtoken: post: operationId: api_auth_v1_sendverificationtoken_create_[send_verification_token] description: |- Send verification token Send verification token for user confirmation of certain auth attributes or sign in. summary: Send Verification Token tags: - Auth requestBody: content: application/json: schema: $ref: '#/components/schemas/SendVerificationTokenRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SendVerificationTokenRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/SendVerificationTokenRequestObjectDRF' required: true security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/SendVerificationTokenResponseObjectDRF' description: '' /api/auth/v1/service-account: post: operationId: api_auth_v1_service_account_create_[create_service_account] description: |- Create service account Create a service account to enable secure access and interaction between applications, services, or systems, facilitating automation and integration tasks. summary: Create Service Account tags: - Auth requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateServiceAccountRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateServiceAccountRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateServiceAccountRequestObjectDRF' required: true security: - {} responses: '201': content: application/json: schema: $ref: '#/components/schemas/GenerateAuthKeysResponseObjectDRF' description: '' /api/auth/v1/set-auth-attributes: post: operationId: api_auth_v1_set_auth_attributes_create_[set_auth_attributes] description: |- Set auth attributes Responsible for assigning or updating specific attributes or permissions associated with an authenticated user. summary: Set Auth Attributes tags: - Auth requestBody: content: application/json: schema: $ref: '#/components/schemas/SetAuthAttributesRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SetAuthAttributesRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/SetAuthAttributesRequestObjectDRF' required: true security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/SetAuthAttributesResponseObjectDRF' description: '' /api/auth/v1/signin: post: operationId: api_auth_v1_signin_create_[sign_in_v1] description: |- Sign in Responsible for authenticating users and providing access to secure resources. summary: Sign In V1 parameters: - in: header name: userAgent schema: type: string required: true tags: - Auth requestBody: content: application/json: schema: $ref: '#/components/schemas/SignInRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SignInRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/SignInRequestObjectDRF' required: true security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/SignInResponseObjectDRF' description: '' /api/auth/v1/signout: post: operationId: api_auth_v1_signout_create_[sign_out_v1] description: |- Sign out Responsible for ending a user's session and logging them out of the application. summary: Sign Out V1 parameters: - in: header name: userAgent schema: type: string required: true tags: - Auth requestBody: content: application/json: schema: $ref: '#/components/schemas/SignOutRequestObjectV1DRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SignOutRequestObjectV1DRF' multipart/form-data: schema: $ref: '#/components/schemas/SignOutRequestObjectV1DRF' required: true security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/auth/v1/signup: post: operationId: api_auth_v1_signup_create_[sign_up] description: |- Sign up Register new users securely with sign-up endpoint. summary: Sign Up tags: - Auth requestBody: content: application/json: schema: $ref: '#/components/schemas/SignUpRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SignUpRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/SignUpRequestObjectDRF' required: true security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/SignInResponseObjectDRF' description: '' /api/auth/v1/sso/callback: post: operationId: api_auth_v1_sso_callback_create_[saml_callback] summary: Saml Callback tags: - Auth requestBody: content: application/json: schema: $ref: '#/components/schemas/SAMLCallbackObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SAMLCallbackObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/SAMLCallbackObjectDRF' required: true security: - {} responses: '200': description: No response body /api/auth/v1/sso/oidc-callback: get: operationId: api_auth_v1_sso_oidc_callback_retrieve_[oidc_callback] summary: Oidc Callback parameters: - in: query name: authStage schema: type: string - in: query name: callbackData schema: type: string - in: query name: clientId schema: type: string required: true - in: query name: confirmationCode schema: type: string - in: query name: contactEmail schema: type: string - in: query name: deviceAgent schema: type: string - in: query name: displayName schema: type: string - in: query name: email schema: type: string - in: query name: ipAddress schema: type: string required: true - in: query name: language schema: type: string - in: query name: method schema: type: integer - in: query name: password schema: type: string - in: query name: phoneNumber schema: type: string - in: query name: projectId schema: type: string required: true - in: query name: refreshToken schema: type: string - in: query name: ssoEnabled schema: type: boolean - in: query name: timezone schema: type: string - in: query name: userAttributes schema: type: string - in: query name: userId schema: type: string - in: query name: validationData schema: type: string tags: - Auth security: - {} responses: '200': description: No response body /api/auth/v1/sso/request: post: operationId: api_auth_v1_sso_request_create_[sso_request] summary: Sso Request tags: - Auth requestBody: content: application/json: schema: $ref: '#/components/schemas/SsoRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SsoRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/SsoRequestObjectDRF' required: true security: - {} responses: '200': description: No response body /api/auth/v1/user/{user_id}/api-key: get: operationId: api_auth_v1_user_api_key_retrieve_[retrieve_api_keys] description: |- Retrieve API Keys Retrieve a list of API keys that are associated with a user. summary: Retrieve Api Keys parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Auth security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListAuthKeysResponseObjectDRF' description: '' post: operationId: api_auth_v1_user_api_key_create_[generate_api_key] description: |- Generate API key Generate API keys securely to authorize access to protected resources and validate user identity. summary: Generate Api Key parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Auth requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateAuthKeysRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GenerateAuthKeysRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/GenerateAuthKeysRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/GenerateAuthKeysResponseObjectDRF' description: '' /api/auth/v1/user/{user_id}/api-key/{key_id}: delete: operationId: api_auth_v1_user_api_key_destroy_[delete_api_key] description: |- Delete API Keys Delete specified API key of a User. summary: Delete Api Key parameters: - in: path name: key_id schema: type: string required: true - in: path name: user_id schema: type: string required: true tags: - Auth security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' /api/auth/v1/user/{user_id}/sessions: get: operationId: api_auth_v1_user_sessions_retrieve_[retrieve_sessions] description: |- Retrieve sessions Retrieve active user sessions to monitor logged-in devices. summary: Retrieve Sessions parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Auth security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceSessionDTODRF' description: '' /api/auth/v1/user/{user_id}/token: post: operationId: api_auth_v1_user_token_create_[generate_auth_token] description: |- Generate auth token Generate Hawk authentication tokens securely to authorize access to protected resources and validate user identity. summary: Generate Auth Token parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Auth security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/GenerateAuthKeysResponseObjectDRF' description: '' /api/auth/v1/verify: post: operationId: api_auth_v1_verify_create_[verify_credentials] description: |- Verify credentials Verify user credentials like phone number or password securely to authenticate access and ensure authorized usage of the system. summary: Verify Credentials tags: - Auth requestBody: content: application/json: schema: $ref: '#/components/schemas/VerifyCredentialsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/VerifyCredentialsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/VerifyCredentialsRequestObjectDRF' required: true security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' /api/autocomplete/v1/AZVaccineBatchNumber/search: get: operationId: api_autocomplete_v1_AZVaccineBatchNumber_search_retrieve_[func] description: Retrieve Autocomplete AZVaccineBatchNumber summary: Func parameters: - in: query name: exactWord schema: type: boolean - in: query name: language schema: type: string - in: header name: language schema: type: string - in: query name: limit schema: type: integer - in: query name: listEndpointId schema: type: string - in: query name: region schema: type: string - in: query name: search schema: type: string required: true - in: query name: skip schema: type: integer tags: - Autocomplete security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AZVaccineBatchNumberAutocompleteResponseDRF' description: '' /api/autocomplete/v1/Indications/search: get: operationId: api_autocomplete_v1_Indications_search_retrieve_[func] description: Retrieve Autocomplete Indications summary: Func parameters: - in: query name: exactWord schema: type: boolean - in: query name: language schema: type: string - in: header name: language schema: type: string - in: query name: limit schema: type: integer - in: query name: listEndpointId schema: type: string - in: query name: region schema: type: string - in: query name: search schema: type: string required: true - in: query name: skip schema: type: integer tags: - Autocomplete security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IndicationsAutocompleteResponseDRF' description: '' /api/autocomplete/v1/Medications/search: get: operationId: api_autocomplete_v1_Medications_search_retrieve_[func] description: Retrieve Autocomplete Medications summary: Func parameters: - in: query name: exactWord schema: type: boolean - in: query name: language schema: type: string - in: header name: language schema: type: string - in: query name: limit schema: type: integer - in: query name: listEndpointId schema: type: string - in: query name: region schema: type: string - in: query name: search schema: type: string required: true - in: query name: skip schema: type: integer tags: - Autocomplete security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MedicationsAutocompleteResponseDRF' description: '' /api/autocomplete/v1/MedicationsV2/search: get: operationId: api_autocomplete_v1_MedicationsV2_search_retrieve_[func] description: Retrieve Autocomplete MedicationsV2 summary: Func parameters: - in: query name: exactWord schema: type: boolean - in: query name: language schema: type: string - in: header name: language schema: type: string - in: query name: limit schema: type: integer - in: query name: listEndpointId schema: type: string - in: query name: region schema: type: string - in: query name: search schema: type: string required: true - in: query name: skip schema: type: integer tags: - Autocomplete security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MedicationsV2AutocompleteResponseDRF' description: '' /api/autocomplete/v1/Symptoms/search: get: operationId: api_autocomplete_v1_Symptoms_search_retrieve_[func] description: Retrieve Autocomplete Symptoms summary: Func parameters: - in: query name: exactWord schema: type: boolean - in: query name: language schema: type: string - in: header name: language schema: type: string - in: query name: limit schema: type: integer - in: query name: listEndpointId schema: type: string - in: query name: region schema: type: string - in: query name: search schema: type: string required: true - in: query name: skip schema: type: integer tags: - Autocomplete security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SymptomsAutocompleteResponseDRF' description: '' /api/autocomplete/v1/update: post: operationId: api_autocomplete_v1_update_create_[update_autocomplete_metadata] summary: Update Autocomplete Metadata tags: - Autocomplete requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAutoCompleteSearchMetadataRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateAutoCompleteSearchMetadataRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateAutoCompleteSearchMetadataRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/calendar/v1/render/test: get: operationId: api_calendar_v1_render_test_retrieve_[test_calendar] summary: Test Calendar parameters: - in: query name: userId schema: type: string tags: - Calendar Route security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/calendar/v1/user/{user_id}/export: get: operationId: api_calendar_v1_user_export_retrieve_[export_calendar] summary: Export Calendar parameters: - in: query name: end schema: type: string format: date-time - in: query name: start schema: type: string format: date-time - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Calendar Route security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/care-plan/v1/user/{user_id}/care-plan: get: operationId: api_care_plan_v1_user_care_plan_retrieve_[retrieve_care_plan] description: Retrieve the care plan for the user. summary: Retrieve Care Plan parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Servier Care Plan security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CarePlanResponseObjectDRF' description: '' post: operationId: api_care_plan_v1_user_care_plan_create_[assign_care_plan] summary: Assign Care Plan parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Servier Care Plan requestBody: content: application/json: schema: $ref: '#/components/schemas/AssignCarePlanRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AssignCarePlanRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/AssignCarePlanRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/care-plan/v1/user/{user_id}/cycler/mock: post: operationId: api_care_plan_v1_user_cycler_mock_create_[mock_adp_cycler_data] description: Mock ADP Cycler data for testing purposes. summary: Mock Adp Cycler Data parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Servier Care Plan requestBody: content: application/json: schema: $ref: '#/components/schemas/MockADPCyclerDataRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MockADPCyclerDataRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/MockADPCyclerDataRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' /api/care-plan/v1/user/{user_id}/prescription: post: operationId: api_care_plan_v1_user_prescription_create_[create_prescription] summary: Create Prescription parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Servier Care Plan requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePrescriptionRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreatePrescriptionRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreatePrescriptionRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/care-plan/v1/user/{user_id}/prescriptions: get: operationId: api_care_plan_v1_user_prescriptions_retrieve_[retrieve_prescriptions] description: Retrieve the prescriptions for the user. summary: Retrieve Prescriptions parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Servier Care Plan security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PrescriptionsResponseObjectDRF' description: '' /api/cds/v1/user/{user_id}/pregnancy: post: operationId: api_cds_v1_user_pregnancy_create_[update_pregnancy_info] summary: Update Pregnancy Info parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Roche CDS requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePregnancyRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdatePregnancyRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdatePregnancyRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/firmware-bank/archive: post: operationId: api_extensions_firmware_bank_archive_create_[archive_firmware] summary: Archive Firmware tags: - Firmware Bank requestBody: content: application/json: schema: $ref: '#/components/schemas/ArchiveFirmwareRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ArchiveFirmwareRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ArchiveFirmwareRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '207': content: application/json: schema: $ref: '#/components/schemas/ArchiveFirmwareResponseObjectDRF' description: '' /api/extensions/firmware-bank/list: get: operationId: api_extensions_firmware_bank_list_retrieve_[retrieve_firmware_updates] summary: Retrieve Firmware Updates parameters: - in: query name: make schema: type: string required: true - in: query name: minVersion schema: type: string required: true - in: query name: model schema: type: string required: true tags: - Firmware Bank security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FirmwareUpdateResponseObjectDRF' description: '' /api/extensions/firmware-bank/upload: post: operationId: api_extensions_firmware_bank_upload_create_[upload_firmware] summary: Upload Firmware tags: - Firmware Bank requestBody: content: application/json: schema: $ref: '#/components/schemas/UploadFirmwareRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UploadFirmwareRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UploadFirmwareRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/UploadFirmwareResponseObjectDRF' description: '' /api/extensions/template-bank/create: post: operationId: api_extensions_template_bank_create_create_[shared_templates_bank_create] description: |- Create Shared Template Add a new shared template in the template bank. summary: Shared Templates Bank Create tags: - Template Bank requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTemplateRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateTemplateRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateTemplateRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SharedTemplateFileDRF' description: '' /api/extensions/template-bank/import: post: operationId: api_extensions_template_bank_import_create_[import_template_deployment_config] description: |- Import Template Deployment Config Import a template deployment configuration from the template bank. summary: Import Template Deployment Config tags: - Template Bank requestBody: content: application/json: schema: $ref: '#/components/schemas/TemplateImportDeploymentConfigRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TemplateImportDeploymentConfigRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/TemplateImportDeploymentConfigRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/template-bank/list: get: operationId: api_extensions_template_bank_list_retrieve_[shared_templates_bank_list] description: |- List Shared Templates Retrieve a list of shared templates from the template bank. summary: Shared Templates Bank List parameters: - in: query name: organizationId schema: type: string required: true tags: - Template Bank security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveSharedTemplateBankResponseDRF' description: '' /api/extensions/template-bank/remove: post: operationId: api_extensions_template_bank_remove_create_[remove_template_deployment_config] description: |- Remove Shared Template Delete a shared template from the template bank. summary: Remove Template Deployment Config tags: - Template Bank requestBody: content: application/json: schema: $ref: '#/components/schemas/TemplateIdRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TemplateIdRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/TemplateIdRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IndexFileContentResponseDRF' description: '' /api/extensions/v1/admin/deployment/{deployment_id}/demo-url: get: operationId: api_extensions_v1_admin_deployment_demo_url_retrieve_[get_demo_user_url] summary: Get Demo User Url parameters: - in: path name: deploymentId schema: type: string required: true - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: submitter schema: type: string required: true tags: - Authorization Admin security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UrlResponseDRF' description: '' /api/extensions/v1/admin/deployment/{deployment_id}/reset-demo-user: post: operationId: api_extensions_v1_admin_deployment_reset_demo_user_create_[reset_demo_user_url] summary: Reset Demo User Url parameters: - in: path name: deploymentId schema: type: string required: true - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: submitter schema: type: string required: true tags: - Authorization Admin security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UrlResponseDRF' description: '' /api/extensions/v1/admin/invites: get: operationId: api_extensions_v1_admin_invites_retrieve_[retrieve_invites] description: Retrieve Admin Invitations summary: Retrieve Invites parameters: - in: query name: limit schema: type: integer - in: query name: organizationIds schema: type: string - in: query name: search schema: type: string - in: query name: skip schema: type: integer tags: - Authorization Admin security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveAdminInvitesResponseObjectDRF' description: '' post: operationId: api_extensions_v1_admin_invites_create_[invite] description: |- Bulk Admin Invite This enpoint is an advanced version of the Invite Admin Staff endpoint. It allows to send invitation to multiple resources at once. summary: Invite tags: - Authorization Admin requestBody: content: application/json: schema: $ref: '#/components/schemas/InviteAdminRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/InviteAdminRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/InviteAdminRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InviteResponseObjectDRF' description: '' /api/extensions/v1/admin/send-invitation: post: operationId: api_extensions_v1_admin_send_invitation_create_[send_admin_invitations] description: Send Admin Invitations summary: Send Admin Invitations tags: - Authorization Admin requestBody: content: application/json: schema: $ref: '#/components/schemas/SendAdminInvitationsRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SendAdminInvitationsRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/SendAdminInvitationsRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SendInvitationsResponseObjectDRF' description: '' /api/extensions/v1/admin/service-account: post: operationId: api_extensions_v1_admin_service_account_create_[generate_service_account_api_key] description: |- Generate usr service account Generate a service account with an API key for the user, without requiring user interaction, facilitating automated tasks and integrations. summary: Generate Service Account Api Key tags: - Authorization Admin requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUserServiceAccountRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateUserServiceAccountRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateUserServiceAccountRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/GenerateAuthKeysResponseObjectDRF' description: '' delete: operationId: api_extensions_v1_admin_service_account_destroy_[delete_user_service_account] description: Delete a service account of a user summary: Delete User Service Account tags: - Authorization Admin security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' /api/extensions/v1/admin/staff: get: operationId: api_extensions_v1_admin_staff_retrieve_[search_staff] summary: Search Staff parameters: - in: query name: limit schema: type: integer - in: query name: organizationIds schema: type: string - in: query name: search schema: type: string - in: query name: skip schema: type: integer tags: - Authorization Admin security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SearchAdminStaffResponseObjectDRF' description: '' /api/extensions/v1/assets: post: operationId: api_extensions_v1_assets_create_[create_content] summary: Create Content tags: - Assets requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateContentRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateContentRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateContentRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateContentResponseObjectDRF' description: '' /api/extensions/v1/assets/{content_id}: get: operationId: api_extensions_v1_assets_retrieve_[retrieve_content] summary: Retrieve Content parameters: - in: path name: authzUser schema: type: string required: true - in: path name: collection schema: type: string required: true - in: path name: contentId schema: type: string required: true - in: path name: content_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Assets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CMSContentDTODRF' description: '' put: operationId: api_extensions_v1_assets_update_[update_content] summary: Update Content parameters: - in: path name: content_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Assets requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateContentRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateContentRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateContentRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdateContentRequestObjectDRF' description: '' delete: operationId: api_extensions_v1_assets_destroy_[delete_content] summary: Delete Content parameters: - in: path name: authzUser schema: type: string required: true - in: path name: collection schema: type: string required: true - in: path name: contentId schema: type: string required: true - in: path name: content_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Assets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/assets/schema: get: operationId: api_extensions_v1_assets_schema_retrieve_[retrieve_schema] summary: Retrieve Schema tags: - Assets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveSchemaResponseDRF' description: '' /api/extensions/v1/assets/search: post: operationId: api_extensions_v1_assets_search_create_[search_content] summary: Search Content tags: - Assets requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchContentRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SearchContentRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/SearchContentRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SearchContentResponseObjectDRF' description: '' /api/extensions/v1/billing/log-actions: get: operationId: api_extensions_v1_billing_log_actions_retrieve_[retrieve_billing_monitoring_log_action_list] summary: Retrieve Billing Monitoring Log Action List tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/billing/profiles: post: operationId: api_extensions_v1_billing_profiles_create_[retrieve_billing_alerts] summary: Retrieve Billing Alerts tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/billing/user/{user_id}: get: operationId: api_extensions_v1_billing_user_retrieve_[calculate_cumulative_monitoring_time_and_cpt_code] summary: Calculate Cumulative Monitoring Time And Cpt Code parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CalculateCumulativeMonitoringTimeResponseObjectDRF' description: '' post: operationId: api_extensions_v1_billing_user_create_[create_billing_remote_time_tracking] summary: Create Billing Remote Time Tracking parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBillingRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateBillingRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateBillingRequestBodyDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CalculateCumulativeMonitoringTimeResponseObjectDRF' description: '' /api/extensions/v1/billing/user/{user_id}/log: post: operationId: api_extensions_v1_billing_user_log_create_[create_billing_monitoring_log] summary: Create Billing Monitoring Log parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/billing/user/{user_id}/log/{log_id}: put: operationId: api_extensions_v1_billing_user_log_update_[update_billing_monitoring_log] summary: Update Billing Monitoring Log parameters: - in: path name: log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body delete: operationId: api_extensions_v1_billing_user_log_destroy_[delete_billing_monitoring_log] summary: Delete Billing Monitoring Log parameters: - in: path name: log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/billing/user/{user_id}/logs: post: operationId: api_extensions_v1_billing_user_logs_create_[retrieve_billing_monitoring_logs] summary: Retrieve Billing Monitoring Logs parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveBillingMonitoringLogsRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveBillingMonitoringLogsRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveBillingMonitoringLogsRequestBodyDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingMonitoringLogsResponseObjectDRF' description: '' /api/extensions/v1/billing/user/{user_id}/report: get: operationId: api_extensions_v1_billing_user_report_retrieve_[report_billing_records_for_cpt] summary: Report Billing Records For Cpt parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CPTReportResponseObjectDRF' description: '' /api/extensions/v1/cms/{collection}: post: operationId: api_extensions_v1_cms_create_[create_content] summary: Create Content parameters: - in: path name: collection schema: type: string required: true tags: - CMS requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateContentRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateContentRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateContentRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateContentResponseObjectDRF' description: '' /api/extensions/v1/cms/{collection}/{content_id}: get: operationId: api_extensions_v1_cms_retrieve_[retrieve_content] summary: Retrieve Content parameters: - in: path name: authzUser schema: type: string required: true - in: path name: collection schema: type: string required: true - in: path name: contentId schema: type: string required: true - in: path name: content_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - CMS security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CMSContentDTODRF' description: '' put: operationId: api_extensions_v1_cms_update_[update_content] summary: Update Content parameters: - in: path name: collection schema: type: string required: true - in: path name: content_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - CMS requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateContentRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateContentRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateContentRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdateContentRequestObjectDRF' description: '' delete: operationId: api_extensions_v1_cms_destroy_[delete_content] summary: Delete Content parameters: - in: path name: authzUser schema: type: string required: true - in: path name: collection schema: type: string required: true - in: path name: contentId schema: type: string required: true - in: path name: content_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - CMS security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/cms/{collection}/{content_id}/{version}: get: operationId: api_extensions_v1_cms_retrieve_[retrieve_content_version] summary: Retrieve Content Version parameters: - in: path name: authzUser schema: type: string required: true - in: path name: collection schema: type: string required: true - in: path name: contentId schema: type: string required: true - in: path name: content_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: version schema: type: integer required: true tags: - CMS security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CMSContentDTODRF' description: '' /api/extensions/v1/cms/{collection}/{content_id}/publish: post: operationId: api_extensions_v1_cms_publish_create_[publish_draft] summary: Publish Draft parameters: - in: path name: authzUser schema: type: string required: true - in: path name: collection schema: type: string required: true - in: path name: contentId schema: type: string required: true - in: path name: content_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: publisherId schema: type: string required: true tags: - CMS security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/cms/{collection}/schema: get: operationId: api_extensions_v1_cms_schema_retrieve_[retrieve_schema] summary: Retrieve Schema parameters: - in: path name: collection schema: type: string required: true tags: - CMS security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveSchemaResponseDRF' description: '' /api/extensions/v1/cms/{collection}/search: post: operationId: api_extensions_v1_cms_search_create_[search_content] summary: Search Content parameters: - in: path name: collection schema: type: string required: true tags: - CMS requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchContentRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SearchContentRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/SearchContentRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SearchContentResponseObjectDRF' description: '' /api/extensions/v1/cms/{collection}/tags: get: operationId: api_extensions_v1_cms_tags_retrieve_[retrieve_collection_tags] summary: Retrieve Collection Tags parameters: - in: path name: collection schema: type: string required: true tags: - CMS security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TagsListResponseDRF' description: '' /api/extensions/v1/cms/collections: get: operationId: api_extensions_v1_cms_collections_retrieve_[list_collections] summary: List Collections tags: - CMS security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListCollectionsResponseDRF' description: '' /api/extensions/v1/dashboards/{resource_type}/{resource_id}: get: operationId: api_extensions_v1_dashboards_retrieve_[retrieve_dashboards] summary: Retrieve Dashboards parameters: - in: path name: resource_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: resource_type schema: type: string required: true tags: - Dashboard security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardDRF' description: '' /api/extensions/v1/dashboards/{resource_type}/{resource_id}/dashboard/{dashboard_id}: get: operationId: api_extensions_v1_dashboards_dashboard_retrieve_[retrieve_dashboard] summary: Retrieve Dashboard parameters: - in: path name: dashboard_id schema: type: string required: true - in: path name: resource_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: resource_type schema: type: string required: true tags: - Dashboard security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardDRF' description: '' /api/extensions/v1/dashboards/{resource_type}/{resource_id}/gadget/{gadget_id}/data: post: operationId: api_extensions_v1_dashboards_gadget_data_create_[retrieve_gadget_data] summary: Retrieve Gadget Data parameters: - in: path name: gadget_id schema: type: string required: true - in: path name: resource_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: resource_type schema: type: string required: true tags: - Dashboard requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveGadgetDataRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveGadgetDataRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveGadgetDataRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/dashboards/data: post: operationId: api_extensions_v1_dashboards_data_create_[multi_resource_dashboard_data] summary: Multi Resource Dashboard Data tags: - Dashboard requestBody: content: application/json: schema: $ref: '#/components/schemas/MultiResourceDashboardDataRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MultiResourceDashboardDataRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/MultiResourceDashboardDataRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/dashboards/deployment/{deployment_id}/stats: get: operationId: api_extensions_v1_dashboards_deployment_stats_retrieve_[retrieve_deployment_stats] summary: Retrieve Deployment Stats parameters: - in: query name: deploymentId schema: type: string required: true - in: path name: deployment_id schema: type: string required: true - in: query name: endDateTime schema: type: string format: date-time - in: query name: startDateTime schema: type: string format: date-time tags: - Dashboard security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeploymentStatsResponseObjectDRF' description: '' /api/extensions/v1/deployment: post: operationId: api_extensions_v1_deployment_create_[create_deployment] summary: Create Deployment tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDeploymentRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateDeploymentRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateDeploymentRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}: get: operationId: api_extensions_v1_deployment_retrieve_[retrieve_deployment] summary: Retrieve Deployment parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeploymentResponseObjectDRF' description: '' put: operationId: api_extensions_v1_deployment_update_[update_deployment] summary: Update Deployment parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDeploymentRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateDeploymentRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateDeploymentRequestBodyDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/component-config: post: operationId: api_extensions_v1_deployment_component_config_create_[create_component_config] summary: Create Component Config parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/ComponentConfigRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ComponentConfigRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/ComponentConfigRequestBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': description: No response body put: operationId: api_extensions_v1_deployment_component_config_update_[update_component_config] summary: Update Component Config parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/ComponentConfigRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ComponentConfigRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/ComponentConfigRequestBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/deployment/{deployment_id}/component-config/{component_name}: delete: operationId: api_extensions_v1_deployment_component_config_destroy_[delete_component_config] summary: Delete Component Config parameters: - in: path name: component_name schema: type: string required: true - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/deployment/{deployment_id}/consent: get: operationId: api_extensions_v1_deployment_consent_retrieve_[retrieve_latest_consent] summary: Retrieve Latest Consent parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsentResponseObjectDRF' description: '' post: operationId: api_extensions_v1_deployment_consent_create_[create_consent] summary: Create Consent parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateConsentRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateConsentRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateConsentRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/devices: get: operationId: api_extensions_v1_deployment_devices_retrieve_[list_deployment_devices] summary: List Deployment Devices parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceCategoriesDRF' description: '' post: operationId: api_extensions_v1_deployment_devices_create_[update_deployment_devices] summary: Update Deployment Devices parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceConnectionIdDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DeviceConnectionIdDRF' multipart/form-data: schema: $ref: '#/components/schemas/DeviceConnectionIdDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceConnectionIdDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/econsent: get: operationId: api_extensions_v1_deployment_econsent_retrieve_[retrieve_latest_econsent] summary: Retrieve Latest Econsent parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EConsentResponseObjectDRF' description: '' post: operationId: api_extensions_v1_deployment_econsent_create_[create_econsent] summary: Create Econsent parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEConsentRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateEConsentRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateEConsentRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/encrypt: post: operationId: api_extensions_v1_deployment_encrypt_create_[encrypt_value] summary: Encrypt Value parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/EncryptValueRequestObjectBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/EncryptValueRequestObjectBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/EncryptValueRequestObjectBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EncryptValueResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/export/localizations: post: operationId: api_extensions_v1_deployment_export_localizations_create_[export_deployment_localizations] summary: Export Deployment Localizations parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveLocalizationsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveLocalizationsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveLocalizationsRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/deployment/{deployment_id}/generate-master-translation: post: operationId: api_extensions_v1_deployment_generate_master_translation_create_[generate_master_translation] summary: Generate Master Translation parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GenerateMasterTranslationsResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/import/localizations: post: operationId: api_extensions_v1_deployment_import_localizations_create_[import_deployment_localizations] summary: Import Deployment Localizations parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportLocalizationsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ImportLocalizationsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ImportLocalizationsRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/key-action: post: operationId: api_extensions_v1_deployment_key_action_create_[create_key_action_config] summary: Create Key Action Config parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateKeyActionConfigRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateKeyActionConfigRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateKeyActionConfigRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/key-action/{key_action_id}: put: operationId: api_extensions_v1_deployment_key_action_update_[update_key_action_config] summary: Update Key Action Config parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: key_action_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateKeyActionConfigRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateKeyActionConfigRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateKeyActionConfigRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' delete: operationId: api_extensions_v1_deployment_key_action_destroy_[delete_key_action_config] summary: Delete Key Action Config parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: key_action_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/deployment/{deployment_id}/key-actions: post: operationId: api_extensions_v1_deployment_key_actions_create_[retrieve_deployment_key_actions] summary: Retrieve Deployment Key Actions parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveDeploymentKeyActionsRequestObjectBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveDeploymentKeyActionsRequestObjectBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveDeploymentKeyActionsRequestObjectBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveDeploymentKeyActionsResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/labels: get: operationId: api_extensions_v1_deployment_labels_retrieve_[retrieve_deployment_labels] summary: Retrieve Deployment Labels parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveDeploymentLabelsResponseObjectDRF' description: '' post: operationId: api_extensions_v1_deployment_labels_create_[create_deployment_labels] summary: Create Deployment Labels parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLabelsRequestObjectBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateLabelsRequestObjectBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateLabelsRequestObjectBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/labels/{label_id}: put: operationId: api_extensions_v1_deployment_labels_update_[update_deployment_labels] summary: Update Deployment Labels parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: label_id schema: type: string required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateLabelRequestObjectBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateLabelRequestObjectBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateLabelRequestObjectBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' delete: operationId: api_extensions_v1_deployment_labels_destroy_[delete_deployment_label] summary: Delete Deployment Label parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: label_id schema: type: string required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/deployment/{deployment_id}/learn-section: post: operationId: api_extensions_v1_deployment_learn_section_create_[create_learn_section] summary: Create Learn Section parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLearnSectionRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateLearnSectionRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateLearnSectionRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}: put: operationId: api_extensions_v1_deployment_learn_section_update_[update_learn_section] summary: Update Learn Section parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: section_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/LearnSectionDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/LearnSectionDRF' multipart/form-data: schema: $ref: '#/components/schemas/LearnSectionDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' delete: operationId: api_extensions_v1_deployment_learn_section_destroy_[delete_learn_section] summary: Delete Learn Section parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: section_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article: post: operationId: api_extensions_v1_deployment_learn_section_article_create_[create_article] summary: Create Article parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: section_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLearnArticleRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateLearnArticleRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateLearnArticleRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article/{article_id}: put: operationId: api_extensions_v1_deployment_learn_section_article_update_[update_article] summary: Update Article parameters: - in: path name: article_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: section_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/LearnArticleDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/LearnArticleDRF' multipart/form-data: schema: $ref: '#/components/schemas/LearnArticleDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' delete: operationId: api_extensions_v1_deployment_learn_section_article_destroy_[delete_article] summary: Delete Article parameters: - in: path name: article_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: section_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article/reorder: put: operationId: api_extensions_v1_deployment_learn_section_article_reorder_update_[reorder_learn_articles] summary: Reorder Learn Articles parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: section_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderUpdateObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OrderUpdateObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/OrderUpdateObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/learn-section/reorder: put: operationId: api_extensions_v1_deployment_learn_section_reorder_update_[reorder_learn_sections] summary: Reorder Learn Sections parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderUpdateObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OrderUpdateObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/OrderUpdateObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/localizable-fields: get: operationId: api_extensions_v1_deployment_localizable_fields_retrieve_[retrieve_localizable_fields] summary: Retrieve Localizable Fields parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveLocalizableFieldsResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/module-config: post: operationId: api_extensions_v1_deployment_module_config_create_[create_module_config] summary: Create Module Config parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateModuleConfigRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateModuleConfigRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateModuleConfigRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' put: operationId: api_extensions_v1_deployment_module_config_update_[update_module_config] summary: Update Module Config parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateModuleConfigRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateModuleConfigRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateModuleConfigRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/module-config/{module_config_id}: delete: operationId: api_extensions_v1_deployment_module_config_destroy_[delete_module_config] summary: Delete Module Config parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: module_config_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/deployment/{deployment_id}/module-config/reorder: put: operationId: api_extensions_v1_deployment_module_config_reorder_update_[reorder_module_configs] summary: Reorder Module Configs parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderUpdateObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OrderUpdateObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/OrderUpdateObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/module-configs: post: operationId: api_extensions_v1_deployment_module_configs_create_[create_module_configs] summary: Create Module Configs parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMultipleModuleConfigsRequestObjectBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateMultipleModuleConfigsRequestObjectBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateMultipleModuleConfigsRequestObjectBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/onboarding-module-config: post: operationId: api_extensions_v1_deployment_onboarding_module_config_create_[create_onboarding_module_config] summary: Create Onboarding Module Config parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/OnboardingModuleConfigDTODRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OnboardingModuleConfigDTODRF' multipart/form-data: schema: $ref: '#/components/schemas/OnboardingModuleConfigDTODRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' put: operationId: api_extensions_v1_deployment_onboarding_module_config_update_[update_onboarding_module_config] summary: Update Onboarding Module Config parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/OnboardingModuleConfigDTODRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OnboardingModuleConfigDTODRF' multipart/form-data: schema: $ref: '#/components/schemas/OnboardingModuleConfigDTODRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/onboarding-module-config/{onboarding_id}: delete: operationId: api_extensions_v1_deployment_onboarding_module_config_destroy_[delete_onboarding_module_config] summary: Delete Onboarding Module Config parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: onboarding_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/deployment/{deployment_id}/onboarding-module-config/reorder: put: operationId: api_extensions_v1_deployment_onboarding_module_config_reorder_update_[reorder_onboarding_module_configs] summary: Reorder Onboarding Module Configs parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderUpdateObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OrderUpdateObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/OrderUpdateObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/role: put: operationId: api_extensions_v1_deployment_role_update_[create_or_update_roles] summary: Create Or Update Roles parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/DeploymentRoleUpdateObjectBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DeploymentRoleUpdateObjectBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/DeploymentRoleUpdateObjectBodyDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/update-localizations: post: operationId: api_extensions_v1_deployment_update_localizations_create_[create_localization] summary: Create Localization parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalizationSchemaDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/LocalizationSchemaDRF' multipart/form-data: schema: $ref: '#/components/schemas/LocalizationSchemaDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/{deployment_id}/version/{version_number}: get: operationId: api_extensions_v1_deployment_version_retrieve_[retrieve_deployment_by_version_number] summary: Retrieve Deployment By Version Number parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: version_number schema: type: integer required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeploymentDTODRF' description: '' /api/extensions/v1/deployment/clone: post: operationId: api_extensions_v1_deployment_clone_create_[override_clone_deployment] summary: Override Clone Deployment tags: - Deployment Clone requestBody: content: application/json: schema: $ref: '#/components/schemas/CloneDeploymentRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CloneDeploymentRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CloneDeploymentRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/create-patient-profile: post: operationId: api_extensions_v1_deployment_create_patient_profile_create_[create_patient_profile] summary: Create Patient Profile tags: - Invitations requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePatientProfileRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreatePatientProfileRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreatePatientProfileRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreatePatientProfileResponseObjectDRF' description: '' /api/extensions/v1/deployment/file-library: post: operationId: api_extensions_v1_deployment_file_library_create_[add_files_to_library] summary: Add Files To Library tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/AddFilesToLibraryRequestObjectBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AddFilesToLibraryRequestObjectBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/AddFilesToLibraryRequestObjectBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/deployment/file-library/{library_id}: get: operationId: api_extensions_v1_deployment_file_library_retrieve_[retrieve_file_libraries] summary: Retrieve File Libraries parameters: - in: query name: deploymentId schema: type: string - in: path name: library_id schema: type: string required: true - in: query name: limit schema: type: integer - in: query name: offset schema: type: integer tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '202': content: application/json: schema: $ref: '#/components/schemas/RetrieveFilesInLibraryResponseObjectDRF' description: '' /api/extensions/v1/deployment/full: post: operationId: api_extensions_v1_deployment_full_create_[create_full_deployment] summary: Create Full Deployment tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateFullDeploymentRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateFullDeploymentRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateFullDeploymentRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/invitation: delete: operationId: api_extensions_v1_deployment_invitation_destroy_[delete_invitation_list] summary: Delete Invitation List tags: - Invitations security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeleteInvitationsListResponseDRF' description: '' /api/extensions/v1/deployment/invitation-link: post: operationId: api_extensions_v1_deployment_invitation_link_create_[get_invitation_link] summary: Get Invitation Link tags: - Invitations requestBody: content: application/json: schema: $ref: '#/components/schemas/GetInvitationLinkRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GetInvitationLinkRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/GetInvitationLinkRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetInvitationLinkResponseObjectDRF' description: '' /api/extensions/v1/deployment/invitation/{invitation_id}: delete: operationId: api_extensions_v1_deployment_invitation_destroy_[delete_invitation] summary: Delete Invitation parameters: - in: path name: invitation_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Invitations security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/deployment/invitations: post: operationId: api_extensions_v1_deployment_invitations_create_[retrieve_invitations_v1] summary: Retrieve Invitations V1 tags: - Invitations requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveInvitationsRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveInvitationsRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveInvitationsRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveInvitationsV1ResponseObjectDRF' description: '' /api/extensions/v1/deployment/learn-section/cms/{article_id}: get: operationId: api_extensions_v1_deployment_learn_section_cms_retrieve_[get_cms_article] summary: Get Cms Article parameters: - in: path name: article_id schema: type: string required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ArticleDRF' description: '' /api/extensions/v1/deployment/learn-section/cms/search: get: operationId: api_extensions_v1_deployment_learn_section_cms_search_retrieve_[search_cms_articles] summary: Search Cms Articles parameters: - in: query name: limit schema: type: integer - in: query name: q schema: type: string required: true - in: query name: skip schema: type: integer tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SearchCMSArticlesResponseDRF' description: '' /api/extensions/v1/deployment/modules: get: operationId: api_extensions_v1_deployment_modules_retrieve_[retrieve_modules] summary: Retrieve Modules tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModuleSchemaDRF' description: '' /api/extensions/v1/deployment/move: post: operationId: api_extensions_v1_deployment_move_create_[move_deployments] summary: Move Deployments tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/MoveDeploymentsRequestObjectBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MoveDeploymentsRequestObjectBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/MoveDeploymentsRequestObjectBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/resend-invitation-list: post: operationId: api_extensions_v1_deployment_resend_invitation_list_create_[resend_user_invitation_list] description: Resend User Invitations summary: Resend User Invitation List tags: - Invitations requestBody: content: application/json: schema: $ref: '#/components/schemas/ResendInvitationsListRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ResendInvitationsListRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ResendInvitationsListRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResendInvitationsListResponseDRF' description: '' /api/extensions/v1/deployment/search: post: operationId: api_extensions_v1_deployment_search_create_[retrieve_deployments] summary: Retrieve Deployments tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveDeploymentsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveDeploymentsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveDeploymentsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveDeploymentsResponseObjectDRF' description: '' /api/extensions/v1/deployment/send-invitation: post: operationId: api_extensions_v1_deployment_send_invitation_create_[send_user_invitation_v1] description: Send User invitation V1 summary: Send User Invitation V1 tags: - Invitations requestBody: content: application/json: schema: $ref: '#/components/schemas/SendInvitationsRequestDataV1DRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SendInvitationsRequestDataV1DRF' multipart/form-data: schema: $ref: '#/components/schemas/SendInvitationsRequestDataV1DRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '202': content: application/json: schema: $ref: '#/components/schemas/SendInvitationsResponseObjectV1DRF' description: '' /api/extensions/v1/deployment/send-invitation/{user_id}: post: operationId: api_extensions_v1_deployment_send_invitation_create_[send_user_specific_invitation] summary: Send User Specific Invitation parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Invitations requestBody: content: application/json: schema: $ref: '#/components/schemas/SendUserSpecificInvitationRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SendUserSpecificInvitationRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/SendUserSpecificInvitationRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/deployment/template: post: operationId: api_extensions_v1_deployment_template_create_[create_deployment_template] summary: Create Deployment Template tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/DeploymentTemplateDTODRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DeploymentTemplateDTODRF' multipart/form-data: schema: $ref: '#/components/schemas/DeploymentTemplateDTODRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/deployment/template/{template_id}: get: operationId: api_extensions_v1_deployment_template_retrieve_[retrieve_deployment_template] summary: Retrieve Deployment Template parameters: - in: header name: organizationId schema: type: string - in: path name: template_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeploymentTemplateDTODRF' description: '' put: operationId: api_extensions_v1_deployment_template_update_[update_deployment_template] summary: Update Deployment Template parameters: - in: header name: organizationId schema: type: string - in: path name: template_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/DeploymentTemplateDTODRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DeploymentTemplateDTODRF' multipart/form-data: schema: $ref: '#/components/schemas/DeploymentTemplateDTODRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' delete: operationId: api_extensions_v1_deployment_template_destroy_[delete_deployment_template] summary: Delete Deployment Template parameters: - in: header name: organizationId schema: type: string - in: path name: template_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/deployment/templates: get: operationId: api_extensions_v1_deployment_templates_retrieve_[retrieve_deployment_templates] summary: Retrieve Deployment Templates parameters: - in: header name: organizationId schema: type: string tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveDeploymentTemplatesResponseObjectDRF' description: '' /api/extensions/v1/deployment/user/email/send: post: operationId: api_extensions_v1_deployment_user_email_send_create_[send_email_to_patients] summary: Send Email To Patients tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/SendEmailToPatientsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SendEmailToPatientsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/SendEmailToPatientsRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' /api/extensions/v1/deployment/user/message/send: post: operationId: api_extensions_v1_deployment_user_message_send_create_[send_message_to_patient_list] summary: Send Message To Patient List tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/SendMessageToPatientListRequestObjectBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SendMessageToPatientListRequestObjectBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/SendMessageToPatientListRequestObjectBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/SendMessageToUserListResponseObjectDRF' description: '' /api/extensions/v1/deployment/validate-questionnaire-dimensions: post: operationId: api_extensions_v1_deployment_validate_questionnaire_dimensions_create_[validate_questionnaire_dimensions] summary: Validate Questionnaire Dimensions tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/ValidateQuestionnaireDimensionsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ValidateQuestionnaireDimensionsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ValidateQuestionnaireDimensionsRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' /api/extensions/v1/export/: post: operationId: api_extensions_v1_export_create_[export] summary: Export tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/export/deployment/{deployment_id}: post: operationId: api_extensions_v1_export_deployment_create_[export_deployment] summary: Export Deployment parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/export/deployment/{deployment_id}/task: get: operationId: api_extensions_v1_export_deployment_task_retrieve_[retrieve_export_deployment_processes] description: |- Retrieve Export Deployment Processes Fetches all the export processes related to a deployment. summary: Retrieve Export Deployment Processes parameters: - in: path name: deploymentId schema: type: string required: true - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Export security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveExportProcessesResponseObjectDRF' description: '' post: operationId: api_extensions_v1_export_deployment_task_create_[run_export_deployment_task] description: |- Run Export Task for Deployment Executes an export task for a specific deployment and returns the ID of this task. summary: Run Export Deployment Task parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Export requestBody: content: application/json: schema: $ref: '#/components/schemas/RunExportTaskRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RunExportTaskRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/RunExportTaskRequestDataDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RunExportDeploymentTaskResponseObjectDRF' description: '' /api/extensions/v1/export/deployment/{deployment_id}/task/{export_process_id}: get: operationId: api_extensions_v1_export_deployment_task_retrieve_[check_export_deployment_task_status] description: |- Check Export Task Status Retrieves the status of a specific export task for a deployment. Provides bucket link for the generated data if finished. summary: Check Export Deployment Task Status parameters: - in: path name: deploymentId schema: type: string required: true - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: exportProcessId schema: type: string required: true - in: path name: export_process_id schema: type: string required: true tags: - Export security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CheckExportDeploymentTaskStatusResponseObjectDRF' description: '' /api/extensions/v1/export/deployment/{deployment_id}/user_ratings: post: operationId: api_extensions_v1_export_deployment_user_ratings_create_[export_user_ratings] description: |- Export user ratings Exports user ratings of a specific deployment as a zip file, based on the deployment ID. summary: Export User Ratings parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Export security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/export/profile: post: operationId: api_extensions_v1_export_profile_create_[create_export_profile] description: |- Create Export Profile Creates a new export profile using the provided input data. summary: Create Export Profile tags: - Export requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExportProfileRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateExportProfileRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateExportProfileRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/export/profile/{profile_id}: post: operationId: api_extensions_v1_export_profile_create_[update_export_profile] description: |- Update Export Profile Updates an existing export profile with new content. summary: Update Export Profile parameters: - in: path name: profile_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Export requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportProfileContentDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ExportProfileContentDRF' multipart/form-data: schema: $ref: '#/components/schemas/ExportProfileContentDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' delete: operationId: api_extensions_v1_export_profile_destroy_[delete_export_profile] description: |- Delete Export Profile Deletes an export profile using the provided profile ID. summary: Delete Export Profile parameters: - in: path name: profile_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Export security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/export/profile/search: post: operationId: api_extensions_v1_export_profile_search_create_[retrieve_export_deployment_profiles] description: |- Retrieve Export Deployment Profiles Searches and retrieves export profiles based on the provided input criteria. summary: Retrieve Export Deployment Profiles tags: - Export requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveExportProfilesRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveExportProfilesRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveExportProfilesRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveExportProfilesResponseObjectDRF' description: '' /api/extensions/v1/export/tabular-export: post: operationId: api_extensions_v1_export_tabular_export_create_[export_tabular_data] description: |- Export Tabular Data Exports tabular data for the given user in a csv format. summary: Export Tabular Data tags: - Export requestBody: content: application/json: schema: $ref: '#/components/schemas/TabularExportUsersRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TabularExportUsersRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/TabularExportUsersRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TabularExportUsersResponseObjectDRF' description: '' /api/extensions/v1/export/tabular-export-dictionary/{deployment_id}: get: operationId: api_extensions_v1_export_tabular_export_dictionary_retrieve_[export_tabular_data_dictionary] description: |- Export Tabular Data Dictionary Exports tabular data dictionary in a csv format. summary: Export Tabular Data Dictionary parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Export security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TabularExportDataDictionaryResponseObjectDRF' description: '' /api/extensions/v1/export/user/{user_id}: post: operationId: api_extensions_v1_export_user_create_[export_user_data] description: |- Export User Data Exports specific user data based on the user ID and provided request data. Returns the data as a zip file. summary: Export User Data parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Export requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportUserRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ExportUserRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/ExportUserRequestDataDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/export/user/{user_id}/badges/confirm: post: operationId: api_extensions_v1_export_user_badges_confirm_create_[confirm_badges] description: |- Confirm Export Process Badges Confirms that user saw export process notifications. summary: Confirm Badges parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Export requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfirmExportBadgesRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ConfirmExportBadgesRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/ConfirmExportBadgesRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConfirmExportBadgesResponseObjectDRF' description: '' /api/extensions/v1/export/user/{user_id}/task: get: operationId: api_extensions_v1_export_user_task_retrieve_[retrieve_user_export_processes] description: |- Retrieve User Export Processes Retrieves all export processes for a specific user based on the user ID. summary: Retrieve User Export Processes parameters: - in: path name: userId schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Export security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveExportProcessesResponseObjectDRF' description: '' post: operationId: api_extensions_v1_export_user_task_create_[export_user_data_async] description: |- Export User Data Asynchronously Runs an asynchronous export task for the specified user and returns the task status. summary: Export User Data Async parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Export requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportUserRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ExportUserRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/ExportUserRequestDataDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RunExportDeploymentTaskResponseObjectDRF' description: '' /api/extensions/v1/export/user/{user_id}/task/{export_process_id}: get: operationId: api_extensions_v1_export_user_task_retrieve_[check_user_export_task_status] description: |- Check User Export Task Status Checks the status of a specific user export task based on the export process ID. summary: Check User Export Task Status parameters: - in: path name: exportProcessId schema: type: string required: true - in: path name: export_process_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: userId schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Export security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CheckExportDeploymentTaskStatusResponseObjectDRF' description: '' /api/extensions/v1/export_config/deployment/{deployment_id}: post: operationId: api_extensions_v1_export_config_deployment_create_[export_deployment_config] description: |- Export Deployment Configuration Exports the configuration of a specific deployment as a zip file, based on the deployment ID. summary: Export Deployment Config parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Export Configuration security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/export_config/organization/{organization_id}: post: operationId: api_extensions_v1_export_config_organization_create_[export_organization_config] description: |- Export Organization Configuration Exports the configuration of a specific organization as a zip file, based on the organization ID. summary: Export Organization Config parameters: - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Export Configuration security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/fitbit/notify: get: operationId: api_extensions_v1_fitbit_notify_retrieve_[verify_subscriber] description: |- Verify Subscription https://dev.fitbit.com/build/reference/web-api/developer-guide/using-subscriptions/#Verifying-a-Subscriber summary: Verify Subscriber parameters: - in: query name: verify schema: type: string tags: - Fitbit security: - {} responses: '204': description: Code is valid '404': description: Invalid code post: operationId: api_extensions_v1_fitbit_notify_create_[receive_notification] summary: Receive Notification parameters: - in: header name: signature schema: type: string tags: - Fitbit security: - {} responses: '204': description: Success '404': description: Signature not found or Fitbit config is disabled /api/extensions/v1/fitbit/redirect: get: operationId: api_extensions_v1_fitbit_redirect_retrieve_[redirect] summary: Redirect parameters: - in: query name: code schema: type: string - in: header name: language schema: type: string - in: header name: languageHeader schema: type: string - in: query name: state schema: type: string tags: - Fitbit security: - {} responses: '200': description: HTML Template /api/extensions/v1/fitbit/user-exists: post: operationId: api_extensions_v1_fitbit_user_exists_create_[fitbit_user_exists] description: Used by HCP not fitbit, in order to find the right backend in backend per customer summary: Fitbit User Exists parameters: - in: header name: signature schema: type: string tags: - Fitbit security: - {} responses: '204': description: Success '404': description: Signature not found, Fitbit config is disabled, or Fitbit User doesn't exist /api/extensions/v1/forms/user/{user_id}: get: operationId: api_extensions_v1_forms_user_retrieve_[retrieve_surgical_forms] description: |- Retrieve Surgical Forms Fetches a list of surgical forms for a specific user. summary: Retrieve Surgical Forms parameters: - in: query name: status schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Surgical Forms security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SurgicalFormDataDRF' description: '' /api/extensions/v1/forms/user/{user_id}/form/{form_id}: get: operationId: api_extensions_v1_forms_user_form_retrieve_[retrieve_surgical_form_detail] description: |- Retrieve Surgical Form Detail Retrieves the detailed information for a specific surgical form.. summary: Retrieve Surgical Form Detail parameters: - in: path name: form_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: query name: status schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Surgical Forms security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SurgicalFormDetailDRF' description: '' /api/extensions/v1/forms/user/{user_id}/history/{form_id}: get: operationId: api_extensions_v1_forms_user_history_retrieve_[retrieve_form_history] description: |- Retrieve Form History Retrieves the history of revisions for a specific form. summary: Retrieve Form History parameters: - in: path name: form_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Surgical Forms security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FormRevisionDTODRF' description: '' /api/extensions/v1/generate/deployment: post: operationId: api_extensions_v1_generate_deployment_create_[generate_deployment] summary: Generate Deployment tags: - AI Engine requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateDeploymentRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GenerateDeploymentRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/GenerateDeploymentRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GenerateDeploymentResponseObjectDRF' description: '' /api/extensions/v1/hi-sidekick: post: operationId: api_extensions_v1_hi_sidekick_create_[chat_with_sidekick] summary: Chat With Sidekick tags: - AI Engine requestBody: content: application/json: schema: $ref: '#/components/schemas/HiSidekickRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/HiSidekickRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/HiSidekickRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HiSidekickResponseObjectDRF' description: '' /api/extensions/v1/import_config/deployment: post: operationId: api_extensions_v1_import_config_deployment_create_[import_deployment_config] description: |- Import Deployment Configuration Imports a deployment configuration based on the provided data. summary: Import Deployment Config tags: - Import Configuration requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportDeploymentConfigRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ImportDeploymentConfigRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ImportDeploymentConfigRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/extensions/v1/import_config/deployment/file_validation: post: operationId: api_extensions_v1_import_config_deployment_file_validation_create_[deployment_import_file_validation] description: |- Deployment File Validation Validates the file for deployment configuration before importing it. summary: Deployment Import File Validation tags: - Import Configuration requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportConfigurationValidateFileRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ImportConfigurationValidateFileRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ImportConfigurationValidateFileRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ImportDeploymentConfigurationValidateFileResponseDRF' description: '' /api/extensions/v1/import_config/organization: post: operationId: api_extensions_v1_import_config_organization_create_[import_organization_config] description: |- Import Organization Configuration Imports an organization configuration based on the provided data. summary: Import Organization Config tags: - Import Configuration requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportOrganizationConfigRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ImportOrganizationConfigRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ImportOrganizationConfigRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/extensions/v1/import_config/organization/file_validation: post: operationId: api_extensions_v1_import_config_organization_file_validation_create_[organization_import_file_validation] description: |- Organization File Validation Validates the file for organization configuration before importing it. summary: Organization Import File Validation tags: - Import Configuration requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportConfigurationValidateFileRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ImportConfigurationValidateFileRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ImportConfigurationValidateFileRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ImportOrgConfigurationValidateFileResponseDRF' description: '' /api/extensions/v1/integration: post: operationId: api_extensions_v1_integration_create_[create_integration] description: |- Create Integration Creates a new integration based on the provided data. summary: Create Integration tags: - Integration requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateIntegrationRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateIntegrationRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateIntegrationRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/integration/{integration_id}: post: operationId: api_extensions_v1_integration_create_[retrieve_integration] description: |- Retrieve Integration Retrieves the details of the specified integration based on the integration ID. summary: Retrieve Integration parameters: - in: path name: integration_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Integration security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IntegrationDTODRF' description: '' put: operationId: api_extensions_v1_integration_update_[update_integration] description: |- Update Integration Updates an existing integration with the specified integration ID. summary: Update Integration parameters: - in: path name: integration_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Integration requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateIntegrationRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateIntegrationRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateIntegrationRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' delete: operationId: api_extensions_v1_integration_destroy_[delete_integration] description: |- Delete Integration Deletes the specified integration based on the integration ID. summary: Delete Integration parameters: - in: path name: integration_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Integration security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/integration/billing_test: post: operationId: api_extensions_v1_integration_billing_test_create_[manually_run_billing] summary: Manually Run Billing tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/TriggerTaskRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TriggerTaskRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/TriggerTaskRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TriggerTaskResponseObjectDRF' description: '' /api/extensions/v1/integration/ehr-logs/search: post: operationId: api_extensions_v1_integration_ehr_logs_search_create_[retrieve_ehr_logs] description: |- Search EHR Logs Retrieves EHR logs based on the search criteria provided. summary: Retrieve Ehr Logs tags: - Integration requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveEhrLogsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveEhrLogsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveEhrLogsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveEhrLogsResponseObjectDRF' description: '' /api/extensions/v1/integration/ehr/order: post: operationId: api_extensions_v1_integration_ehr_order_create_[receive_order] description: Retrieve order (Internal not in use) summary: Receive Order tags: - Integration Ehr Route security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: {} /api/extensions/v1/integration/fetch_referring_providers: post: operationId: api_extensions_v1_integration_fetch_referring_providers_create_[manually_fetch_referring_providers] summary: Manually Fetch Referring Providers tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/TriggerTaskRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TriggerTaskRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/TriggerTaskRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TriggerTaskResponseObjectDRF' description: '' /api/extensions/v1/integration/search: post: operationId: api_extensions_v1_integration_search_create_[retrieve_integrations] description: |- Retrieve Integrations Retrieves integrations based on the search criteria provided. summary: Retrieve Integrations tags: - Integration requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveIntegrationsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveIntegrationsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveIntegrationsRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveIntegrationsResponseObjectDRF' description: '' /api/extensions/v1/kardia/ecg-pdf/{user_id}/{record_id}: get: operationId: api_extensions_v1_kardia_ecg_pdf_retrieve_[retrieve_single_ecg_pdf] summary: Retrieve Single Ecg Pdf parameters: - in: path name: record_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Kardia security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ECGAliveCorDTODRF' description: '' /api/extensions/v1/kardia/ecg/{record_id}: get: operationId: api_extensions_v1_kardia_ecg_retrieve_[retrieve_single_ecg] summary: Retrieve Single Ecg parameters: - in: path name: record_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Kardia security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: {} /api/extensions/v1/kardia/patient/{user_id}: post: operationId: api_extensions_v1_kardia_patient_create_[create_kardia_patient] summary: Create Kardia Patient parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Kardia requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateKardiaPatientRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateKardiaPatientRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateKardiaPatientRequestBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateKardiaPatientResponseDRF' description: '' /api/extensions/v1/kardia/recordings/{patient_id}: get: operationId: api_extensions_v1_kardia_recordings_retrieve_[retrieve_patient_recordings] summary: Retrieve Patient Recordings parameters: - in: path name: patient_id schema: type: string required: true tags: - Kardia security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrievePatientRecordingResponseDRF' description: '' /api/extensions/v1/kardia/sync/{user_id}: get: operationId: api_extensions_v1_kardia_sync_retrieve_[sync_kardia_data] summary: Sync Kardia Data parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Kardia security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ECGAliveCorDTODRF' description: '' /api/extensions/v1/manager/{manager_id}/video/{video_call_id}/complete: post: operationId: api_extensions_v1_manager_video_complete_create_[complete_video_call_by_manager] summary: Complete Video Call By Manager parameters: - in: path name: managerId schema: type: string required: true - in: path name: manager_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: videoCallId schema: type: string required: true - in: path name: video_call_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Video Call security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/manager/{manager_id}/video/user/{user_id}/initiate: post: operationId: api_extensions_v1_manager_video_user_initiate_create_[initiate_video_call] summary: Initiate Video Call parameters: - in: path name: manager_id schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Video Call requestBody: content: application/json: schema: $ref: '#/components/schemas/InitiateVideoCallRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/InitiateVideoCallRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/InitiateVideoCallRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/InitiateVideoCallResponseObjectDRF' description: '' /api/extensions/v1/organization: post: operationId: api_extensions_v1_organization_create_[create_organization] summary: Create Organization tags: - Organization requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOrganizationDTORequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateOrganizationDTORequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateOrganizationDTORequestBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/organization/{organization_id}: get: operationId: api_extensions_v1_organization_retrieve_[retrieve_organization] summary: Retrieve Organization parameters: - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Organization security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrganizationWithExtrasDRF' description: '' put: operationId: api_extensions_v1_organization_update_[update_organization] summary: Update Organization parameters: - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Organization requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOrganizationDTORequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateOrganizationDTORequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateOrganizationDTORequestBodyDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' delete: operationId: api_extensions_v1_organization_destroy_[delete_organization] summary: Delete Organization parameters: - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Organization security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/organization/{organization_id}/deployment/{deployment_id}: delete: operationId: api_extensions_v1_organization_deployment_destroy_[unlink_deployment] summary: Unlink Deployment parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Organization security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/organization/{organization_id}/deployment/{deployment_id}/add-econsent/{econsent_id}: put: operationId: api_extensions_v1_organization_deployment_add_econsent_update_[add_econsent_to_deployment] summary: Add Econsent To Deployment parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: econsent_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Organization security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/organization/{organization_id}/econsent: post: operationId: api_extensions_v1_organization_econsent_create_[create_econsent] summary: Create Econsent parameters: - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Organization requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEConsentRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateEConsentRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateEConsentRequestBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateEConsentResponseObjectDRF' description: '' /api/extensions/v1/organization/{organization_id}/econsent-forms: post: operationId: api_extensions_v1_organization_econsent_forms_create_[retrieve_econsent_forms] summary: Retrieve Econsent Forms parameters: - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Organization requestBody: content: application/json: schema: $ref: '#/components/schemas/PaginatedRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PaginatedRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/PaginatedRequestBodyDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveEConsentsResponseObjectDRF' description: '' /api/extensions/v1/organization/{organization_id}/econsent-forms/{econsent_id}: post: operationId: api_extensions_v1_organization_econsent_forms_create_[retrieve_econsents_forms_by_id] summary: Retrieve Econsents Forms By Id parameters: - in: path name: econsent_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Organization requestBody: content: application/json: schema: $ref: '#/components/schemas/PaginatedRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PaginatedRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/PaginatedRequestBodyDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveEConsentsResponseObjectDRF' description: '' /api/extensions/v1/organization/{organization_id}/econsent/{config_id}: put: operationId: api_extensions_v1_organization_econsent_update_[apply_econsent_action] summary: Apply Econsent Action parameters: - in: path name: config_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Organization requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplyEConsentActionRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ApplyEConsentActionRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/ApplyEConsentActionRequestBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateEConsentResponseObjectDRF' description: '' /api/extensions/v1/organization/{organization_id}/econsent/{config_id}/state/{state}: put: operationId: api_extensions_v1_organization_econsent_state_update_[edit_econsent_state] summary: Edit Econsent State parameters: - in: path name: config_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: state schema: type: string required: true tags: - Organization security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateEConsentResponseObjectDRF' description: '' /api/extensions/v1/organization/{organization_id}/link-deployment: post: operationId: api_extensions_v1_organization_link_deployment_create_[link_deployment] description: '@deprecated' summary: Link Deployment parameters: - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Organization security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] deprecated: true responses: {} /api/extensions/v1/organization/{organization_id}/link-deployments: post: operationId: api_extensions_v1_organization_link_deployments_create_[link_deployments] summary: Link Deployments parameters: - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Organization requestBody: content: application/json: schema: $ref: '#/components/schemas/LinkUnlinkDeploymentsRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/LinkUnlinkDeploymentsRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/LinkUnlinkDeploymentsRequestBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/organization/{organization_id}/role: put: operationId: api_extensions_v1_organization_role_update_[create_or_update_organization_roles] summary: Create Or Update Organization Roles parameters: - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Organization requestBody: content: application/json: schema: $ref: '#/components/schemas/OrganizationRoleUpdateRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OrganizationRoleUpdateRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/OrganizationRoleUpdateRequestBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/extensions/v1/organization/{organization_id}/unlink-deployments: post: operationId: api_extensions_v1_organization_unlink_deployments_create_[unlink_deployments] summary: Unlink Deployments parameters: - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Organization requestBody: content: application/json: schema: $ref: '#/components/schemas/LinkUnlinkDeploymentsRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/LinkUnlinkDeploymentsRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/LinkUnlinkDeploymentsRequestBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/organization/clone: post: operationId: api_extensions_v1_organization_clone_create_[clone_organization] summary: Clone Organization parameters: - in: header name: organizationId schema: type: string tags: - Organization requestBody: content: application/json: schema: $ref: '#/components/schemas/CloneOrganizationRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CloneOrganizationRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/CloneOrganizationRequestBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CloneOrganizationResponseObjectDRF' description: '' /api/extensions/v1/organization/search: post: operationId: api_extensions_v1_organization_search_create_[retrieve_organizations] summary: Retrieve Organizations tags: - Organization requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveOrganizationsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveOrganizationsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveOrganizationsRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveOrganizationsResponseObjectDRF' description: '' /api/extensions/v1/phone-lookup/check-type: post: operationId: api_extensions_v1_phone_lookup_check_type_create_[check_phone_number_type] summary: Check Phone Number Type tags: - Phone Number Lookup requestBody: content: application/json: schema: $ref: '#/components/schemas/ValidatePhoneNumberTypeRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ValidatePhoneNumberTypeRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ValidatePhoneNumberTypeRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CheckPhoneNumberTypeResponseObjectDRF' description: '' /api/extensions/v1/public-module/{shortcode}: get: operationId: api_extensions_v1_public_module_retrieve_[retrieve_module_config] description: |- Retrieve Module Config Retrieve public module configuration by shortcode. summary: Retrieve Module Config parameters: - in: path name: shortcode schema: type: string required: true tags: - Module Results responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrievePublicModuleConfigResponseObjectDRF' description: '' post: operationId: api_extensions_v1_public_module_create_[create_module_result] description: |- Submit Module Result Create a module result for a public module using the provided shortcode. summary: Create Module Result parameters: - in: path name: shortcode schema: type: string required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePublicModuleItemRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreatePublicModuleItemRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreatePublicModuleItemRequestBodyDRF' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/public_cms/{collection}/{content_id}: get: operationId: api_extensions_v1_public_cms_retrieve_[retrieve_content] description: |- Retrieve Public Content. This endpoint allows users to access specific content items within a public CMS collection. The content is identified by its unique ID within the specified collection. summary: Retrieve Content parameters: - in: path name: authzUser schema: type: string required: true - in: path name: collection schema: type: string required: true - in: path name: contentId schema: type: string required: true - in: path name: content_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - CMS security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/public_cms/{collection}/search: post: operationId: api_extensions_v1_public_cms_search_create_[search_content] description: |- Search Public Content. Search for content within a public CMS collection using various search parameters. summary: Search Content parameters: - in: path name: collection schema: type: string required: true tags: - CMS requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchContentRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SearchContentRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/SearchContentRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublicContentSearchResponseObjectDRF' description: '' /api/extensions/v1/questionnaire-engine/user/{user_id}: post: operationId: api_extensions_v1_questionnaire_engine_user_create_[handle_condition_flow] summary: Handle Condition Flow parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Questionnaire Engine requestBody: content: application/json: schema: $ref: '#/components/schemas/ConditionFlowRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ConditionFlowRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ConditionFlowRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConditionFlowResponseObjectDRF' description: '' /api/extensions/v1/report/summary/user/{user_id}: post: operationId: api_extensions_v1_report_summary_user_create_[generate_report] summary: Generate Report parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Export requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateSummaryReportRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GenerateSummaryReportRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/GenerateSummaryReportRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/report/summary/user/{user_id}/task: post: operationId: api_extensions_v1_report_summary_user_task_create_[generate_report_async] summary: Generate Report Async parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Export requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateSummaryReportRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GenerateSummaryReportRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/GenerateSummaryReportRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RunExportDeploymentTaskResponseObjectDRF' description: '' /api/extensions/v1/rule-engine/deployment/{deployment_id}/get-nodes: get: operationId: api_extensions_v1_rule_engine_deployment_get_nodes_retrieve_[get_nodes] summary: Get Nodes parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Rule Engine security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetNodesResponseObjectDRF' description: '' /api/extensions/v1/rule-engine/deployment/{deployment_id}/workflow: post: operationId: api_extensions_v1_rule_engine_deployment_workflow_create_[create_workflow] summary: Create Workflow parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Rule Engine requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateWorkflowRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateWorkflowRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateWorkflowRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/rule-engine/deployment/{deployment_id}/workflow-templates: get: operationId: api_extensions_v1_rule_engine_deployment_workflow_templates_retrieve_[get_workflow_templates] summary: Get Workflow Templates parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Rule Engine security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetTemplateWorkflowsResponseObjectDRF' description: '' /api/extensions/v1/rule-engine/deployment/{deployment_id}/workflow/{workflow_id}: get: operationId: api_extensions_v1_rule_engine_deployment_workflow_retrieve_[get_workflow] summary: Get Workflow parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: workflow_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Rule Engine security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetWorkflowResponseObjectDRF' description: '' put: operationId: api_extensions_v1_rule_engine_deployment_workflow_update_[update_workflow] summary: Update Workflow parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: workflow_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Rule Engine requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateWorkflowRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateWorkflowRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateWorkflowRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' delete: operationId: api_extensions_v1_rule_engine_deployment_workflow_destroy_[delete_workflow] summary: Delete Workflow parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: workflow_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Rule Engine security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/rule-engine/deployment/{deployment_id}/workflow/{workflow_id}/activate: post: operationId: api_extensions_v1_rule_engine_deployment_workflow_activate_create_[activate_workflow] summary: Activate Workflow parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: workflow_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Rule Engine security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/rule-engine/deployment/{deployment_id}/workflow/{workflow_id}/deactivate: post: operationId: api_extensions_v1_rule_engine_deployment_workflow_deactivate_create_[deactivate_workflow] summary: Deactivate Workflow parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: workflow_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Rule Engine security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/rule-engine/deployment/{deployment_id}/workflow/{workflow_id}/run: post: operationId: api_extensions_v1_rule_engine_deployment_workflow_run_create_[run_workflow] summary: Run Workflow parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: workflow_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Rule Engine requestBody: content: application/json: schema: $ref: '#/components/schemas/RunWorkflowRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RunWorkflowRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RunWorkflowRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/rule-engine/deployment/{deployment_id}/workflows: get: operationId: api_extensions_v1_rule_engine_deployment_workflows_retrieve_[get_workflows] summary: Get Workflows parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Rule Engine security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetWorkflowsResponseObjectDRF' description: '' /api/extensions/v1/user/{ser_id}/revere-test/export/: post: operationId: api_extensions_v1_user_revere_test_export_create_[export_revere] summary: Export Revere parameters: - in: path name: ser_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Revere requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportRevereResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ExportRevereResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ExportRevereResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] deprecated: true responses: '200': description: Archive with data /api/extensions/v1/user/{user_id}: get: operationId: api_extensions_v1_user_retrieve_[retrieve_user_profile] summary: Retrieve User Profile parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDTODRF' description: '' post: operationId: api_extensions_v1_user_create_[update_user_profile] summary: Update User Profile parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserProfileRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateUserProfileRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateUserProfileRequestDataDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/add-role: post: operationId: api_extensions_v1_user_add_role_create_[add_roles] summary: Add Roles parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/AddRolesInputDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AddRolesInputDRF' multipart/form-data: schema: $ref: '#/components/schemas/AddRolesInputDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/appointment: post: operationId: api_extensions_v1_user_appointment_create_[create_appointment] summary: Create Appointment parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Appointment requestBody: content: application/json: schema: $ref: '#/components/schemas/AppointmentDTODRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AppointmentDTODRF' multipart/form-data: schema: $ref: '#/components/schemas/AppointmentDTODRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' delete: operationId: api_extensions_v1_user_appointment_destroy_[bulk_delete_appointments] summary: Bulk Delete Appointments parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Appointment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkDeleteAppointmentsResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/appointment/{appointment_id}: get: operationId: api_extensions_v1_user_appointment_retrieve_[retrieve_appointment] summary: Retrieve Appointment parameters: - in: path name: appointment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Appointment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppointmentDTODRF' description: '' put: operationId: api_extensions_v1_user_appointment_update_[update_appointment] summary: Update Appointment parameters: - in: path name: appointment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Appointment requestBody: content: application/json: schema: $ref: '#/components/schemas/AppointmentDTODRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AppointmentDTODRF' multipart/form-data: schema: $ref: '#/components/schemas/AppointmentDTODRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' delete: operationId: api_extensions_v1_user_appointment_destroy_[delete_appointment] summary: Delete Appointment parameters: - in: path name: appointment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Appointment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/user/{user_id}/appointment/search: get: operationId: api_extensions_v1_user_appointment_search_retrieve_[search_appointments] summary: Search Appointments parameters: - in: query name: limit schema: type: integer - in: query name: skip schema: type: integer - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Appointment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveAppointmentsResponseObjectDRF' description: '' put: operationId: api_extensions_v1_user_appointment_search_update_[retrieve_appointments] summary: Retrieve Appointments parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Appointment requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveAppointmentsRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveAppointmentsRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveAppointmentsRequestBodyDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AppointmentDTODRF' description: '' /api/extensions/v1/user/{user_id}/arm_fatigue/quality_check_angle: post: operationId: api_extensions_v1_user_arm_fatigue_quality_check_angle_create_[arm_angle_quality_check] summary: Arm Angle Quality Check parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Inference requestBody: content: application/json: schema: $ref: '#/components/schemas/ArmAngleQualityCheckRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ArmAngleQualityCheckRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ArmAngleQualityCheckRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ArmAngleQualityCheckResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/arm_fatigue/quality_check_position: post: operationId: api_extensions_v1_user_arm_fatigue_quality_check_position_create_[user_positioning_quality_check] summary: User Positioning Quality Check parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Inference Route requestBody: content: application/json: schema: $ref: '#/components/schemas/QualityCheckRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/QualityCheckRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/QualityCheckRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/QualityCheckErrorResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/assign-proxy: post: operationId: api_extensions_v1_user_assign_proxy_create_[link_proxy_user] summary: Link Proxy User parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/LinkProxyRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/LinkProxyRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/LinkProxyRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/LinkProxyUserResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/authorize-third-party-app: post: operationId: api_extensions_v1_user_authorize_third_party_app_create_[authorize_third_party_app] description: |- Authorize Third-Party App Authorizes a third-party app for the specified user. summary: Authorize Third Party App parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Health App Integration requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthorizeFitbitRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AuthorizeFitbitRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/AuthorizeFitbitRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/calls/search: get: operationId: api_extensions_v1_user_calls_search_retrieve_[retrieve_video_calls] summary: Retrieve Video Calls parameters: - in: query name: limit schema: type: integer - in: query name: order schema: type: string - in: query name: skip schema: type: integer - in: query name: sort schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: query name: video_call_id schema: type: string tags: - Video Call security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveCallsPaginatedResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/clear/fields: put: operationId: api_extensions_v1_user_clear_fields_update_[clear_user_profile_data] description: |- Deletes user profile data. Usage: add desired field name to ClearUserProfileDataRequestObject._fieldsAllowedToRemove summary: Clear User Profile Data parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/ClearUserProfileDataRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ClearUserProfileDataRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/ClearUserProfileDataRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/configuration: get: operationId: api_extensions_v1_user_configuration_retrieve_[retrieve_deployment_config] summary: Retrieve Deployment Config parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveDeploymentConfigResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/consent/{consent_id}/sign: post: operationId: api_extensions_v1_user_consent_sign_create_[sign_consent] summary: Sign Consent parameters: - in: path name: consent_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/SignConsentRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SignConsentRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/SignConsentRequestDataDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/deployment/{deployment_id}/helperagreementlog: post: operationId: api_extensions_v1_user_deployment_helperagreementlog_create_[create_helper_agreement_log] description: |- Create helper agreement log Create a helper agreement log for a user within a deployment. summary: Create Helper Agreement Log parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateHelperAgreementLogRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateHelperAgreementLogRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateHelperAgreementLogRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/deployment/{deployment_id}/note/{note_id}: get: operationId: api_extensions_v1_user_deployment_note_retrieve_[retrieve_single_user_note] description: |- Retrieve user note Retrieve a specific note for a user within a deployment. summary: Retrieve Single User Note parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: note_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserNoteDTODRF' description: '' /api/extensions/v1/user/{user_id}/deployment/{deployment_id}/thumbnail-notes: get: operationId: api_extensions_v1_user_deployment_thumbnail_notes_retrieve_[retrieve_user_thumbnail_notes] description: |- Retrieve user thumbnail notes Retrieve thumbnail previews of notes for a user within a deployment. summary: Retrieve User Thumbnail Notes parameters: - in: query name: deploymentId schema: type: string required: true - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: query name: endDateTime schema: type: string format: date-time - in: query name: startDateTime schema: type: string format: date-time - in: query name: userId schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserNoteDTODRF' description: '' /api/extensions/v1/user/{user_id}/diary/{id}: get: operationId: api_extensions_v1_user_diary_retrieve_[retrieve_diary_by_id] summary: Retrieve Diary By Id parameters: - in: path name: id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Diary security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveDiaryByIdResponseDRF' description: '' /api/extensions/v1/user/{user_id}/diary/count: get: operationId: api_extensions_v1_user_diary_count_retrieve_[retrieve_diaries_count] summary: Retrieve Diaries Count parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Diary security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveDiariesCountResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/diary/list: get: operationId: api_extensions_v1_user_diary_list_retrieve_[retrieve_diaries_list] summary: Retrieve Diaries List parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Diary security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DiaryCategoryResponseDRF' description: '' /api/extensions/v1/user/{user_id}/diary/search: post: operationId: api_extensions_v1_user_diary_search_create_[retrieve_diaries] summary: Retrieve Diaries parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Diary requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveDiariesRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveDiariesRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveDiariesRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveDiariesResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/document: get: operationId: api_extensions_v1_user_document_retrieve_[retrieve_personal_documents] description: |- Retrieve personal documents Retrieve all personal documents associated with a user. summary: Retrieve Personal Documents parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PersonalDocumentDRF' description: '' post: operationId: api_extensions_v1_user_document_create_[create_personal_document] description: |- Create personal document Create a personal document for a user. summary: Create Personal Document parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePersonalDocumentRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreatePersonalDocumentRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreatePersonalDocumentRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/document/{document_id}: delete: operationId: api_extensions_v1_user_document_destroy_[delete_personal_document] description: |- Delete personal document Delete a specific personal document of a user. summary: Delete Personal Document parameters: - in: path name: document_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/user/{user_id}/econsent/{econsent_id}: get: operationId: api_extensions_v1_user_econsent_retrieve_[retrieve_user_econsent] summary: Retrieve User Econsent parameters: - in: path name: econsent_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EConsentDRF' description: '' post: operationId: api_extensions_v1_user_econsent_create_[assign_econsent_to_user] summary: Assign Econsent To User parameters: - in: path name: econsent_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/econsent/{econsent_id}/pdf: get: operationId: api_extensions_v1_user_econsent_pdf_retrieve_[retrieve_econsent_pdf] description: |- Retrieve econsent PDF(s) Returns all user's econsent pdfs. summary: Retrieve Econsent Pdf parameters: - in: path name: econsent_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EConsentLogDTODRF' description: '' /api/extensions/v1/user/{user_id}/econsent/{econsent_id}/sign: post: operationId: api_extensions_v1_user_econsent_sign_create_[sign_econsent] summary: Sign Econsent parameters: - in: path name: econsent_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/SignEConsentRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SignEConsentRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/SignEConsentRequestDataDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/econsent/{econsent_id}/withdraw: post: operationId: api_extensions_v1_user_econsent_withdraw_create_[withdraw_econsent] summary: Withdraw Econsent parameters: - in: path name: econsent_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/WithdrawEConsentRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/WithdrawEConsentRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/WithdrawEConsentRequestBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/user/{user_id}/flagged-modules: get: operationId: api_extensions_v1_user_flagged_modules_retrieve_[retrieve_unseen_module_results] summary: Retrieve Unseen Module Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UnseenModulesResponseDRF' description: '' post: operationId: api_extensions_v1_user_flagged_modules_create_[retrieve_unseen_module_results] summary: Retrieve Unseen Module Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UnseenModulesResponseDRF' description: '' /api/extensions/v1/user/{user_id}/fullconfiguration: get: operationId: api_extensions_v1_user_fullconfiguration_retrieve_[retrieve_full_configuration_for_user] summary: Retrieve Full Configuration For User parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveFullConfigurationResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/generate/text: get: operationId: api_extensions_v1_user_generate_text_retrieve_[generate_text_head] description: |- Generate Text Head Check permissions CP while the feature is not available for public use summary: Generate Text Head parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - AI Engine security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body post: operationId: api_extensions_v1_user_generate_text_create_[generate_text] summary: Generate Text parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - AI Engine requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateTextRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GenerateTextRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/GenerateTextRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GenerateTextResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/health-score: post: operationId: api_extensions_v1_user_health_score_create_[retrieve_health_score] summary: Retrieve Health Score parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Health Score requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveHealthScoreRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveHealthScoreRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveHealthScoreRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveHealthScoreResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/key-action: get: operationId: api_extensions_v1_user_key_action_retrieve_[retrieve_to_do_items_for_user] summary: Retrieve To Do Items For User parameters: - in: query name: allowPastEvents schema: type: boolean - in: query name: moduleConfigIds schema: type: string - in: query name: start schema: type: string format: date-time - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Key Actions security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveToDoItemsResponseDRF' description: '' /api/extensions/v1/user/{user_id}/key-action/{key_action_id}: post: operationId: api_extensions_v1_user_key_action_create_[create_key_action_log] summary: Create Key Action Log parameters: - in: path name: key_action_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Key Actions requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateKeyActionLogDTORequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateKeyActionLogDTORequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateKeyActionLogDTORequestBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' delete: operationId: api_extensions_v1_user_key_action_destroy_[delete_key_action_log] summary: Delete Key Action Log parameters: - in: path name: id schema: type: string required: true - in: path name: key_action_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: userId schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Key Actions security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/user/{user_id}/key-action/expiring: get: operationId: api_extensions_v1_user_key_action_expiring_retrieve_[retrieve_expiring_key_actions_in_timeframe] summary: Retrieve Expiring Key Actions In Timeframe parameters: - in: query name: end schema: type: string format: date-time - in: query name: onlyEnabled schema: type: boolean - in: query name: start schema: type: string format: date-time - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Key Actions security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/KeyActionResponseDRF' description: '' /api/extensions/v1/user/{user_id}/key-action/forms-timeline: get: operationId: api_extensions_v1_user_key_action_forms_timeline_retrieve_[retrieve_grouped_forms_timeline] summary: Retrieve Grouped Forms Timeline parameters: - in: query name: filledBy schema: type: string required: true - in: query name: startDateTime schema: type: string format: date-time required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Key Actions security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FormDataDRF' description: '' /api/extensions/v1/user/{user_id}/key-action/grouped-forms-stats: get: operationId: api_extensions_v1_user_key_action_grouped_forms_stats_retrieve_[retrieve_grouped_forms_stats] summary: Retrieve Grouped Forms Stats parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Key Actions security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PeriodProgressResponseDRF' description: '' /api/extensions/v1/user/{user_id}/key-action/timeframe: get: operationId: api_extensions_v1_user_key_action_timeframe_retrieve_[retrieve_to_do_items_in_timeframe] summary: Retrieve To Do Items In Timeframe parameters: - in: query name: allowPastEvents schema: type: boolean - in: query name: end schema: type: string format: date-time required: true - in: query name: start schema: type: string format: date-time - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Key Actions security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveToDoItemsResponseDRF' description: '' /api/extensions/v1/user/{user_id}/labels: post: operationId: api_extensions_v1_user_labels_create_[assign_user_labels] summary: Assign User Labels parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/AssignLabelsToUserRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AssignLabelsToUserRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/AssignLabelsToUserRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/medication: post: operationId: api_extensions_v1_user_medication_create_[create_medication] summary: Create Medication parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Medications requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMedicationRequestObjectV2DRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateMedicationRequestObjectV2DRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateMedicationRequestObjectV2DRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/medication/: post: operationId: api_extensions_v1_user_medication_create_[create_medication]_2 summary: Create Medication parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Medications (Deprecated) requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMedicationRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateMedicationRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateMedicationRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/medication/{medication_id}: post: operationId: api_extensions_v1_user_medication_create_[update_medication_v1] summary: Update Medication V1 parameters: - in: path name: medication_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Medications (Deprecated) requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMedicationRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateMedicationRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateMedicationRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' put: operationId: api_extensions_v1_user_medication_update_[update_medication] summary: Update Medication parameters: - in: path name: medication_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Medications (Deprecated) requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMedicationRequestObjectV2DRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateMedicationRequestObjectV2DRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateMedicationRequestObjectV2DRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/medication/{medication_id}/calendar: get: operationId: api_extensions_v1_user_medication_calendar_retrieve_[retrieve_a_medication_calendar] summary: Retrieve A Medication Calendar parameters: - in: query name: connectedModule schema: type: string - in: query name: deploymentId schema: type: string - in: query name: endDateTime schema: type: string format: date-time required: true - in: query name: hideMealBased schema: type: boolean - in: query name: logOverride schema: type: boolean - in: query name: medicationId schema: type: string - in: path name: medication_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: query name: startDateTime schema: type: string format: date-time required: true - in: query name: user schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Medications security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MedicationCalendarResponseDRF' description: '' /api/extensions/v1/user/{user_id}/medication/{medication_id}/log: post: operationId: api_extensions_v1_user_medication_log_create_[create_medication_log] summary: Create Medication Log parameters: - in: path name: medication_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Medications requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMedicationLogRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateMedicationLogRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateMedicationLogRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/medication/{medication_id}/notes: get: operationId: api_extensions_v1_user_medication_notes_retrieve_[retrieve_a_medication_notes] summary: Retrieve A Medication Notes parameters: - in: path name: medication_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Medications security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MedicationNotesResponseDRF' description: '' /api/extensions/v1/user/{user_id}/medication/calendar: get: operationId: api_extensions_v1_user_medication_calendar_retrieve_[retrieve_medication_calendar] summary: Retrieve Medication Calendar parameters: - in: query name: connectedModule schema: type: string - in: query name: deploymentId schema: type: string - in: query name: endDateTime schema: type: string format: date-time required: true - in: query name: hideMealBased schema: type: boolean - in: query name: logOverride schema: type: boolean - in: query name: startDateTime schema: type: string format: date-time required: true - in: query name: user schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Medications security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MedicationCalendarResponseDRF' description: '' /api/extensions/v1/user/{user_id}/medication/history/search: get: operationId: api_extensions_v1_user_medication_history_search_retrieve_[retrieve_medications_history] summary: Retrieve Medications History parameters: - in: query name: deploymentId schema: type: string - in: query name: limit schema: type: integer - in: query name: searchWithUserType schema: type: string - in: query name: seen schema: type: boolean - in: query name: skip schema: type: integer - in: query name: userId schema: type: string - in: query name: userType schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Medications security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MedicationHistoryResponseV2DRF' description: '' /api/extensions/v1/user/{user_id}/medication/history/seen: post: operationId: api_extensions_v1_user_medication_history_seen_create_[update_medication_history_as_seen] summary: Update Medication History As Seen parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Medications security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/medication/logs: get: operationId: api_extensions_v1_user_medication_logs_retrieve_[retrieve_medication_logs] summary: Retrieve Medication Logs parameters: - in: query name: endDateTime schema: type: string format: date-time - in: query name: moduleConfigId schema: type: string - in: query name: moduleId schema: type: string - in: query name: startDateTime schema: type: string format: date-time - in: query name: status schema: type: string - in: query name: userId schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Medications security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MedicationLogsResponseDRF' description: '' /api/extensions/v1/user/{user_id}/medication/retrieve: post: operationId: api_extensions_v1_user_medication_retrieve_create_[retrieve_medications] summary: Retrieve Medications parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Medications (Deprecated) requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveMedicationsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveMedicationsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveMedicationsRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MedicationDTODRF' description: '' /api/extensions/v1/user/{user_id}/medication/search: get: operationId: api_extensions_v1_user_medication_search_retrieve_[retrieve_medications] summary: Retrieve Medications parameters: - in: query name: deploymentId schema: type: string - in: query name: enabled schema: type: boolean - in: query name: grouped schema: type: boolean - in: query name: hideMealBased schema: type: boolean - in: query name: limit schema: type: integer - in: query name: skip schema: type: integer - in: query name: user schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Medications security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/user/{user_id}/medication/unseen: get: operationId: api_extensions_v1_user_medication_unseen_retrieve_[retrieve_unseen_medication_results] summary: Retrieve Unseen Medication Results parameters: - in: query name: deployment schema: type: string - in: query name: limit schema: type: integer - in: query name: moduleConfigId schema: type: string - in: query name: skip schema: type: integer - in: query name: userId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Medications security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveUnseenMedicationResultsResponseDRF' description: '' /api/extensions/v1/user/{user_id}/module-goal/{module_config_id}: get: operationId: api_extensions_v1_user_module_goal_retrieve_[retrieve_latest_goal] description: |- Retrieve Latest Module Goal Retrieves the latest module goal for the specified user and module configuration. summary: Retrieve Latest Goal parameters: - in: path name: module_config_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Goal security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body post: operationId: api_extensions_v1_user_module_goal_create_[create_module_goal] description: |- Create Module Goal Creates a new module goal for the specified user and module configuration. summary: Create Module Goal parameters: - in: path name: module_config_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Goal security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body put: operationId: api_extensions_v1_user_module_goal_update_[update_module_goal] description: |- Update Module Goal Updates an existing module goal for the specified user and module configuration. summary: Update Module Goal parameters: - in: path name: module_config_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Goal security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/user/{user_id}/module-goal/{module_config_id}/all: get: operationId: api_extensions_v1_user_module_goal_all_retrieve_[retrieve_all_module_goals] description: |- Retrieve All Module Goals Retrieves all module goals for a specific user and module configuration. summary: Retrieve All Module Goals parameters: - in: path name: module_config_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Goal security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/user/{user_id}/module-goal/{module_config_id}/complete: put: operationId: api_extensions_v1_user_module_goal_complete_update_[complete_module_goal] description: |- Complete Module Goal Marks a module goal as complete for the specified user and module configuration. summary: Complete Module Goal parameters: - in: path name: module_config_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Goal security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/user/{user_id}/module-goal/{module_config_id}/seen: put: operationId: api_extensions_v1_user_module_goal_seen_update_[set_seen_module_goal] description: |- Set Seen Module Goal Marks a module goal as seen for the specified user and module configuration. summary: Set Seen Module Goal parameters: - in: path name: module_config_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Goal security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/user/{user_id}/module-goal/all: get: operationId: api_extensions_v1_user_module_goal_all_retrieve_[retrieve_all_latest_user_module_goals] description: |- Retrieve All Latest Goals Retrieves all the latest module goals for a specific user. summary: Retrieve All Latest User Module Goals parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Goal security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/user/{user_id}/module-invite: post: operationId: api_extensions_v1_user_module_invite_create_[invite_user_to_module] description: |- Invite User Invite a user to complete a public module. summary: Invite User To Module parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/InviteUserToModuleRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/InviteUserToModuleRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/InviteUserToModuleRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/SendPublicModuleResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/{module_id}/{module_result_id}/feedback: get: operationId: api_extensions_v1_user_module_result_feedback_retrieve_[retrieve_feedback] summary: Retrieve Feedback parameters: - in: path name: module_id schema: type: string required: true - in: path name: module_result_id schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveFeedbackResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/{module_id}/set-meal: post: operationId: api_extensions_v1_user_module_result_set_meal_create_[set_module_result_meal_type] summary: Set Module Result Meal Type parameters: - in: path name: module_id schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/SetModuleResultMealTypeRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SetModuleResultMealTypeRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/SetModuleResultMealTypeRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/{module_id}/sign: post: operationId: api_extensions_v1_user_module_result_sign_create_[update_module_result_status_sign] summary: Update Module Result Status Sign parameters: - in: path name: module_id schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/ModuleResultSignRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ModuleResultSignRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ModuleResultSignRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdateModuleResultStatusResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/{module_id}/unsign: post: operationId: api_extensions_v1_user_module_result_unsign_create_[update_module_result_unsign] summary: Update Module Result Unsign parameters: - in: path name: module_id schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/ModuleResultUnSignRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ModuleResultUnSignRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ModuleResultUnSignRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdateModuleResultStatusResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/AHQ: post: operationId: api_extensions_v1_user_module_result_AHQ_create_[create_AHQ] summary: Create Ahq parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/AHQ/search: post: operationId: api_extensions_v1_user_module_result_AHQ_search_create_[retrieve_AHQ_results] summary: Retrieve Ahq Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AHQResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/AZFurtherPregnancyKeyActionTrigger/search: post: operationId: api_extensions_v1_user_module_result_AZFurtherPregnancyKeyActionTrigger_search_create_[retrieve_AZFurtherPregnancyKeyActionTrigger_results] summary: Retrieve Azfurtherpregnancykeyactiontrigger Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AZFurtherPregnancyKeyActionTriggerResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/AZGroupKeyActionTrigger/search: post: operationId: api_extensions_v1_user_module_result_AZGroupKeyActionTrigger_search_create_[retrieve_AZGroupKeyActionTrigger_results] summary: Retrieve Azgroupkeyactiontrigger Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AZGroupKeyActionTriggerResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/AZScreeningQuestionnaire/search: post: operationId: api_extensions_v1_user_module_result_AZScreeningQuestionnaire_search_create_[retrieve_AZScreeningQuestionnaire_results] summary: Retrieve Azscreeningquestionnaire Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AZScreeningQuestionnaireResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/AdditionalQoL/search: post: operationId: api_extensions_v1_user_module_result_AdditionalQoL_search_create_[retrieve_AdditionalQoL_results] summary: Retrieve Additionalqol Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdditionalQoLResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/AirQuality: post: operationId: api_extensions_v1_user_module_result_AirQuality_create_[create_AirQuality] summary: Create Airquality parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAirQualityIndexDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateAirQualityIndexDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateAirQualityIndexDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/AirQuality/search: post: operationId: api_extensions_v1_user_module_result_AirQuality_search_create_[retrieve_AirQuality_results] summary: Retrieve Airquality Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AirQualityResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/ArmFatigue: post: operationId: api_extensions_v1_user_module_result_ArmFatigue_create_[create_ArmFatigue] summary: Create Armfatigue parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateArmFatigueDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateArmFatigueDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateArmFatigueDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '202': description: No response body /api/extensions/v1/user/{user_id}/module-result/ArmFatigue/search: post: operationId: api_extensions_v1_user_module_result_ArmFatigue_search_create_[retrieve_ArmFatigue_results] summary: Retrieve Armfatigue Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ArmFatigueResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/AsthmaControlTest: post: operationId: api_extensions_v1_user_module_result_AsthmaControlTest_create_[create_AsthmaControlTest] summary: Create Asthmacontroltest parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/AsthmaControlTest/search: post: operationId: api_extensions_v1_user_module_result_AsthmaControlTest_search_create_[retrieve_AsthmaControlTest_results] summary: Retrieve Asthmacontroltest Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AsthmaControlTestResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/AwarenessTraining/search: post: operationId: api_extensions_v1_user_module_result_AwarenessTraining_search_create_[retrieve_AwarenessTraining_results] summary: Retrieve Awarenesstraining Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AwarenessTrainingResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/BMI: post: operationId: api_extensions_v1_user_module_result_BMI_create_[create_BMI] summary: Create Bmi parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateWeightDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateWeightDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateWeightDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/BMI/search: post: operationId: api_extensions_v1_user_module_result_BMI_search_create_[retrieve_BMI_results] summary: Retrieve Bmi Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BMIResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/BackgroundInformation/search: post: operationId: api_extensions_v1_user_module_result_BackgroundInformation_search_create_[retrieve_BackgroundInformation_results] summary: Retrieve Backgroundinformation Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BackgroundInformationResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/BloodGlucose: post: operationId: api_extensions_v1_user_module_result_BloodGlucose_create_[create_BloodGlucose] summary: Create Bloodglucose parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBloodGlucoseDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateBloodGlucoseDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateBloodGlucoseDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/BloodGlucose/search: post: operationId: api_extensions_v1_user_module_result_BloodGlucose_search_create_[retrieve_BloodGlucose_results] summary: Retrieve Bloodglucose Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BloodGlucoseResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/BloodPressure: post: operationId: api_extensions_v1_user_module_result_BloodPressure_create_[create_BloodPressure] summary: Create Bloodpressure parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBloodPressureDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateBloodPressureDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateBloodPressureDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/BloodPressure/search: post: operationId: api_extensions_v1_user_module_result_BloodPressure_search_create_[retrieve_BloodPressure_results] summary: Retrieve Bloodpressure Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BloodPressureResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/BodyMeasurement: post: operationId: api_extensions_v1_user_module_result_BodyMeasurement_create_[create_BodyMeasurement] summary: Create Bodymeasurement parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AnyOfCreateBodyMeasurementDRF_Or_CreateQuestionnaireDRFItem' application/x-www-form-urlencoded: schema: type: array items: $ref: '#/components/schemas/AnyOfCreateBodyMeasurementDRF_Or_CreateQuestionnaireDRFItem' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/AnyOfCreateBodyMeasurementDRF_Or_CreateQuestionnaireDRFItem' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/BodyMeasurement/search: post: operationId: api_extensions_v1_user_module_result_BodyMeasurement_search_create_[retrieve_BodyMeasurement_results] summary: Retrieve Bodymeasurement Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BodyMeasurementResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/BodyPower: post: operationId: api_extensions_v1_user_module_result_BodyPower_create_[create_BodyPower] summary: Create Bodypower parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBodyPowerDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateBodyPowerDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateBodyPowerDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/BodyPower/search: post: operationId: api_extensions_v1_user_module_result_BodyPower_search_create_[retrieve_BodyPower_results] summary: Retrieve Bodypower Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BodyPowerResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/BodyStress: post: operationId: api_extensions_v1_user_module_result_BodyStress_create_[create_BodyStress] summary: Create Bodystress parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBodyStressDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateBodyStressDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateBodyStressDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/BodyStress/search: post: operationId: api_extensions_v1_user_module_result_BodyStress_search_create_[retrieve_BodyStress_results] summary: Retrieve Bodystress Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BodyStressResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/BreastFeedingStatus/search: post: operationId: api_extensions_v1_user_module_result_BreastFeedingStatus_search_create_[retrieve_BreastFeedingStatus_results] summary: Retrieve Breastfeedingstatus Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BreastFeedingStatusResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/BreastFeedingUpdate/search: post: operationId: api_extensions_v1_user_module_result_BreastFeedingUpdate_search_create_[retrieve_BreastFeedingUpdate_results] summary: Retrieve Breastfeedingupdate Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BreastFeedingUpdateResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Breathing/search: post: operationId: api_extensions_v1_user_module_result_Breathing_search_create_[retrieve_Breathing_results] summary: Retrieve Breathing Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BreathingResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Breathlessness: post: operationId: api_extensions_v1_user_module_result_Breathlessness_create_[create_Breathlessness] summary: Create Breathlessness parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Breathlessness/search: post: operationId: api_extensions_v1_user_module_result_Breathlessness_search_create_[retrieve_Breathlessness_results] summary: Retrieve Breathlessness Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BreathlessnessResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/CAT: post: operationId: api_extensions_v1_user_module_result_CAT_create_[create_CAT] summary: Create Cat parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/CAT/search: post: operationId: api_extensions_v1_user_module_result_CAT_search_create_[retrieve_CAT_results] summary: Retrieve Cat Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CATResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/CVDRiskScore: post: operationId: api_extensions_v1_user_module_result_CVDRiskScore_create_[create_CVDRiskScore] summary: Create Cvdriskscore parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AnyOfCreateBodyMeasurementDRF_Or_CreateHeartRateDRF_Or_CreateQuestionnaireDRFItem' application/x-www-form-urlencoded: schema: type: array items: $ref: '#/components/schemas/AnyOfCreateBodyMeasurementDRF_Or_CreateHeartRateDRF_Or_CreateQuestionnaireDRFItem' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/AnyOfCreateBodyMeasurementDRF_Or_CreateHeartRateDRF_Or_CreateQuestionnaireDRFItem' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/CVDRiskScore/search: post: operationId: api_extensions_v1_user_module_result_CVDRiskScore_search_create_[retrieve_CVDRiskScore_results] summary: Retrieve Cvdriskscore Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CVDRiskScoreResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Covid19DailyCheckIn/search: post: operationId: api_extensions_v1_user_module_result_Covid19DailyCheckIn_search_create_[retrieve_Covid19DailyCheckIn_results] summary: Retrieve Covid19Dailycheckin Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Covid19DailyCheckInResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Covid19RiskScore/search: post: operationId: api_extensions_v1_user_module_result_Covid19RiskScore_search_create_[retrieve_Covid19RiskScore_results] summary: Retrieve Covid19Riskscore Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Covid19RiskScoreResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/DailyCheckIn: post: operationId: api_extensions_v1_user_module_result_DailyCheckIn_create_[create_DailyCheckIn] summary: Create Dailycheckin parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/DailyCheckIn/search: post: operationId: api_extensions_v1_user_module_result_DailyCheckIn_search_create_[retrieve_DailyCheckIn_results] summary: Retrieve Dailycheckin Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DailyCheckInResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/DashScore: post: operationId: api_extensions_v1_user_module_result_DashScore_create_[create_DashScore] summary: Create Dashscore parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/DashScore/search: post: operationId: api_extensions_v1_user_module_result_DashScore_search_create_[retrieve_DashScore_results] summary: Retrieve Dashscore Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashScoreResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/DiabetesDistressScore: post: operationId: api_extensions_v1_user_module_result_DiabetesDistressScore_create_[create_DiabetesDistressScore] summary: Create Diabetesdistressscore parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/DiabetesDistressScore/search: post: operationId: api_extensions_v1_user_module_result_DiabetesDistressScore_search_create_[retrieve_DiabetesDistressScore_results] summary: Retrieve Diabetesdistressscore Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DiabetesDistressScoreResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/ECG: post: operationId: api_extensions_v1_user_module_result_ECG_create_[create_ECG] summary: Create Ecg parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateECGDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateECGDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateECGDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/ECG/search: post: operationId: api_extensions_v1_user_module_result_ECG_search_create_[retrieve_ECG_results] summary: Retrieve Ecg Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ECGResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/ECGAliveCor/search: post: operationId: api_extensions_v1_user_module_result_ECGAliveCor_search_create_[retrieve_ECGAliveCor_results] summary: Retrieve Ecgalivecor Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ECGAliveCorResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/ECGHealthKit/search: post: operationId: api_extensions_v1_user_module_result_ECGHealthKit_search_create_[retrieve_ECGHealthKit_results] summary: Retrieve Ecghealthkit Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ECGHealthKitResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/EQ5D5L: post: operationId: api_extensions_v1_user_module_result_EQ5D5L_create_[create_EQ5D5L] summary: Create Eq5D5L parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/EQ5D5L/search: post: operationId: api_extensions_v1_user_module_result_EQ5D5L_search_create_[retrieve_EQ5D5L_results] summary: Retrieve Eq5D5L Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EQ5D5LResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/FJSHip: post: operationId: api_extensions_v1_user_module_result_FJSHip_create_[create_FJSHip] summary: Create Fjship parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/FJSHip/search: post: operationId: api_extensions_v1_user_module_result_FJSHip_search_create_[retrieve_FJSHip_results] summary: Retrieve Fjship Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FJSHipResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/FJSKnee: post: operationId: api_extensions_v1_user_module_result_FJSKnee_create_[create_FJSKnee] summary: Create Fjsknee parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/FJSKnee/search: post: operationId: api_extensions_v1_user_module_result_FJSKnee_search_create_[retrieve_FJSKnee_results] summary: Retrieve Fjsknee Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FJSKneeResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/FeverAndPainDrugs/search: post: operationId: api_extensions_v1_user_module_result_FeverAndPainDrugs_search_create_[retrieve_FeverAndPainDrugs_results] summary: Retrieve Feverandpaindrugs Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FeverAndPainDrugsResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/GeneralAnxietyDisorder: post: operationId: api_extensions_v1_user_module_result_GeneralAnxietyDisorder_create_[create_GeneralAnxietyDisorder] summary: Create Generalanxietydisorder parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/GeneralAnxietyDisorder/search: post: operationId: api_extensions_v1_user_module_result_GeneralAnxietyDisorder_search_create_[retrieve_GeneralAnxietyDisorder_results] summary: Retrieve Generalanxietydisorder Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GeneralAnxietyDisorderResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Geolocation: post: operationId: api_extensions_v1_user_module_result_Geolocation_create_[create_Geolocation] summary: Create Geolocation parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateGeolocationDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateGeolocationDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateGeolocationDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Geolocation/search: post: operationId: api_extensions_v1_user_module_result_Geolocation_search_create_[retrieve_Geolocation_results] summary: Retrieve Geolocation Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GeolocationResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/HealthScore/search: post: operationId: api_extensions_v1_user_module_result_HealthScore_search_create_[retrieve_HealthScore_results] summary: Retrieve Healthscore Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HealthScoreResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/HealthStatus/search: post: operationId: api_extensions_v1_user_module_result_HealthStatus_search_create_[retrieve_HealthStatus_results] summary: Retrieve Healthstatus Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HealthStatusResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/HeartRate: post: operationId: api_extensions_v1_user_module_result_HeartRate_create_[create_HeartRate] summary: Create Heartrate parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/One Of: CreateHeartRateDRFSerializer, CreateFitbitHRVDRFSerializer, CreateHRVDRF' application/x-www-form-urlencoded: schema: type: array items: $ref: '#/components/schemas/One Of: CreateHeartRateDRFSerializer, CreateFitbitHRVDRFSerializer, CreateHRVDRF' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/One Of: CreateHeartRateDRFSerializer, CreateFitbitHRVDRFSerializer, CreateHRVDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/HeartRate/search: post: operationId: api_extensions_v1_user_module_result_HeartRate_search_create_[retrieve_HeartRate_results] summary: Retrieve Heartrate Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HeartRateResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Height/search: post: operationId: api_extensions_v1_user_module_result_Height_search_create_[retrieve_Height_results] summary: Retrieve Height Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HeightResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/HeightZScore/search: post: operationId: api_extensions_v1_user_module_result_HeightZScore_search_create_[retrieve_HeightZScore_results] summary: Retrieve Heightzscore Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HeightZScoreResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/HemophiliaJournal: post: operationId: api_extensions_v1_user_module_result_HemophiliaJournal_create_[create_HemophiliaJournal] summary: Create Hemophiliajournal parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateHemophiliaJournalDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateHemophiliaJournalDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateHemophiliaJournalDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/HemophiliaJournal/search: post: operationId: api_extensions_v1_user_module_result_HemophiliaJournal_search_create_[retrieve_HemophiliaJournal_results] summary: Retrieve Hemophiliajournal Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HemophiliaJournalResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/HighFrequencyHeartRate: post: operationId: api_extensions_v1_user_module_result_HighFrequencyHeartRate_create_[create_HighFrequencyHeartRate] summary: Create Highfrequencyheartrate parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateHighFrequencyHeartRateDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateHighFrequencyHeartRateDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateHighFrequencyHeartRateDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/HighFrequencyHeartRate/search: post: operationId: api_extensions_v1_user_module_result_HighFrequencyHeartRate_search_create_[retrieve_HighFrequencyHeartRate_results] summary: Retrieve Highfrequencyheartrate Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HighFrequencyHeartRateResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/HighFrequencyStep/search: post: operationId: api_extensions_v1_user_module_result_HighFrequencyStep_search_create_[retrieve_HighFrequencyStep_results] summary: Retrieve Highfrequencystep Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HighFrequencyStepResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Hypertension: post: operationId: api_extensions_v1_user_module_result_Hypertension_create_[create_Hypertension] summary: Create Hypertension parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AnyOfCreateBloodPressureDRF_Or_CreateSymptomDRFItem' application/x-www-form-urlencoded: schema: type: array items: $ref: '#/components/schemas/AnyOfCreateBloodPressureDRF_Or_CreateSymptomDRFItem' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/AnyOfCreateBloodPressureDRF_Or_CreateSymptomDRFItem' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Hypertension/search: post: operationId: api_extensions_v1_user_module_result_Hypertension_search_create_[retrieve_Hypertension_results] summary: Retrieve Hypertension Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HypertensionResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/IncidentReport: post: operationId: api_extensions_v1_user_module_result_IncidentReport_create_[create_IncidentReport] summary: Create Incidentreport parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/IncidentReport/search: post: operationId: api_extensions_v1_user_module_result_IncidentReport_search_create_[retrieve_IncidentReport_results] summary: Retrieve Incidentreport Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IncidentReportResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/InfantFollowUp/search: post: operationId: api_extensions_v1_user_module_result_InfantFollowUp_search_create_[retrieve_InfantFollowUp_results] summary: Retrieve Infantfollowup Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InfantFollowUpResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Journal: post: operationId: api_extensions_v1_user_module_result_Journal_create_[create_Journal] summary: Create Journal parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateJournalDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateJournalDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateJournalDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Journal/search: post: operationId: api_extensions_v1_user_module_result_Journal_search_create_[retrieve_Journal_results] summary: Retrieve Journal Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/JournalResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/KCCQ: post: operationId: api_extensions_v1_user_module_result_KCCQ_create_[create_KCCQ] summary: Create Kccq parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/KCCQ/search: post: operationId: api_extensions_v1_user_module_result_KCCQ_search_create_[retrieve_KCCQ_results] summary: Retrieve Kccq Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/KCCQResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/KOOS: post: operationId: api_extensions_v1_user_module_result_KOOS_create_[create_KOOS] summary: Create Koos parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/KOOS/search: post: operationId: api_extensions_v1_user_module_result_KOOS_search_create_[retrieve_KOOS_results] summary: Retrieve Koos Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/KOOSResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/KneeHealthIKDC: post: operationId: api_extensions_v1_user_module_result_KneeHealthIKDC_create_[create_KneeHealthIKDC] summary: Create Kneehealthikdc parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/KneeHealthIKDC/search: post: operationId: api_extensions_v1_user_module_result_KneeHealthIKDC_search_create_[retrieve_KneeHealthIKDC_results] summary: Retrieve Kneehealthikdc Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/KneeHealthIKDCResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/LysholmTegner: post: operationId: api_extensions_v1_user_module_result_LysholmTegner_create_[create_LysholmTegner] summary: Create Lysholmtegner parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/LysholmTegner/search: post: operationId: api_extensions_v1_user_module_result_LysholmTegner_search_create_[retrieve_LysholmTegner_results] summary: Retrieve Lysholmtegner Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/LysholmTegnerResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/MG_ADL: post: operationId: api_extensions_v1_user_module_result_MG_ADL_create_[create_MG_ADL] summary: Create Mg Adl parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/MG_ADL/search: post: operationId: api_extensions_v1_user_module_result_MG_ADL_search_create_[retrieve_MG_ADL_results] summary: Retrieve Mg Adl Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MG_ADLResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/MedicalHistory/search: post: operationId: api_extensions_v1_user_module_result_MedicalHistory_search_create_[retrieve_MedicalHistory_results] summary: Retrieve Medicalhistory Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MedicalHistoryResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/MedicationTracker: post: operationId: api_extensions_v1_user_module_result_MedicationTracker_create_[create_MedicationTracker] summary: Create Medicationtracker parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/MedicationTracker/search: post: operationId: api_extensions_v1_user_module_result_MedicationTracker_search_create_[retrieve_MedicationTracker_results] summary: Retrieve Medicationtracker Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MedicationTrackerResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Medications/search: post: operationId: api_extensions_v1_user_module_result_Medications_search_create_[retrieve_Medications_results] summary: Retrieve Medications Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/user/{user_id}/module-result/MedicationsV2/search: post: operationId: api_extensions_v1_user_module_result_MedicationsV2_search_create_[retrieve_MedicationsV2_results] summary: Retrieve Medicationsv2 Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/user/{user_id}/module-result/NDI: post: operationId: api_extensions_v1_user_module_result_NDI_create_[create_NDI] summary: Create Ndi parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/NDI/search: post: operationId: api_extensions_v1_user_module_result_NDI_search_create_[retrieve_NDI_results] summary: Retrieve Ndi Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/NDIResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/NORFOLK: post: operationId: api_extensions_v1_user_module_result_NORFOLK_create_[create_NORFOLK] summary: Create Norfolk parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/NORFOLK/search: post: operationId: api_extensions_v1_user_module_result_NORFOLK_search_create_[retrieve_NORFOLK_results] summary: Retrieve Norfolk Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/NORFOLKResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/OACS: post: operationId: api_extensions_v1_user_module_result_OACS_create_[create_OACS] summary: Create Oacs parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/OACS/search: post: operationId: api_extensions_v1_user_module_result_OACS_search_create_[retrieve_OACS_results] summary: Retrieve Oacs Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OACSResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/OARS: post: operationId: api_extensions_v1_user_module_result_OARS_create_[create_OARS] summary: Create Oars parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/OARS/search: post: operationId: api_extensions_v1_user_module_result_OARS_search_create_[retrieve_OARS_results] summary: Retrieve Oars Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OARSResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/ODI: post: operationId: api_extensions_v1_user_module_result_ODI_create_[create_ODI] summary: Create Odi parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/ODI/search: post: operationId: api_extensions_v1_user_module_result_ODI_search_create_[retrieve_ODI_results] summary: Retrieve Odi Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ODIResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/OtherVaccine/search: post: operationId: api_extensions_v1_user_module_result_OtherVaccine_search_create_[retrieve_OtherVaccine_results] summary: Retrieve Othervaccine Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OtherVaccineResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/OxfordHipScore: post: operationId: api_extensions_v1_user_module_result_OxfordHipScore_create_[create_OxfordHipScore] summary: Create Oxfordhipscore parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOxfordHipScoreDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateOxfordHipScoreDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateOxfordHipScoreDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/OxfordHipScore/search: post: operationId: api_extensions_v1_user_module_result_OxfordHipScore_search_create_[retrieve_OxfordHipScore_results] summary: Retrieve Oxfordhipscore Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OxfordHipScoreResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/OxfordKneeScore: post: operationId: api_extensions_v1_user_module_result_OxfordKneeScore_create_[create_OxfordKneeScore] summary: Create Oxfordkneescore parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOxfordKneeScoreDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateOxfordKneeScoreDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateOxfordKneeScoreDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/OxfordKneeScore/search: post: operationId: api_extensions_v1_user_module_result_OxfordKneeScore_search_create_[retrieve_OxfordKneeScore_results] summary: Retrieve Oxfordkneescore Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OxfordKneeScoreResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/OxfordShoulderScore: post: operationId: api_extensions_v1_user_module_result_OxfordShoulderScore_create_[create_OxfordShoulderScore] summary: Create Oxfordshoulderscore parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOxfordShoulderScoreDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateOxfordShoulderScoreDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateOxfordShoulderScoreDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/OxfordShoulderScore/search: post: operationId: api_extensions_v1_user_module_result_OxfordShoulderScore_search_create_[retrieve_OxfordShoulderScore_results] summary: Retrieve Oxfordshoulderscore Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OxfordShoulderScoreResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/OxygenSaturation: post: operationId: api_extensions_v1_user_module_result_OxygenSaturation_create_[create_OxygenSaturation] summary: Create Oxygensaturation parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOxygenSaturationDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateOxygenSaturationDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateOxygenSaturationDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/OxygenSaturation/search: post: operationId: api_extensions_v1_user_module_result_OxygenSaturation_search_create_[retrieve_OxygenSaturation_results] summary: Retrieve Oxygensaturation Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OxygenSaturationResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/PROMISGlobalHealth/search: post: operationId: api_extensions_v1_user_module_result_PROMISGlobalHealth_search_create_[retrieve_PROMISGlobalHealth_results] summary: Retrieve Promisglobalhealth Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PROMISGlobalHealthResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/PeakFlow: post: operationId: api_extensions_v1_user_module_result_PeakFlow_create_[create_PeakFlow] summary: Create Peakflow parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePeakFlowDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreatePeakFlowDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreatePeakFlowDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/PeakFlow/search: post: operationId: api_extensions_v1_user_module_result_PeakFlow_search_create_[retrieve_PeakFlow_results] summary: Retrieve Peakflow Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PeakFlowResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/PerceivedStressScale: post: operationId: api_extensions_v1_user_module_result_PerceivedStressScale_create_[create_PerceivedStressScale] summary: Create Perceivedstressscale parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/PerceivedStressScale/search: post: operationId: api_extensions_v1_user_module_result_PerceivedStressScale_search_create_[retrieve_PerceivedStressScale_results] summary: Retrieve Perceivedstressscale Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PerceivedStressScaleResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Photo: post: operationId: api_extensions_v1_user_module_result_Photo_create_[create_Photo] summary: Create Photo parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePhotoDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreatePhotoDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreatePhotoDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Photo/search: post: operationId: api_extensions_v1_user_module_result_Photo_search_create_[retrieve_Photo_results] summary: Retrieve Photo Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhotoResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/PostVaccination/search: post: operationId: api_extensions_v1_user_module_result_PostVaccination_search_create_[retrieve_PostVaccination_results] summary: Retrieve Postvaccination Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PostVaccinationResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/PreEclampsiaRisk: post: operationId: api_extensions_v1_user_module_result_PreEclampsiaRisk_create_[create_PreEclampsiaRisk] summary: Create Preeclampsiarisk parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/PreEclampsiaRisk/search: post: operationId: api_extensions_v1_user_module_result_PreEclampsiaRisk_search_create_[retrieve_PreEclampsiaRisk_results] summary: Retrieve Preeclampsiarisk Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PreEclampsiaRiskResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/PregnancyFollowUp/search: post: operationId: api_extensions_v1_user_module_result_PregnancyFollowUp_search_create_[retrieve_PregnancyFollowUp_results] summary: Retrieve Pregnancyfollowup Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PregnancyFollowUpResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/PregnancyStatus/search: post: operationId: api_extensions_v1_user_module_result_PregnancyStatus_search_create_[retrieve_PregnancyStatus_results] summary: Retrieve Pregnancystatus Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PregnancyStatusResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/PregnancyUpdate/search: post: operationId: api_extensions_v1_user_module_result_PregnancyUpdate_search_create_[retrieve_PregnancyUpdate_results] summary: Retrieve Pregnancyupdate Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PregnancyUpdateResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Ptosis: post: operationId: api_extensions_v1_user_module_result_Ptosis_create_[create_Ptosis] summary: Create Ptosis parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePtosisDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreatePtosisDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreatePtosisDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '202': description: No response body /api/extensions/v1/user/{user_id}/module-result/Ptosis/search: post: operationId: api_extensions_v1_user_module_result_Ptosis_search_create_[retrieve_Ptosis_results] summary: Retrieve Ptosis Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PtosisResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/PulseOximetry: post: operationId: api_extensions_v1_user_module_result_PulseOximetry_create_[create_PulseOximetry] summary: Create Pulseoximetry parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePulseOximetryDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreatePulseOximetryDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreatePulseOximetryDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/PulseOximetry/search: post: operationId: api_extensions_v1_user_module_result_PulseOximetry_search_create_[retrieve_PulseOximetry_results] summary: Retrieve Pulseoximetry Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PulseOximetryResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Questionnaire: post: operationId: api_extensions_v1_user_module_result_Questionnaire_create_[create_Questionnaire] summary: Create Questionnaire parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Questionnaire/{module_result_id}: put: operationId: api_extensions_v1_user_module_result_Questionnaire_update_[update_module_result_questionnaire] summary: Update Module Result Questionnaire parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateQuestionnaireObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateQuestionnaireObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateQuestionnaireObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/UpdateModuleResultFailureResponseDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Questionnaire/{result_id}: put: operationId: api_extensions_v1_user_module_result_Questionnaire_update_[extended_update_module_result_questionnaire] summary: Extended Update Module Result Questionnaire parameters: - in: path name: result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Extended Module requestBody: content: application/json: schema: $ref: '#/components/schemas/ExtendedUpdateQuestionnaireObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ExtendedUpdateQuestionnaireObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ExtendedUpdateQuestionnaireObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/UpdateModuleResultFailureResponseDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Questionnaire/search: post: operationId: api_extensions_v1_user_module_result_Questionnaire_search_create_[retrieve_Questionnaire_results] summary: Retrieve Questionnaire Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/QuestionnaireResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/RespiratoryRate: post: operationId: api_extensions_v1_user_module_result_RespiratoryRate_create_[create_RespiratoryRate] summary: Create Respiratoryrate parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRespiratoryRateDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateRespiratoryRateDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateRespiratoryRateDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/RespiratoryRate/search: post: operationId: api_extensions_v1_user_module_result_RespiratoryRate_search_create_[retrieve_RespiratoryRate_results] summary: Retrieve Respiratoryrate Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RespiratoryRateResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/RestingBreathingRate/search: post: operationId: api_extensions_v1_user_module_result_RestingBreathingRate_search_create_[retrieve_RestingBreathingRate_results] summary: Retrieve Restingbreathingrate Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RestingBreathingRateResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/RestingHeartRate: post: operationId: api_extensions_v1_user_module_result_RestingHeartRate_create_[create_RestingHeartRate] summary: Create Restingheartrate parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateHeartRateDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateHeartRateDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateHeartRateDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/RestingHeartRate/search: post: operationId: api_extensions_v1_user_module_result_RestingHeartRate_search_create_[retrieve_RestingHeartRate_results] summary: Retrieve Restingheartrate Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RestingHeartRateResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/RevereTest/search: post: operationId: api_extensions_v1_user_module_result_RevereTest_search_create_[retrieve_RevereTest_results] summary: Retrieve Reveretest Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RevereTestResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/SF36: post: operationId: api_extensions_v1_user_module_result_SF36_create_[create_SF36] summary: Create Sf36 parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/SF36/search: post: operationId: api_extensions_v1_user_module_result_SF36_search_create_[retrieve_SF36_results] summary: Retrieve Sf36 Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SF36ResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/SRS: post: operationId: api_extensions_v1_user_module_result_SRS_create_[create_SRS] summary: Create Srs parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/SRS/search: post: operationId: api_extensions_v1_user_module_result_SRS_search_create_[retrieve_SRS_results] summary: Retrieve Srs Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SRSResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/SelfRatedHealth: post: operationId: api_extensions_v1_user_module_result_SelfRatedHealth_create_[create_SelfRatedHealth] summary: Create Selfratedhealth parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/SelfRatedHealth/search: post: operationId: api_extensions_v1_user_module_result_SelfRatedHealth_search_create_[retrieve_SelfRatedHealth_results] summary: Retrieve Selfratedhealth Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SelfRatedHealthResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Sleep: post: operationId: api_extensions_v1_user_module_result_Sleep_create_[create_Sleep] summary: Create Sleep parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSleepDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateSleepDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateSleepDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Sleep/search: post: operationId: api_extensions_v1_user_module_result_Sleep_search_create_[retrieve_Sleep_results] summary: Retrieve Sleep Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SleepResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/SpatialSpaniOS: post: operationId: api_extensions_v1_user_module_result_SpatialSpaniOS_create_[create_SpatialSpaniOS] summary: Create Spatialspanios parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSpatialSpaniOSDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateSpatialSpaniOSDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateSpatialSpaniOSDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/SpatialSpaniOS/search: post: operationId: api_extensions_v1_user_module_result_SpatialSpaniOS_search_create_[retrieve_SpatialSpaniOS_results] summary: Retrieve Spatialspanios Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpatialSpaniOSResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Spirometry: post: operationId: api_extensions_v1_user_module_result_Spirometry_create_[create_Spirometry] summary: Create Spirometry parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSpirometryDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateSpirometryDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateSpirometryDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Spirometry/search: post: operationId: api_extensions_v1_user_module_result_Spirometry_search_create_[retrieve_Spirometry_results] summary: Retrieve Spirometry Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpirometryResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Step: post: operationId: api_extensions_v1_user_module_result_Step_create_[create_Step] summary: Create Step parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateStepDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateStepDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateStepDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Step/search: post: operationId: api_extensions_v1_user_module_result_Step_search_create_[retrieve_Step_results] summary: Retrieve Step Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/StepResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/SurgeryDetails: post: operationId: api_extensions_v1_user_module_result_SurgeryDetails_create_[create_SurgeryDetails] summary: Create Surgerydetails parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/SurgeryDetails/search: post: operationId: api_extensions_v1_user_module_result_SurgeryDetails_search_create_[retrieve_SurgeryDetails_results] summary: Retrieve Surgerydetails Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SurgeryDetailsResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Symptom: post: operationId: api_extensions_v1_user_module_result_Symptom_create_[create_Symptom] summary: Create Symptom parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSymptomDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateSymptomDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateSymptomDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Symptom/search: post: operationId: api_extensions_v1_user_module_result_Symptom_search_create_[retrieve_Symptom_results] summary: Retrieve Symptom Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SymptomResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/SymptomV2: post: operationId: api_extensions_v1_user_module_result_SymptomV2_create_[create_SymptomV2] summary: Create Symptomv2 parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AnyOfCreateQuestionnaireDRF_Or_CreateSymptomDRFItem' application/x-www-form-urlencoded: schema: type: array items: $ref: '#/components/schemas/AnyOfCreateQuestionnaireDRF_Or_CreateSymptomDRFItem' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/AnyOfCreateQuestionnaireDRF_Or_CreateSymptomDRFItem' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/SymptomV2/search: post: operationId: api_extensions_v1_user_module_result_SymptomV2_search_create_[retrieve_SymptomV2_results] summary: Retrieve Symptomv2 Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SymptomV2ResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/TakenMedication: post: operationId: api_extensions_v1_user_module_result_TakenMedication_create_[create_TakenMedication] summary: Create Takenmedication parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTakenMedicationDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateTakenMedicationDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateTakenMedicationDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/TakenMedication/search: post: operationId: api_extensions_v1_user_module_result_TakenMedication_search_create_[retrieve_TakenMedication_results] summary: Retrieve Takenmedication Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TakenMedicationResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Temperature: post: operationId: api_extensions_v1_user_module_result_Temperature_create_[create_Temperature] summary: Create Temperature parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTemperatureDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateTemperatureDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateTemperatureDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Temperature/search: post: operationId: api_extensions_v1_user_module_result_Temperature_search_create_[retrieve_Temperature_results] summary: Retrieve Temperature Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemperatureResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/VR_12: post: operationId: api_extensions_v1_user_module_result_VR_12_create_[create_VR_12] summary: Create Vr 12 parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/VR_12/search: post: operationId: api_extensions_v1_user_module_result_VR_12_search_create_[retrieve_VR_12_results] summary: Retrieve Vr 12 Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VR_12ResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/VaccinationDetails/search: post: operationId: api_extensions_v1_user_module_result_VaccinationDetails_search_create_[retrieve_VaccinationDetails_results] summary: Retrieve Vaccinationdetails Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VaccinationDetailsResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/VirtualCare: post: operationId: api_extensions_v1_user_module_result_VirtualCare_create_[create_VirtualCare] summary: Create Virtualcare parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVirtualCareDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateVirtualCareDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateVirtualCareDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/VirtualCare/search: post: operationId: api_extensions_v1_user_module_result_VirtualCare_search_create_[retrieve_VirtualCare_results] summary: Retrieve Virtualcare Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualCareResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/VoiceAssessments: post: operationId: api_extensions_v1_user_module_result_VoiceAssessments_create_[create_VoiceAssessments] summary: Create Voiceassessments parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AnyOfCreateDysarthriaDRF_Or_CreateDysphoniaDRFItem' application/x-www-form-urlencoded: schema: type: array items: $ref: '#/components/schemas/AnyOfCreateDysarthriaDRF_Or_CreateDysphoniaDRFItem' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/AnyOfCreateDysarthriaDRF_Or_CreateDysphoniaDRFItem' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '202': description: No response body /api/extensions/v1/user/{user_id}/module-result/VoiceAssessments/search: post: operationId: api_extensions_v1_user_module_result_VoiceAssessments_search_create_[retrieve_VoiceAssessments_results] summary: Retrieve Voiceassessments Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VoiceAssessmentsResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/WHO: post: operationId: api_extensions_v1_user_module_result_WHO_create_[create_WHO] summary: Create Who parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/WHO/search: post: operationId: api_extensions_v1_user_module_result_WHO_search_create_[retrieve_WHO_results] summary: Retrieve Who Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WHOResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/WHQ: post: operationId: api_extensions_v1_user_module_result_WHQ_create_[create_WHQ] summary: Create Whq parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateQuestionnaireDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/WHQ/search: post: operationId: api_extensions_v1_user_module_result_WHQ_search_create_[retrieve_WHQ_results] summary: Retrieve Whq Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WHQResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/WaistToHeight/search: post: operationId: api_extensions_v1_user_module_result_WaistToHeight_search_create_[retrieve_WaistToHeight_results] summary: Retrieve Waisttoheight Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WaistToHeightResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Weight: post: operationId: api_extensions_v1_user_module_result_Weight_create_[create_Weight] summary: Create Weight parameters: - in: query name: moduleConfigId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateWeightDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateWeightDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateWeightDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/Weight/search: post: operationId: api_extensions_v1_user_module_result_Weight_search_create_[retrieve_Weight_results] summary: Retrieve Weight Results parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveModuleResultsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WeightResultsDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/aggregate: post: operationId: api_extensions_v1_user_module_result_aggregate_create_[retrieve_aggregated] summary: Retrieve Aggregated parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/AggregateModuleResultsRequestObjectsDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AggregateModuleResultsRequestObjectsDRF' multipart/form-data: schema: $ref: '#/components/schemas/AggregateModuleResultsRequestObjectsDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AggregateModuleResultsResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/module-result/search: post: operationId: api_extensions_v1_user_module_result_search_create_[search_module_results_api] summary: Search Module Results Api parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchModuleResultsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SearchModuleResultsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/SearchModuleResultsRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: {} /api/extensions/v1/user/{user_id}/moduleConfig/{module_config_id}: put: operationId: api_extensions_v1_user_moduleConfig_update_[create_or_update_custom_module_config_for_user] summary: Create Or Update Custom Module Config For User parameters: - in: path name: module_config_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Custom Module Config security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/user/{user_id}/moduleConfig/{module_config_id}/logs: get: operationId: api_extensions_v1_user_moduleConfig_logs_retrieve_[retrieve_custom_module_config_logs_for_user] summary: Retrieve Custom Module Config Logs For User parameters: - in: path name: module_config_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Custom Module Config security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/user/{user_id}/moduleConfigs: get: operationId: api_extensions_v1_user_moduleConfigs_retrieve_[retrieve_custom_module_configs_of_user] summary: Retrieve Custom Module Configs Of User parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Custom Module Config security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1/user/{user_id}/move/{target_deployment_id}: post: operationId: api_extensions_v1_user_move_create_[move_user] description: |- Move user Move a user to a different deployment. summary: Move User parameters: - in: path name: target_deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/MoveUserRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MoveUserRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/MoveUserRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/move/ack/{acknowledge_id}: put: operationId: api_extensions_v1_user_move_ack_update_[acknowledge_move] description: |- Acknowledge move user Acknowledge the user's move to a new deployment. summary: Acknowledge Move parameters: - in: path name: acknowledge_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/move/history: get: operationId: api_extensions_v1_user_move_history_retrieve_[retrieve_move_user_history] description: |- Retrieve move user history Retrieve the move history of a user. summary: Retrieve Move User History parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveMoveUserHistoryResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/offboard: post: operationId: api_extensions_v1_user_offboard_create_[off_board_user] description: |- Offboard user Offboard a user from a deployment. summary: Off Board User parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/overview-chart: post: operationId: api_extensions_v1_user_overview_chart_create_[retrieve_overview_chart] summary: Retrieve Overview Chart parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/OverviewChartRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OverviewChartRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/OverviewChartRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OverviewChartDataDRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AHQ/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_AHQ_retrieve_[retrieve_primitive_AHQ] summary: Retrieve Primitive Ahq parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AHQDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AHQ/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_AHQ_event_log_retrieve_[retrieve_AHQ_by_event_log] summary: Retrieve Ahq By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AHQDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AZFurtherPregnancyKeyActionTrigger/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_AZFurtherPregnancyKeyActionTrigger_retrieve_[retrieve_primitive_AZFurtherPregnancyKeyActionTrigger] summary: Retrieve Primitive Azfurtherpregnancykeyactiontrigger parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AZFurtherPregnancyKeyActionTriggerDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AZFurtherPregnancyKeyActionTrigger/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_AZFurtherPregnancyKeyActionTrigger_event_log_retrieve_[retrieve_AZFurtherPregnancyKeyActionTrigger_by_event_log] summary: Retrieve Azfurtherpregnancykeyactiontrigger By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AZFurtherPregnancyKeyActionTriggerDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AZGroupKeyActionTrigger/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_AZGroupKeyActionTrigger_retrieve_[retrieve_primitive_AZGroupKeyActionTrigger] summary: Retrieve Primitive Azgroupkeyactiontrigger parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AZGroupKeyActionTriggerDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AZGroupKeyActionTrigger/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_AZGroupKeyActionTrigger_event_log_retrieve_[retrieve_AZGroupKeyActionTrigger_by_event_log] summary: Retrieve Azgroupkeyactiontrigger By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AZGroupKeyActionTriggerDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AZScreeningQuestionnaire/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_AZScreeningQuestionnaire_retrieve_[retrieve_primitive_AZScreeningQuestionnaire] summary: Retrieve Primitive Azscreeningquestionnaire parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AZScreeningQuestionnaireDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AZScreeningQuestionnaire/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_AZScreeningQuestionnaire_event_log_retrieve_[retrieve_AZScreeningQuestionnaire_by_event_log] summary: Retrieve Azscreeningquestionnaire By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AZScreeningQuestionnaireDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AdditionalQoL/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_AdditionalQoL_retrieve_[retrieve_primitive_AdditionalQoL] summary: Retrieve Primitive Additionalqol parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdditionalQoLDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AdditionalQoL/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_AdditionalQoL_event_log_retrieve_[retrieve_AdditionalQoL_by_event_log] summary: Retrieve Additionalqol By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdditionalQoLDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AirQualityIndex/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_AirQualityIndex_retrieve_[retrieve_primitive_AirQualityIndex] summary: Retrieve Primitive Airqualityindex parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AirQualityIndexDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AirQualityIndex/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_AirQualityIndex_event_log_retrieve_[retrieve_AirQualityIndex_by_event_log] summary: Retrieve Airqualityindex By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AirQualityIndexDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AlcoholConsumption/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_AlcoholConsumption_retrieve_[retrieve_primitive_AlcoholConsumption] summary: Retrieve Primitive Alcoholconsumption parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlcoholConsumptionDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AlcoholConsumption/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_AlcoholConsumption_event_log_retrieve_[retrieve_AlcoholConsumption_by_event_log] summary: Retrieve Alcoholconsumption By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlcoholConsumptionDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/ArmFatigue/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_ArmFatigue_retrieve_[retrieve_primitive_ArmFatigue] summary: Retrieve Primitive Armfatigue parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ArmFatigueDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/ArmFatigue/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_ArmFatigue_event_log_retrieve_[retrieve_ArmFatigue_by_event_log] summary: Retrieve Armfatigue By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ArmFatigueDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AsthmaControlTest/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_AsthmaControlTest_retrieve_[retrieve_primitive_AsthmaControlTest] summary: Retrieve Primitive Asthmacontroltest parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AsthmaControlTestDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AsthmaControlTest/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_AsthmaControlTest_event_log_retrieve_[retrieve_AsthmaControlTest_by_event_log] summary: Retrieve Asthmacontroltest By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AsthmaControlTestDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AwarenessTraining/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_AwarenessTraining_retrieve_[retrieve_primitive_AwarenessTraining] summary: Retrieve Primitive Awarenesstraining parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AwarenessTrainingDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/AwarenessTraining/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_AwarenessTraining_event_log_retrieve_[retrieve_AwarenessTraining_by_event_log] summary: Retrieve Awarenesstraining By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AwarenessTrainingDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BMI/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_BMI_retrieve_[retrieve_primitive_BMI] summary: Retrieve Primitive Bmi parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BMIDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BMI/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_BMI_event_log_retrieve_[retrieve_BMI_by_event_log] summary: Retrieve Bmi By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BMIDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BackgroundInformation/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_BackgroundInformation_retrieve_[retrieve_primitive_BackgroundInformation] summary: Retrieve Primitive Backgroundinformation parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BackgroundInformationDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BackgroundInformation/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_BackgroundInformation_event_log_retrieve_[retrieve_BackgroundInformation_by_event_log] summary: Retrieve Backgroundinformation By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BackgroundInformationDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BloodGlucose/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_BloodGlucose_retrieve_[retrieve_primitive_BloodGlucose] summary: Retrieve Primitive Bloodglucose parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BloodGlucoseDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BloodGlucose/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_BloodGlucose_event_log_retrieve_[retrieve_BloodGlucose_by_event_log] summary: Retrieve Bloodglucose By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BloodGlucoseDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BloodPressure/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_BloodPressure_retrieve_[retrieve_primitive_BloodPressure] summary: Retrieve Primitive Bloodpressure parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BloodPressureDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BloodPressure/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_BloodPressure_event_log_retrieve_[retrieve_BloodPressure_by_event_log] summary: Retrieve Bloodpressure By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BloodPressureDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BodyComposition/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_BodyComposition_retrieve_[retrieve_primitive_BodyComposition] summary: Retrieve Primitive Bodycomposition parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BodyCompositionDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BodyComposition/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_BodyComposition_event_log_retrieve_[retrieve_BodyComposition_by_event_log] summary: Retrieve Bodycomposition By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BodyCompositionDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BodyMeasurement/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_BodyMeasurement_retrieve_[retrieve_primitive_BodyMeasurement] summary: Retrieve Primitive Bodymeasurement parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BodyMeasurementDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BodyMeasurement/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_BodyMeasurement_event_log_retrieve_[retrieve_BodyMeasurement_by_event_log] summary: Retrieve Bodymeasurement By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BodyMeasurementDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BodyPower/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_BodyPower_retrieve_[retrieve_primitive_BodyPower] summary: Retrieve Primitive Bodypower parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BodyPowerDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BodyPower/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_BodyPower_event_log_retrieve_[retrieve_BodyPower_by_event_log] summary: Retrieve Bodypower By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BodyPowerDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BodyStress/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_BodyStress_retrieve_[retrieve_primitive_BodyStress] summary: Retrieve Primitive Bodystress parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BodyStressDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BodyStress/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_BodyStress_event_log_retrieve_[retrieve_BodyStress_by_event_log] summary: Retrieve Bodystress By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BodyStressDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BreastFeedingStatus/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_BreastFeedingStatus_retrieve_[retrieve_primitive_BreastFeedingStatus] summary: Retrieve Primitive Breastfeedingstatus parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BreastFeedingStatusDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BreastFeedingStatus/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_BreastFeedingStatus_event_log_retrieve_[retrieve_BreastFeedingStatus_by_event_log] summary: Retrieve Breastfeedingstatus By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BreastFeedingStatusDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BreastFeedingUpdate/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_BreastFeedingUpdate_retrieve_[retrieve_primitive_BreastFeedingUpdate] summary: Retrieve Primitive Breastfeedingupdate parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BreastFeedingUpdateDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/BreastFeedingUpdate/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_BreastFeedingUpdate_event_log_retrieve_[retrieve_BreastFeedingUpdate_by_event_log] summary: Retrieve Breastfeedingupdate By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BreastFeedingUpdateDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/CAT/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_CAT_retrieve_[retrieve_primitive_CAT] summary: Retrieve Primitive Cat parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CATDRF' description: '' /api/extensions/v1/user/{user_id}/primitive/CAT/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_CAT_event_log_retrieve_[retrieve_CAT_by_event_log] summary: Retrieve Cat By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CATDRF' description: '' /api/extensions/v1/user/{user_id}/primitive/CVDRiskScore/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_CVDRiskScore_retrieve_[retrieve_primitive_CVDRiskScore] summary: Retrieve Primitive Cvdriskscore parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CVDRiskScoreDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/CVDRiskScore/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_CVDRiskScore_event_log_retrieve_[retrieve_CVDRiskScore_by_event_log] summary: Retrieve Cvdriskscore By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CVDRiskScoreDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Covid19DailyCheckIn/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Covid19DailyCheckIn_retrieve_[retrieve_primitive_Covid19DailyCheckIn] summary: Retrieve Primitive Covid19Dailycheckin parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Covid19DailyCheckInDRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Covid19DailyCheckIn/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Covid19DailyCheckIn_event_log_retrieve_[retrieve_Covid19DailyCheckIn_by_event_log] summary: Retrieve Covid19Dailycheckin By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Covid19DailyCheckInDRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Covid19RiskScore/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Covid19RiskScore_retrieve_[retrieve_primitive_Covid19RiskScore] summary: Retrieve Primitive Covid19Riskscore parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Covid19RiskScoreDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Covid19RiskScore/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Covid19RiskScore_event_log_retrieve_[retrieve_Covid19RiskScore_by_event_log] summary: Retrieve Covid19Riskscore By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Covid19RiskScoreDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Covid19RiskScoreCoreQuestions/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Covid19RiskScoreCoreQuestions_retrieve_[retrieve_primitive_Covid19RiskScoreCoreQuestions] summary: Retrieve Primitive Covid19Riskscorecorequestions parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Covid19RiskScoreCoreQuestionsDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Covid19RiskScoreCoreQuestions/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Covid19RiskScoreCoreQuestions_event_log_retrieve_[retrieve_Covid19RiskScoreCoreQuestions_by_event_log] summary: Retrieve Covid19Riskscorecorequestions By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Covid19RiskScoreCoreQuestionsDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/DashScore/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_DashScore_retrieve_[retrieve_primitive_DashScore] summary: Retrieve Primitive Dashscore parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashScoreDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/DashScore/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_DashScore_event_log_retrieve_[retrieve_DashScore_by_event_log] summary: Retrieve Dashscore By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashScoreDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/DiabetesDistressScore/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_DiabetesDistressScore_retrieve_[retrieve_primitive_DiabetesDistressScore] summary: Retrieve Primitive Diabetesdistressscore parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DiabetesDistressScoreDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/DiabetesDistressScore/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_DiabetesDistressScore_event_log_retrieve_[retrieve_DiabetesDistressScore_by_event_log] summary: Retrieve Diabetesdistressscore By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DiabetesDistressScoreDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Dysarthria/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Dysarthria_retrieve_[retrieve_primitive_Dysarthria] summary: Retrieve Primitive Dysarthria parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DysarthriaDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Dysarthria/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Dysarthria_event_log_retrieve_[retrieve_Dysarthria_by_event_log] summary: Retrieve Dysarthria By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DysarthriaDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Dysphonia/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Dysphonia_retrieve_[retrieve_primitive_Dysphonia] summary: Retrieve Primitive Dysphonia parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DysphoniaDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Dysphonia/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Dysphonia_event_log_retrieve_[retrieve_Dysphonia_by_event_log] summary: Retrieve Dysphonia By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DysphoniaDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/ECG/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_ECG_retrieve_[retrieve_primitive_ECG] summary: Retrieve Primitive Ecg parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ECGDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/ECG/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_ECG_event_log_retrieve_[retrieve_ECG_by_event_log] summary: Retrieve Ecg By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ECGDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/ECGAliveCor/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_ECGAliveCor_retrieve_[retrieve_primitive_ECGAliveCor] summary: Retrieve Primitive Ecgalivecor parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ECGAliveCorDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/ECGAliveCor/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_ECGAliveCor_event_log_retrieve_[retrieve_ECGAliveCor_by_event_log] summary: Retrieve Ecgalivecor By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ECGAliveCorDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/ECGHealthKit/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_ECGHealthKit_retrieve_[retrieve_primitive_ECGHealthKit] summary: Retrieve Primitive Ecghealthkit parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ECGHealthKitDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/ECGHealthKit/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_ECGHealthKit_event_log_retrieve_[retrieve_ECGHealthKit_by_event_log] summary: Retrieve Ecghealthkit By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ECGHealthKitDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/EQ5D5L/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_EQ5D5L_retrieve_[retrieve_primitive_EQ5D5L] summary: Retrieve Primitive Eq5D5L parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EQ5D5LDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/EQ5D5L/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_EQ5D5L_event_log_retrieve_[retrieve_EQ5D5L_by_event_log] summary: Retrieve Eq5D5L By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EQ5D5LDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/FeverAndPainDrugs/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_FeverAndPainDrugs_retrieve_[retrieve_primitive_FeverAndPainDrugs] summary: Retrieve Primitive Feverandpaindrugs parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FeverAndPainDrugsDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/FeverAndPainDrugs/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_FeverAndPainDrugs_event_log_retrieve_[retrieve_FeverAndPainDrugs_by_event_log] summary: Retrieve Feverandpaindrugs By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FeverAndPainDrugsDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/FitbitHRV/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_FitbitHRV_retrieve_[retrieve_primitive_FitbitHRV] summary: Retrieve Primitive Fitbithrv parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FitbitHRVDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/FitbitHRV/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_FitbitHRV_event_log_retrieve_[retrieve_FitbitHRV_by_event_log] summary: Retrieve Fitbithrv By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FitbitHRVDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Geolocation/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Geolocation_retrieve_[retrieve_primitive_Geolocation] summary: Retrieve Primitive Geolocation parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GeolocationDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Geolocation/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Geolocation_event_log_retrieve_[retrieve_Geolocation_by_event_log] summary: Retrieve Geolocation By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GeolocationDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/HRV/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_HRV_retrieve_[retrieve_primitive_HRV] summary: Retrieve Primitive Hrv parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HRVDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/HRV/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_HRV_event_log_retrieve_[retrieve_HRV_by_event_log] summary: Retrieve Hrv By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HRVDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/HScore/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_HScore_retrieve_[retrieve_primitive_HScore] summary: Retrieve Primitive Hscore parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HScoreDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/HScore/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_HScore_event_log_retrieve_[retrieve_HScore_by_event_log] summary: Retrieve Hscore By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HScoreDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/HealthStatus/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_HealthStatus_retrieve_[retrieve_primitive_HealthStatus] summary: Retrieve Primitive Healthstatus parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HealthStatusDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/HealthStatus/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_HealthStatus_event_log_retrieve_[retrieve_HealthStatus_by_event_log] summary: Retrieve Healthstatus By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HealthStatusDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/HeartRate/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_HeartRate_retrieve_[retrieve_primitive_HeartRate] summary: Retrieve Primitive Heartrate parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HeartRateDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/HeartRate/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_HeartRate_event_log_retrieve_[retrieve_HeartRate_by_event_log] summary: Retrieve Heartrate By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HeartRateDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Height/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Height_retrieve_[retrieve_primitive_Height] summary: Retrieve Primitive Height parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HeightDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Height/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Height_event_log_retrieve_[retrieve_Height_by_event_log] summary: Retrieve Height By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HeightDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/HemophiliaJournal/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_HemophiliaJournal_retrieve_[retrieve_primitive_HemophiliaJournal] summary: Retrieve Primitive Hemophiliajournal parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HemophiliaJournalDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/HemophiliaJournal/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_HemophiliaJournal_event_log_retrieve_[retrieve_HemophiliaJournal_by_event_log] summary: Retrieve Hemophiliajournal By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HemophiliaJournalDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/HighFrequencyHeartRate/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_HighFrequencyHeartRate_retrieve_[retrieve_primitive_HighFrequencyHeartRate] summary: Retrieve Primitive Highfrequencyheartrate parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HighFrequencyHeartRateDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/HighFrequencyHeartRate/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_HighFrequencyHeartRate_event_log_retrieve_[retrieve_HighFrequencyHeartRate_by_event_log] summary: Retrieve Highfrequencyheartrate By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HighFrequencyHeartRateDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/HighFrequencyStep/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_HighFrequencyStep_retrieve_[retrieve_primitive_HighFrequencyStep] summary: Retrieve Primitive Highfrequencystep parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HighFrequencyStepDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/HighFrequencyStep/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_HighFrequencyStep_event_log_retrieve_[retrieve_HighFrequencyStep_by_event_log] summary: Retrieve Highfrequencystep By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HighFrequencyStepDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/IKDC/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_IKDC_retrieve_[retrieve_primitive_IKDC] summary: Retrieve Primitive Ikdc parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IKDCDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/IKDC/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_IKDC_event_log_retrieve_[retrieve_IKDC_by_event_log] summary: Retrieve Ikdc By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IKDCDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/InfantFollowUp/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_InfantFollowUp_retrieve_[retrieve_primitive_InfantFollowUp] summary: Retrieve Primitive Infantfollowup parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InfantFollowUpDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/InfantFollowUp/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_InfantFollowUp_event_log_retrieve_[retrieve_InfantFollowUp_by_event_log] summary: Retrieve Infantfollowup By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InfantFollowUpDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Journal/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Journal_retrieve_[retrieve_primitive_Journal] summary: Retrieve Primitive Journal parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/JournalDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Journal/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Journal_event_log_retrieve_[retrieve_Journal_by_event_log] summary: Retrieve Journal By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/JournalDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/KCCQ/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_KCCQ_retrieve_[retrieve_primitive_KCCQ] summary: Retrieve Primitive Kccq parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/KCCQDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/KCCQ/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_KCCQ_event_log_retrieve_[retrieve_KCCQ_by_event_log] summary: Retrieve Kccq By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/KCCQDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/KOOS/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_KOOS_retrieve_[retrieve_primitive_KOOS] summary: Retrieve Primitive Koos parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/KOOSDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/KOOS/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_KOOS_event_log_retrieve_[retrieve_KOOS_by_event_log] summary: Retrieve Koos By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/KOOSDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Lysholm/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Lysholm_retrieve_[retrieve_primitive_Lysholm] summary: Retrieve Primitive Lysholm parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/LysholmDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Lysholm/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Lysholm_event_log_retrieve_[retrieve_Lysholm_by_event_log] summary: Retrieve Lysholm By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/LysholmDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/MG_ADL/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_MG_ADL_retrieve_[retrieve_primitive_MG_ADL] summary: Retrieve Primitive Mg Adl parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MG_ADLDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/MG_ADL/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_MG_ADL_event_log_retrieve_[retrieve_MG_ADL_by_event_log] summary: Retrieve Mg Adl By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MG_ADLDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/MedicalHistory/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_MedicalHistory_retrieve_[retrieve_primitive_MedicalHistory] summary: Retrieve Primitive Medicalhistory parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MedicalHistoryDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/MedicalHistory/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_MedicalHistory_event_log_retrieve_[retrieve_MedicalHistory_by_event_log] summary: Retrieve Medicalhistory By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MedicalHistoryDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/NDI/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_NDI_retrieve_[retrieve_primitive_NDI] summary: Retrieve Primitive Ndi parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/NDIDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/NDI/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_NDI_event_log_retrieve_[retrieve_NDI_by_event_log] summary: Retrieve Ndi By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/NDIDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/NORFOLK/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_NORFOLK_retrieve_[retrieve_primitive_NORFOLK] summary: Retrieve Primitive Norfolk parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/NORFOLKDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/NORFOLK/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_NORFOLK_event_log_retrieve_[retrieve_NORFOLK_by_event_log] summary: Retrieve Norfolk By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/NORFOLKDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/NumericMemory/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_NumericMemory_retrieve_[retrieve_primitive_NumericMemory] summary: Retrieve Primitive Numericmemory parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/NumericMemoryDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/NumericMemory/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_NumericMemory_event_log_retrieve_[retrieve_NumericMemory_by_event_log] summary: Retrieve Numericmemory By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/NumericMemoryDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/OACS/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_OACS_retrieve_[retrieve_primitive_OACS] summary: Retrieve Primitive Oacs parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OACSDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/OACS/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_OACS_event_log_retrieve_[retrieve_OACS_by_event_log] summary: Retrieve Oacs By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OACSDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/OARS/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_OARS_retrieve_[retrieve_primitive_OARS] summary: Retrieve Primitive Oars parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OARSDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/OARS/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_OARS_event_log_retrieve_[retrieve_OARS_by_event_log] summary: Retrieve Oars By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OARSDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/ODI/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_ODI_retrieve_[retrieve_primitive_ODI] summary: Retrieve Primitive Odi parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ODIDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/ODI/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_ODI_event_log_retrieve_[retrieve_ODI_by_event_log] summary: Retrieve Odi By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ODIDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/OtherVaccine/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_OtherVaccine_retrieve_[retrieve_primitive_OtherVaccine] summary: Retrieve Primitive Othervaccine parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OtherVaccineDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/OtherVaccine/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_OtherVaccine_event_log_retrieve_[retrieve_OtherVaccine_by_event_log] summary: Retrieve Othervaccine By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OtherVaccineDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/OxfordHipScore/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_OxfordHipScore_retrieve_[retrieve_primitive_OxfordHipScore] summary: Retrieve Primitive Oxfordhipscore parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OxfordHipScoreDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/OxfordHipScore/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_OxfordHipScore_event_log_retrieve_[retrieve_OxfordHipScore_by_event_log] summary: Retrieve Oxfordhipscore By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OxfordHipScoreDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/OxfordKneeScore/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_OxfordKneeScore_retrieve_[retrieve_primitive_OxfordKneeScore] summary: Retrieve Primitive Oxfordkneescore parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OxfordKneeScoreDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/OxfordKneeScore/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_OxfordKneeScore_event_log_retrieve_[retrieve_OxfordKneeScore_by_event_log] summary: Retrieve Oxfordkneescore By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OxfordKneeScoreDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/OxfordShoulderScore/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_OxfordShoulderScore_retrieve_[retrieve_primitive_OxfordShoulderScore] summary: Retrieve Primitive Oxfordshoulderscore parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OxfordShoulderScoreDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/OxfordShoulderScore/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_OxfordShoulderScore_event_log_retrieve_[retrieve_OxfordShoulderScore_by_event_log] summary: Retrieve Oxfordshoulderscore By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OxfordShoulderScoreDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/OxygenSaturation/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_OxygenSaturation_retrieve_[retrieve_primitive_OxygenSaturation] summary: Retrieve Primitive Oxygensaturation parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OxygenSaturationDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/OxygenSaturation/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_OxygenSaturation_event_log_retrieve_[retrieve_OxygenSaturation_by_event_log] summary: Retrieve Oxygensaturation By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OxygenSaturationDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/PROMISGlobalHealth/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_PROMISGlobalHealth_retrieve_[retrieve_primitive_PROMISGlobalHealth] summary: Retrieve Primitive Promisglobalhealth parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PROMISGlobalHealthDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/PROMISGlobalHealth/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_PROMISGlobalHealth_event_log_retrieve_[retrieve_PROMISGlobalHealth_by_event_log] summary: Retrieve Promisglobalhealth By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PROMISGlobalHealthDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/PeakFlow/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_PeakFlow_retrieve_[retrieve_primitive_PeakFlow] summary: Retrieve Primitive Peakflow parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PeakFlowDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/PeakFlow/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_PeakFlow_event_log_retrieve_[retrieve_PeakFlow_by_event_log] summary: Retrieve Peakflow By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PeakFlowDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/PerceivedStressScale/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_PerceivedStressScale_retrieve_[retrieve_primitive_PerceivedStressScale] summary: Retrieve Primitive Perceivedstressscale parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PerceivedStressScaleDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/PerceivedStressScale/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_PerceivedStressScale_event_log_retrieve_[retrieve_PerceivedStressScale_by_event_log] summary: Retrieve Perceivedstressscale By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PerceivedStressScaleDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Photo/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Photo_retrieve_[retrieve_primitive_Photo] summary: Retrieve Primitive Photo parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhotoDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Photo/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Photo_event_log_retrieve_[retrieve_Photo_by_event_log] summary: Retrieve Photo By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhotoDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/PostVaccination/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_PostVaccination_retrieve_[retrieve_primitive_PostVaccination] summary: Retrieve Primitive Postvaccination parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PostVaccinationDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/PostVaccination/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_PostVaccination_event_log_retrieve_[retrieve_PostVaccination_by_event_log] summary: Retrieve Postvaccination By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PostVaccinationDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/PregnancyFollowUp/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_PregnancyFollowUp_retrieve_[retrieve_primitive_PregnancyFollowUp] summary: Retrieve Primitive Pregnancyfollowup parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PregnancyFollowUpDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/PregnancyFollowUp/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_PregnancyFollowUp_event_log_retrieve_[retrieve_PregnancyFollowUp_by_event_log] summary: Retrieve Pregnancyfollowup By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PregnancyFollowUpDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/PregnancyStatus/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_PregnancyStatus_retrieve_[retrieve_primitive_PregnancyStatus] summary: Retrieve Primitive Pregnancystatus parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PregnancyStatusDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/PregnancyStatus/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_PregnancyStatus_event_log_retrieve_[retrieve_PregnancyStatus_by_event_log] summary: Retrieve Pregnancystatus By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PregnancyStatusDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/PregnancyUpdate/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_PregnancyUpdate_retrieve_[retrieve_primitive_PregnancyUpdate] summary: Retrieve Primitive Pregnancyupdate parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PregnancyUpdateDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/PregnancyUpdate/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_PregnancyUpdate_event_log_retrieve_[retrieve_PregnancyUpdate_by_event_log] summary: Retrieve Pregnancyupdate By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PregnancyUpdateDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Ptosis/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Ptosis_retrieve_[retrieve_primitive_Ptosis] summary: Retrieve Primitive Ptosis parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PtosisDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Ptosis/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Ptosis_event_log_retrieve_[retrieve_Ptosis_by_event_log] summary: Retrieve Ptosis By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PtosisDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/PulseOximetry/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_PulseOximetry_retrieve_[retrieve_primitive_PulseOximetry] summary: Retrieve Primitive Pulseoximetry parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PulseOximetryDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/PulseOximetry/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_PulseOximetry_event_log_retrieve_[retrieve_PulseOximetry_by_event_log] summary: Retrieve Pulseoximetry By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PulseOximetryDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Questionnaire/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Questionnaire_retrieve_[retrieve_primitive_Questionnaire] summary: Retrieve Primitive Questionnaire parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/QuestionnaireDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Questionnaire/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Questionnaire_event_log_retrieve_[retrieve_Questionnaire_by_event_log] summary: Retrieve Questionnaire By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/QuestionnaireDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/ReactionTime/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_ReactionTime_retrieve_[retrieve_primitive_ReactionTime] summary: Retrieve Primitive Reactiontime parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReactionTimeDRF' description: '' /api/extensions/v1/user/{user_id}/primitive/ReactionTime/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_ReactionTime_event_log_retrieve_[retrieve_ReactionTime_by_event_log] summary: Retrieve Reactiontime By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReactionTimeDRF' description: '' /api/extensions/v1/user/{user_id}/primitive/RespiratoryRate/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_RespiratoryRate_retrieve_[retrieve_primitive_RespiratoryRate] summary: Retrieve Primitive Respiratoryrate parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RespiratoryRateDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/RespiratoryRate/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_RespiratoryRate_event_log_retrieve_[retrieve_RespiratoryRate_by_event_log] summary: Retrieve Respiratoryrate By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RespiratoryRateDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/RestingBreathingRate/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_RestingBreathingRate_retrieve_[retrieve_primitive_RestingBreathingRate] summary: Retrieve Primitive Restingbreathingrate parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RestingBreathingRateDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/RestingBreathingRate/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_RestingBreathingRate_event_log_retrieve_[retrieve_RestingBreathingRate_by_event_log] summary: Retrieve Restingbreathingrate By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RestingBreathingRateDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/RevereTest/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_RevereTest_retrieve_[retrieve_primitive_RevereTest] summary: Retrieve Primitive Reveretest parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RevereTestDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/RevereTest/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_RevereTest_event_log_retrieve_[retrieve_RevereTest_by_event_log] summary: Retrieve Reveretest By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RevereTestDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/SF36/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_SF36_retrieve_[retrieve_primitive_SF36] summary: Retrieve Primitive Sf36 parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SF36DTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/SF36/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_SF36_event_log_retrieve_[retrieve_SF36_by_event_log] summary: Retrieve Sf36 By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SF36DTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/SRS/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_SRS_retrieve_[retrieve_primitive_SRS] summary: Retrieve Primitive Srs parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SRSDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/SRS/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_SRS_event_log_retrieve_[retrieve_SRS_by_event_log] summary: Retrieve Srs By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SRSDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/SelfHealthRate/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_SelfHealthRate_retrieve_[retrieve_primitive_SelfHealthRate] summary: Retrieve Primitive Selfhealthrate parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SelfHealthRateDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/SelfHealthRate/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_SelfHealthRate_event_log_retrieve_[retrieve_SelfHealthRate_by_event_log] summary: Retrieve Selfhealthrate By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SelfHealthRateDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/SensorCapture/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_SensorCapture_retrieve_[retrieve_primitive_SensorCapture] summary: Retrieve Primitive Sensorcapture parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SensorCaptureDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/SensorCapture/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_SensorCapture_event_log_retrieve_[retrieve_SensorCapture_by_event_log] summary: Retrieve Sensorcapture By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SensorCaptureDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Sleep/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Sleep_retrieve_[retrieve_primitive_Sleep] summary: Retrieve Primitive Sleep parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SleepDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Sleep/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Sleep_event_log_retrieve_[retrieve_Sleep_by_event_log] summary: Retrieve Sleep By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SleepDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/SleepQuestions/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_SleepQuestions_retrieve_[retrieve_primitive_SleepQuestions] summary: Retrieve Primitive Sleepquestions parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SleepQuestionsDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/SleepQuestions/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_SleepQuestions_event_log_retrieve_[retrieve_SleepQuestions_by_event_log] summary: Retrieve Sleepquestions By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SleepQuestionsDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/SmokeQuestions/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_SmokeQuestions_retrieve_[retrieve_primitive_SmokeQuestions] summary: Retrieve Primitive Smokequestions parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SmokeQuestionsDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/SmokeQuestions/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_SmokeQuestions_event_log_retrieve_[retrieve_SmokeQuestions_by_event_log] summary: Retrieve Smokequestions By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SmokeQuestionsDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/SpatialSpaniOS/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_SpatialSpaniOS_retrieve_[retrieve_primitive_SpatialSpaniOS] summary: Retrieve Primitive Spatialspanios parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpatialSpaniOSDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/SpatialSpaniOS/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_SpatialSpaniOS_event_log_retrieve_[retrieve_SpatialSpaniOS_by_event_log] summary: Retrieve Spatialspanios By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpatialSpaniOSDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Spirometry/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Spirometry_retrieve_[retrieve_primitive_Spirometry] summary: Retrieve Primitive Spirometry parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpirometryDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Spirometry/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Spirometry_event_log_retrieve_[retrieve_Spirometry_by_event_log] summary: Retrieve Spirometry By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpirometryDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Step/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Step_retrieve_[retrieve_primitive_Step] summary: Retrieve Primitive Step parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/StepDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Step/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Step_event_log_retrieve_[retrieve_Step_by_event_log] summary: Retrieve Step By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/StepDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Symptom/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Symptom_retrieve_[retrieve_primitive_Symptom] summary: Retrieve Primitive Symptom parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SymptomDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Symptom/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Symptom_event_log_retrieve_[retrieve_Symptom_by_event_log] summary: Retrieve Symptom By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SymptomDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/TakenMedication/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_TakenMedication_retrieve_[retrieve_primitive_TakenMedication] summary: Retrieve Primitive Takenmedication parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TakenMedicationDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/TakenMedication/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_TakenMedication_event_log_retrieve_[retrieve_TakenMedication_by_event_log] summary: Retrieve Takenmedication By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TakenMedicationDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Tegner/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Tegner_retrieve_[retrieve_primitive_Tegner] summary: Retrieve Primitive Tegner parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TegnerDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Tegner/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Tegner_event_log_retrieve_[retrieve_Tegner_by_event_log] summary: Retrieve Tegner By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TegnerDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Temperature/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Temperature_retrieve_[retrieve_primitive_Temperature] summary: Retrieve Primitive Temperature parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemperatureDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Temperature/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Temperature_event_log_retrieve_[retrieve_Temperature_by_event_log] summary: Retrieve Temperature By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemperatureDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/VR_12/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_VR_12_retrieve_[retrieve_primitive_VR_12] summary: Retrieve Primitive Vr 12 parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VR_12DTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/VR_12/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_VR_12_event_log_retrieve_[retrieve_VR_12_by_event_log] summary: Retrieve Vr 12 By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VR_12DTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/VaccinationDetails/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_VaccinationDetails_retrieve_[retrieve_primitive_VaccinationDetails] summary: Retrieve Primitive Vaccinationdetails parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VaccinationDetailsDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/VaccinationDetails/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_VaccinationDetails_event_log_retrieve_[retrieve_VaccinationDetails_by_event_log] summary: Retrieve Vaccinationdetails By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VaccinationDetailsDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/VirtualCare/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_VirtualCare_retrieve_[retrieve_primitive_VirtualCare] summary: Retrieve Primitive Virtualcare parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualCareDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/VirtualCare/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_VirtualCare_event_log_retrieve_[retrieve_VirtualCare_by_event_log] summary: Retrieve Virtualcare By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualCareDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/WHQ/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_WHQ_retrieve_[retrieve_primitive_WHQ] summary: Retrieve Primitive Whq parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WHQDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/WHQ/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_WHQ_event_log_retrieve_[retrieve_WHQ_by_event_log] summary: Retrieve Whq By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WHQDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/WOMAC/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_WOMAC_retrieve_[retrieve_primitive_WOMAC] summary: Retrieve Primitive Womac parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WOMACDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/WOMAC/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_WOMAC_event_log_retrieve_[retrieve_WOMAC_by_event_log] summary: Retrieve Womac By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WOMACDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/WaistToHeight/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_WaistToHeight_retrieve_[retrieve_primitive_WaistToHeight] summary: Retrieve Primitive Waisttoheight parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WaistToHeightDRF' description: '' /api/extensions/v1/user/{user_id}/primitive/WaistToHeight/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_WaistToHeight_event_log_retrieve_[retrieve_WaistToHeight_by_event_log] summary: Retrieve Waisttoheight By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WaistToHeightDRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Weight/{module_result_id}: get: operationId: api_extensions_v1_user_primitive_Weight_retrieve_[retrieve_primitive_Weight] summary: Retrieve Primitive Weight parameters: - in: path name: module_result_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WeightDTODRF' description: '' /api/extensions/v1/user/{user_id}/primitive/Weight/event-log/{event_log_id}: get: operationId: api_extensions_v1_user_primitive_Weight_event_log_retrieve_[retrieve_Weight_by_event_log] summary: Retrieve Weight By Event Log parameters: - in: path name: event_log_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Module Results security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WeightDTODRF' description: '' /api/extensions/v1/user/{user_id}/profiles/assigned: get: operationId: api_extensions_v1_user_profiles_assigned_retrieve_[retrieve_profiles_with_assigned_manager_with_user_id] summary: Retrieve Profiles With Assigned Manager With User Id parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDTODRF' description: '' /api/extensions/v1/user/{user_id}/proxy-invitations: get: operationId: api_extensions_v1_user_proxy_invitations_retrieve_[retrieve_proxy_invitations] description: |- Retrieve proxy invitations Retrieve all proxy invitations for a user. summary: Retrieve Proxy Invitations parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveProxyInvitationsResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/ptosis/qc_orientation: post: operationId: api_extensions_v1_user_ptosis_qc_orientation_create_[head_orientation_quality_check] summary: Head Orientation Quality Check parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Inference requestBody: content: application/json: schema: $ref: '#/components/schemas/HeadOrientationQCRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/HeadOrientationQCRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/HeadOrientationQCRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HeadOrientationQCResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/ptosis/qc_position: post: operationId: api_extensions_v1_user_ptosis_qc_position_create_[head_position_quality_check] summary: Head Position Quality Check parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Inference Route requestBody: content: application/json: schema: $ref: '#/components/schemas/PtosisQualityCheckRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PtosisQualityCheckRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/PtosisQualityCheckRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body '400': content: application/json: schema: $ref: '#/components/schemas/QualityCheckErrorResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/rating/{rating_id}: put: operationId: api_extensions_v1_user_rating_update_[update_rating] summary: Update Rating parameters: - in: path name: rating_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Ratings requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserRatingRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateUserRatingRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateUserRatingRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/rating/article: post: operationId: api_extensions_v1_user_rating_article_create_[create_article_rating] summary: Create Article Rating parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Ratings requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateArticleRatingRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateArticleRatingRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateArticleRatingRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/rating/article/search: post: operationId: api_extensions_v1_user_rating_article_search_create_[search_article_rating] summary: Search Article Rating parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Ratings requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchArticleRatingRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SearchArticleRatingRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/SearchArticleRatingRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ArticleRatingDTODRF' description: '' /api/extensions/v1/user/{user_id}/rating/module: post: operationId: api_extensions_v1_user_rating_module_create_[create_module_rating] summary: Create Module Rating parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Ratings requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateModuleRatingRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateModuleRatingRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateModuleRatingRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/reactivate: post: operationId: api_extensions_v1_user_reactivate_create_[reactivate_user] description: |- Reactivate user Reactivate a suspended user account. summary: Reactivate User parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/reminder: post: operationId: api_extensions_v1_user_reminder_create_[create_reminder] description: |- Create Module Reminder Creates a module-based reminder for the specified user. summary: Create Reminder parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Reminders requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUserModuleReminderRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateUserModuleReminderRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateUserModuleReminderRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/reminder/{reminder_id}: get: operationId: api_extensions_v1_user_reminder_retrieve_[retrieve_reminder] description: |- Retrieve Module Reminder Retrieves a specific module-based reminder for the specified user by reminder ID. summary: Retrieve Reminder parameters: - in: path name: reminder_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Reminders security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReminderResponseDataDRF' description: '' post: operationId: api_extensions_v1_user_reminder_create_[update_reminder] description: |- Update Module Reminder Updates a module-based reminder for the specified user. summary: Update Reminder parameters: - in: path name: reminder_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Reminders requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserModuleReminderRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateUserModuleReminderRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateUserModuleReminderRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' delete: operationId: api_extensions_v1_user_reminder_destroy_[delete_reminder] description: |- Delete Module Reminder Deletes a specific reminder for the specified user by reminder ID. summary: Delete Reminder parameters: - in: path name: reminder_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Reminders security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/user/{user_id}/reminder/personal: post: operationId: api_extensions_v1_user_reminder_personal_create_[create_personal_reminder] description: |- Create Personal Reminder Creates a personal reminder for the specified user. summary: Create Personal Reminder parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Reminders requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePersonalReminderRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreatePersonalReminderRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreatePersonalReminderRequestDataDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/reminder/personal/{reminder_id}: put: operationId: api_extensions_v1_user_reminder_personal_update_[update_personal_reminder] description: |- Update Personal Reminder Updates a personal reminder for the specified user. summary: Update Personal Reminder parameters: - in: path name: reminder_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Reminders requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePersonalReminderRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdatePersonalReminderRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdatePersonalReminderRequestDataDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/reminder/personal/{reminder_id}/done: post: operationId: api_extensions_v1_user_reminder_personal_done_create_[complete_personal_reminder] description: |- Complete Personal Reminder Marks a personal reminder as complete for the specified user and reminder ID. summary: Complete Personal Reminder parameters: - in: path name: reminder_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Reminders requestBody: content: application/json: schema: $ref: '#/components/schemas/MarkCompleteUserReminderRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MarkCompleteUserReminderRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/MarkCompleteUserReminderRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/reminder/search: put: operationId: api_extensions_v1_user_reminder_search_update_[search_reminders] description: |- Search Module Reminders Searches for module-based reminders for the specified user, filtered by module ID or configuration ID. summary: Search Reminders parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Reminders requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveRemindersRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveRemindersRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveRemindersRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReminderResponseDataDRF' description: '' /api/extensions/v1/user/{user_id}/reminders: post: operationId: api_extensions_v1_user_reminders_create_[retrieve_reminders] description: |- Retrieve Module Reminders Retrieves multiple reminders for the specified user. summary: Retrieve Reminders parameters: - in: query name: filter schema: type: string - in: query name: limit schema: type: integer - in: query name: skip schema: type: integer - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Reminders security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveRemindersResponseDRF' description: '' /api/extensions/v1/user/{user_id}/remove-role: post: operationId: api_extensions_v1_user_remove_role_create_[remove_roles] summary: Remove Roles parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/AddRolesInputDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AddRolesInputDRF' multipart/form-data: schema: $ref: '#/components/schemas/AddRolesInputDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/resources: get: operationId: api_extensions_v1_user_resources_retrieve_[retrieve_user_resources] description: |- Retrieve user resources Retrieve all resources available to a user. summary: Retrieve User Resources parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveUserResourcesResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/retrieve-third-party-apps: post: operationId: api_extensions_v1_user_retrieve_third_party_apps_create_[retrieve_third_party_apps] description: |- Retrieve Connected Third-Party Apps Retrieves a list of connected third-party apps for the specified user. summary: Retrieve Third Party Apps parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Health App Integration requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveThirdPartyAppsRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveThirdPartyAppsRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveThirdPartyAppsRequestDataDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ThirdPartyAppDTODRF' description: '' /api/extensions/v1/user/{user_id}/revere-test/: get: operationId: api_extensions_v1_user_revere_test_retrieve_[retrieve_finished_user_tests] summary: Retrieve Finished User Tests parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Revere security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] deprecated: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RevereTestDTODRF' description: '' /api/extensions/v1/user/{user_id}/revere-test/{test_id}/: get: operationId: api_extensions_v1_user_revere_test_retrieve_[export_test_result] summary: Export Test Result parameters: - in: path name: test_id schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Revere security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] deprecated: true responses: '200': description: CSV file with test results /api/extensions/v1/user/{user_id}/revere-test/{test_id}/finish/: post: operationId: api_extensions_v1_user_revere_test_finish_create_[finish_test] summary: Finish Test parameters: - in: path name: test_id schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Revere security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] deprecated: true responses: '204': description: No response body /api/extensions/v1/user/{user_id}/revere-test/{test_id}/words/{word_list_id}/audio/: post: operationId: api_extensions_v1_user_revere_test_words_audio_create_[upload_audio_result] summary: Upload Audio Result parameters: - in: path name: test_id schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: word_list_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Revere requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcessAudioResultRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ProcessAudioResultRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/ProcessAudioResultRequestBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] deprecated: true responses: '204': description: No response body /api/extensions/v1/user/{user_id}/revere-test/all/: get: operationId: api_extensions_v1_user_revere_test_all_retrieve_[retrieve_all_user_tests] summary: Retrieve All User Tests parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Revere security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] deprecated: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RevereTestDTODRF' description: '' /api/extensions/v1/user/{user_id}/revere-test/start/: post: operationId: api_extensions_v1_user_revere_test_start_create_[start_test] summary: Start Test parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Revere security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] deprecated: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/StartRevereTestResponseDRF' description: '' /api/extensions/v1/user/{user_id}/third-party-app: post: operationId: api_extensions_v1_user_third_party_app_create_[create_third_party_app] description: |- Create Third-Party App Registers a new third-party app for the specified user. summary: Create Third Party App parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Health App Integration requestBody: content: application/json: schema: $ref: '#/components/schemas/BaseThirdPartyAppRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BaseThirdPartyAppRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/BaseThirdPartyAppRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/third-party-app-log/{app_type}: get: operationId: api_extensions_v1_user_third_party_app_log_retrieve_[retrieve_third_party_app_log] description: |- Retrieve Third-Party App Log Retrieves the log of activities for a specified third-party app. summary: Retrieve Third Party App Log parameters: - in: path name: app_type schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Health App Integration security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ThirdPartyAppLogDTODRF' description: '' /api/extensions/v1/user/{user_id}/third-party-app/{app_type}: get: operationId: api_extensions_v1_user_third_party_app_retrieve_[retrieve_third_party_app] description: |- Retrieve Third-Party App Retrieves the details of a third-party app for the specified user and app type. summary: Retrieve Third Party App parameters: - in: path name: app_type schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Health App Integration security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ThirdPartyAppDTODRF' description: '' post: operationId: api_extensions_v1_user_third_party_app_create_[connect_third_party_app] description: |- Connect Third-Party App Connects a third-party app to the specified user's account using the app type and authorization data. summary: Connect Third Party App parameters: - in: path name: app_type schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Health App Integration requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectFitbitRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ConnectFitbitRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/ConnectFitbitRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ThirdPartyAppStatusResponseDRF' description: '' delete: operationId: api_extensions_v1_user_third_party_app_destroy_[disconnect_third_party_app] description: |- Disconnect Third-Party App Disconnects a third-party app for the specified user. summary: Disconnect Third Party App parameters: - in: path name: app_type schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Health App Integration security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ThirdPartyAppStatusResponseDRF' description: '' /api/extensions/v1/user/{user_id}/unassign-proxy: post: operationId: api_extensions_v1_user_unassign_proxy_create_[unlink_proxy_user] summary: Unlink Proxy User parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/UnlinkProxyRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UnlinkProxyRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/UnlinkProxyRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/user/{user_id}/video/{video_call_id}/complete: post: operationId: api_extensions_v1_user_video_complete_create_[complete_video_call_by_user] summary: Complete Video Call By User parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: video_call_id schema: type: string required: true tags: - Video Call requestBody: content: application/json: schema: $ref: '#/components/schemas/CompleteVideoCallByUserRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CompleteVideoCallByUserRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CompleteVideoCallByUserRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/extensions/v1/user/add-role: post: operationId: api_extensions_v1_user_add_role_create_[add_roles_to_users] summary: Add Roles To Users tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/AddRolesToUsersRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AddRolesToUsersRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/AddRolesToUsersRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AddRolesToUserResponseDRF' description: '' /api/extensions/v1/user/analytics: post: operationId: api_extensions_v1_user_analytics_create_[retrieve_analytics_url] summary: Retrieve Analytics Url tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveAnalyticsUrlRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveAnalyticsUrlRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveAnalyticsUrlRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveAnalyticsResponseDRF' description: '' /api/extensions/v1/user/assign: post: operationId: api_extensions_v1_user_assign_create_[assign_managers_to_users] summary: Assign Managers To Users tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/AssignManagersToUsersRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AssignManagersToUsersRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/AssignManagersToUsersRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AssignUsersResponseDRF' description: '' /api/extensions/v1/user/configs: post: operationId: api_extensions_v1_user_configs_create_[retrieve_custom_module_configs] summary: Retrieve Custom Module Configs tags: - Custom Module Config requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveCustomModuleConfigsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveCustomModuleConfigsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveCustomModuleConfigsRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveCustomModuleConfigsResponseObjectDRF' description: '' /api/extensions/v1/user/labels: post: operationId: api_extensions_v1_user_labels_create_[assign_labels_to_users] summary: Assign Labels To Users tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/AssignLabelsToUsersRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AssignLabelsToUsersRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/AssignLabelsToUsersRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/extensions/v1/user/lookup/{code}: get: operationId: api_extensions_v1_user_lookup_retrieve_[lookup_user_by_code] description: |- Lookup user by code Decode the provided code and return the user ID and the deployment ID the user belongs to. summary: Lookup User By Code parameters: - in: path name: code schema: type: string required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProfileIdentifiersResponseObjectDRF' description: '' /api/extensions/v1/user/move/users: get: operationId: api_extensions_v1_user_move_users_retrieve_[retrieve_moved_users] description: |- Retrieve moved users Retrieve a list of users who have been moved between deployments. summary: Retrieve Moved Users parameters: - in: query name: deploymentId schema: type: string required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveProfilesResponseObjectDRF' description: '' /api/extensions/v1/user/offboard: post: operationId: api_extensions_v1_user_offboard_create_[offboard_users] summary: Offboard Users tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/OffBoardUsersRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OffBoardUsersRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/OffBoardUsersRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OffboardUsersResponseDRF' description: '' /api/extensions/v1/user/profiles: post: operationId: api_extensions_v1_user_profiles_create_[retrieve_user_profiles_v1] summary: Retrieve User Profiles V1 tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveProfilesRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveProfilesRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveProfilesRequestDataDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveProfilesResponseObjectDRF' description: '' /api/extensions/v1/user/profiles/assigned: get: operationId: api_extensions_v1_user_profiles_assigned_retrieve_[retrieve_profiles_with_assigned_manager] summary: Retrieve Profiles With Assigned Manager tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDTODRF' description: '' /api/extensions/v1/user/reactivate: post: operationId: api_extensions_v1_user_reactivate_create_[reactivate_users] summary: Reactivate Users tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/ReactivateUsersRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ReactivateUsersRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/ReactivateUsersRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReactivateUsersResponseDRF' description: '' /api/extensions/v1/user/staff: post: operationId: api_extensions_v1_user_staff_create_[retrieve_staff_list] summary: Retrieve Staff List tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveStaffRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveStaffRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveStaffRequestDataDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDTODRF' description: '' /api/extensions/v1/video/callbacks: post: operationId: api_extensions_v1_video_callbacks_create_[twilio_callbacks] description: All incoming Twilio requests set the Content-Type header to “application/x-www-form-urlencoded”. summary: Twilio Callbacks tags: - Public Video Callback security: - {} responses: '204': description: No response body /api/extensions/v1/video/test: get: operationId: api_extensions_v1_video_test_retrieve_[test_video_call] summary: Test Video Call tags: - Public Video Callback security: - {} responses: '200': description: No response body /api/extensions/v1/video/user/{user_id}/offline-call: post: operationId: api_extensions_v1_video_user_offline_call_create_[create_offline_call] summary: Create Offline Call parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Video Call requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOfflineCallRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateOfflineCallRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateOfflineCallRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1/video/webex/callbacks: post: operationId: api_extensions_v1_video_webex_callbacks_create_[webex_callbacks] summary: Webex Callbacks tags: - Public Video Callback security: - {} responses: '204': description: No response body /api/extensions/v1/withings/auth/url: get: operationId: api_extensions_v1_withings_auth_url_retrieve_[get_auth_url] description: Get Withings authorization URL summary: Get Auth Url tags: - Withings Integration security: - {} responses: '200': description: No response body /api/extensions/v1/withings/notify: get: operationId: api_extensions_v1_withings_notify_retrieve_[verify_subscription] summary: Verify Subscription tags: - Withings Integration security: - {} responses: '200': description: No response body post: operationId: api_extensions_v1_withings_notify_create_[receive_notification] description: |- Receive Subscription Notification https://developer.withings.com/api-reference/#tag/notify/operation/notify-get summary: Receive Notification tags: - Withings security: - {} responses: '204': description: Success '404': description: Signature not found or Withings config is disabled /api/extensions/v1/withings/redirect: get: operationId: api_extensions_v1_withings_redirect_retrieve_[redirect] description: Handle OAuth redirect after Withings authorization summary: Redirect parameters: - in: query name: code schema: type: string required: true - in: header name: language schema: type: string - in: query name: state schema: type: string required: true tags: - Withings Integration security: - {} responses: '200': description: No response body /api/extensions/v1beta/deployment/create-patient-profile: post: operationId: api_extensions_v1beta_deployment_create_patient_profile_create_[create_patient_profile] summary: Create Patient Profile tags: - Invitations (Depracated) requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePatientProfileRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreatePatientProfileRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreatePatientProfileRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreatePatientProfileResponseObjectDRF' description: '' /api/extensions/v1beta/deployment/invitation-link: post: operationId: api_extensions_v1beta_deployment_invitation_link_create_[get_invitation_link] summary: Get Invitation Link tags: - Invitations (Depracated) requestBody: content: application/json: schema: $ref: '#/components/schemas/GetInvitationLinkRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GetInvitationLinkRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/GetInvitationLinkRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetInvitationLinkResponseObjectDRF' description: '' /api/extensions/v1beta/deployment/invitations: post: operationId: api_extensions_v1beta_deployment_invitations_create_[retrieve_invitations] summary: Retrieve Invitations tags: - Invitations (Depracated) requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveInvitationsRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveInvitationsRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveInvitationsRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveInvitationsResponseObjectDRF' description: '' /api/extensions/v1beta/deployment/resend-invitation-list: post: operationId: api_extensions_v1beta_deployment_resend_invitation_list_create_[resend_user_invitation_list] description: Resend User Invitations summary: Resend User Invitation List tags: - Invitations (Depracated) requestBody: content: application/json: schema: $ref: '#/components/schemas/ResendInvitationsListRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ResendInvitationsListRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ResendInvitationsListRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResendInvitationsListResponseDRF' description: '' /api/extensions/v1beta/deployment/send-invitation: post: operationId: api_extensions_v1beta_deployment_send_invitation_create_[send_user_invitation] description: Send User invitation summary: Send User Invitation tags: - Invitations (Depracated) requestBody: content: application/json: schema: $ref: '#/components/schemas/SendInvitationsRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SendInvitationsRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/SendInvitationsRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '202': content: application/json: schema: $ref: '#/components/schemas/SendInvitationsResponseObjectDRF' description: '' /api/extensions/v1beta/deployment/send-invitation/{user_id}: post: operationId: api_extensions_v1beta_deployment_send_invitation_create_[send_user_specific_invitation] summary: Send User Specific Invitation parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Invitations (Depracated) requestBody: content: application/json: schema: $ref: '#/components/schemas/SendUserSpecificInvitationRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SendUserSpecificInvitationRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/SendUserSpecificInvitationRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1beta/user/{user_id}: get: operationId: api_extensions_v1beta_user_retrieve_[retrieve_user_profile] summary: Retrieve User Profile parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDTODRF' description: '' post: operationId: api_extensions_v1beta_user_create_[update_user_profile] summary: Update User Profile parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserProfileRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateUserProfileRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateUserProfileRequestDataDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/add-role: post: operationId: api_extensions_v1beta_user_add_role_create_[add_roles] summary: Add Roles parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/AddRolesInputDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AddRolesInputDRF' multipart/form-data: schema: $ref: '#/components/schemas/AddRolesInputDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/assign-proxy: post: operationId: api_extensions_v1beta_user_assign_proxy_create_[link_proxy_user] summary: Link Proxy User parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/LinkProxyRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/LinkProxyRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/LinkProxyRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/LinkProxyUserResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/configuration: get: operationId: api_extensions_v1beta_user_configuration_retrieve_[retrieve_deployment_config] summary: Retrieve Deployment Config parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveDeploymentConfigResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/consent/{consent_id}/sign: post: operationId: api_extensions_v1beta_user_consent_sign_create_[sign_consent] summary: Sign Consent parameters: - in: path name: consent_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/SignConsentRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SignConsentRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/SignConsentRequestDataDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/deployment/{deployment_id}/helperagreementlog: post: operationId: api_extensions_v1beta_user_deployment_helperagreementlog_create_[create_helper_agreement_log] description: |- Create helper agreement log Create a helper agreement log for a user within a deployment. summary: Create Helper Agreement Log parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateHelperAgreementLogRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateHelperAgreementLogRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateHelperAgreementLogRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/document: get: operationId: api_extensions_v1beta_user_document_retrieve_[retrieve_personal_documents] description: |- Retrieve personal documents Retrieve all personal documents associated with a user. summary: Retrieve Personal Documents parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PersonalDocumentDRF' description: '' post: operationId: api_extensions_v1beta_user_document_create_[create_personal_document] description: |- Create personal document Create a personal document for a user. summary: Create Personal Document parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePersonalDocumentRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreatePersonalDocumentRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreatePersonalDocumentRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/econsent/{econsent_id}: get: operationId: api_extensions_v1beta_user_econsent_retrieve_[retrieve_user_econsent] summary: Retrieve User Econsent parameters: - in: path name: econsent_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EConsentDRF' description: '' post: operationId: api_extensions_v1beta_user_econsent_create_[assign_econsent_to_user] summary: Assign Econsent To User parameters: - in: path name: econsent_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/econsent/{econsent_id}/pdf: get: operationId: api_extensions_v1beta_user_econsent_pdf_retrieve_[retrieve_econsent_pdf] description: |- Retrieve econsent PDF(s) Returns all user's econsent pdfs. summary: Retrieve Econsent Pdf parameters: - in: path name: econsent_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EConsentLogDTODRF' description: '' /api/extensions/v1beta/user/{user_id}/econsent/{econsent_id}/sign: post: operationId: api_extensions_v1beta_user_econsent_sign_create_[sign_econsent] summary: Sign Econsent parameters: - in: path name: econsent_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/SignEConsentRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SignEConsentRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/SignEConsentRequestDataDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/econsent/{econsent_id}/withdraw: post: operationId: api_extensions_v1beta_user_econsent_withdraw_create_[withdraw_econsent] summary: Withdraw Econsent parameters: - in: path name: econsent_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/WithdrawEConsentRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/WithdrawEConsentRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/WithdrawEConsentRequestBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/extensions/v1beta/user/{user_id}/fullconfiguration: get: operationId: api_extensions_v1beta_user_fullconfiguration_retrieve_[retrieve_full_configuration_for_user] summary: Retrieve Full Configuration For User parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveFullConfigurationResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/labels: post: operationId: api_extensions_v1beta_user_labels_create_[assign_user_labels] summary: Assign User Labels parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/AssignLabelsToUserRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AssignLabelsToUserRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/AssignLabelsToUserRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/move/{target_deployment_id}: post: operationId: api_extensions_v1beta_user_move_create_[move_user] description: |- Move user Move a user to a different deployment. summary: Move User parameters: - in: path name: target_deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/MoveUserRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MoveUserRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/MoveUserRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/move/history: get: operationId: api_extensions_v1beta_user_move_history_retrieve_[retrieve_move_user_history] description: |- Retrieve move user history Retrieve the move history of a user. summary: Retrieve Move User History parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveMoveUserHistoryResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/offboard: post: operationId: api_extensions_v1beta_user_offboard_create_[off_board_user] description: |- Offboard user Offboard a user from a deployment. summary: Off Board User parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/profiles/assigned: get: operationId: api_extensions_v1beta_user_profiles_assigned_retrieve_[retrieve_profiles_with_assigned_manager_with_user_id] summary: Retrieve Profiles With Assigned Manager With User Id parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDTODRF' description: '' /api/extensions/v1beta/user/{user_id}/proxy-invitations: get: operationId: api_extensions_v1beta_user_proxy_invitations_retrieve_[retrieve_proxy_invitations] description: |- Retrieve proxy invitations Retrieve all proxy invitations for a user. summary: Retrieve Proxy Invitations parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveProxyInvitationsResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/reactivate: post: operationId: api_extensions_v1beta_user_reactivate_create_[reactivate_user] description: |- Reactivate user Reactivate a suspended user account. summary: Reactivate User parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/remove-role: post: operationId: api_extensions_v1beta_user_remove_role_create_[remove_roles] summary: Remove Roles parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/AddRolesInputDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AddRolesInputDRF' multipart/form-data: schema: $ref: '#/components/schemas/AddRolesInputDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/resources: get: operationId: api_extensions_v1beta_user_resources_retrieve_[retrieve_user_resources] description: |- Retrieve user resources Retrieve all resources available to a user. summary: Retrieve User Resources parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveUserResourcesResponseObjectDRF' description: '' /api/extensions/v1beta/user/{user_id}/unassign-proxy: post: operationId: api_extensions_v1beta_user_unassign_proxy_create_[unlink_proxy_user] summary: Unlink Proxy User parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/UnlinkProxyRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UnlinkProxyRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/UnlinkProxyRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v1beta/user/add-role: post: operationId: api_extensions_v1beta_user_add_role_create_[add_roles_to_users] summary: Add Roles To Users tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/AddRolesToUsersRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AddRolesToUsersRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/AddRolesToUsersRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AddRolesToUserResponseDRF' description: '' /api/extensions/v1beta/user/analytics: post: operationId: api_extensions_v1beta_user_analytics_create_[retrieve_analytics_url] summary: Retrieve Analytics Url tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveAnalyticsUrlRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveAnalyticsUrlRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveAnalyticsUrlRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveAnalyticsResponseDRF' description: '' /api/extensions/v1beta/user/assign: post: operationId: api_extensions_v1beta_user_assign_create_[assign_managers_to_users] summary: Assign Managers To Users tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/AssignManagersToUsersRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AssignManagersToUsersRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/AssignManagersToUsersRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AssignUsersResponseDRF' description: '' /api/extensions/v1beta/user/labels: post: operationId: api_extensions_v1beta_user_labels_create_[assign_labels_to_users] summary: Assign Labels To Users tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/AssignLabelsToUsersRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AssignLabelsToUsersRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/AssignLabelsToUsersRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/extensions/v1beta/user/move/users: get: operationId: api_extensions_v1beta_user_move_users_retrieve_[retrieve_moved_users] description: |- Retrieve moved users Retrieve a list of users who have been moved between deployments. summary: Retrieve Moved Users parameters: - in: query name: deploymentId schema: type: string required: true tags: - User Deprecated security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveProfilesResponseObjectDRF' description: '' /api/extensions/v1beta/user/offboard: post: operationId: api_extensions_v1beta_user_offboard_create_[offboard_users] summary: Offboard Users tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/OffBoardUsersRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OffBoardUsersRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/OffBoardUsersRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OffboardUsersResponseDRF' description: '' /api/extensions/v1beta/user/profiles/assigned: get: operationId: api_extensions_v1beta_user_profiles_assigned_retrieve_[retrieve_profiles_with_assigned_manager] summary: Retrieve Profiles With Assigned Manager tags: - User Deprecated security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDTODRF' description: '' /api/extensions/v1beta/user/reactivate: post: operationId: api_extensions_v1beta_user_reactivate_create_[reactivate_users] summary: Reactivate Users tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/ReactivateUsersRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ReactivateUsersRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/ReactivateUsersRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReactivateUsersResponseDRF' description: '' /api/extensions/v1beta/user/staff: post: operationId: api_extensions_v1beta_user_staff_create_[retrieve_staff_list] summary: Retrieve Staff List tags: - User Deprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveStaffRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveStaffRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveStaffRequestDataDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDTODRF' description: '' /api/extensions/v2/user/{user_id}/deployment/{deployment_id}/configuration: get: operationId: api_extensions_v2_user_deployment_configuration_retrieve_[retrieve_deployment_configuration_for_user_v2] description: |- Retrieve Configuration v2 This endpoint retrieves the configuration for a specific deployment for a user. summary: Retrieve Deployment Configuration For User V2 parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User v2 security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveDeploymentConfigResponseDRF' description: '' /api/extensions/v2/user/{user_id}/deployment/{deployment_id}/notes: get: operationId: api_extensions_v2_user_deployment_notes_retrieve_[retrieve_user_notes] description: |- Retrieve user notes Retrieve all notes for a user within a deployment, version 2. summary: Retrieve User Notes parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: query name: limit schema: type: integer - in: query name: skip schema: type: integer - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveUserNotesV2ResponseDRF' description: '' post: operationId: api_extensions_v2_user_deployment_notes_create_[add_user_notes] description: |- Add user notes Add a new note for a user within a deployment, version 2. summary: Add User Notes parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User requestBody: content: application/json: schema: $ref: '#/components/schemas/AddUserNotesV2RequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AddUserNotesV2RequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/AddUserNotesV2RequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/extensions/v2/user/{user_id}/fullconfiguration: get: operationId: api_extensions_v2_user_fullconfiguration_retrieve_[retrieve_full_configuration_for_user_v2] description: |- Retrieve Full Configuration v2 This endpoint retrieves the full configuration for a user, including deployments, organizations and roles. summary: Retrieve Full Configuration For User V2 parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User v2 security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveFullConfigurationResponseObjectDRF' description: '' /api/extensions/v2/user/{user_id}/proxy: get: operationId: api_extensions_v2_user_proxy_retrieve_[retrieve_proxy] description: |- Retrieve Proxy v2 Retrieve proxy status and details for a user. summary: Retrieve Proxy parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - User v2 security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveProxyInvitationsResponseObjectDRF' description: '' /api/extensions/v2/user/module-configs: post: operationId: api_extensions_v2_user_module_configs_create_[retrieve_all_module_configs] description: |- Retrieve Module Configurations This endpoint retrieves all mo dule configurations for a given deployment. summary: Retrieve All Module Configs tags: - User v2 requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveAllModuleConfigsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveAllModuleConfigsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveAllModuleConfigsRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveAllModuleConfigsResponseObjectDRF' description: '' /api/extensions/v2/user/patient/deployments: post: operationId: api_extensions_v2_user_patient_deployments_create_[retrieve_patient_deployment] description: ' The input JSON data containing the details required to retrieve patient' summary: 'json_data: RetrieveDeploymentsContainsPatientRequestObject' tags: - User v2 requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveDeploymentsContainsPatientRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveDeploymentsContainsPatientRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveDeploymentsContainsPatientRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeploymentContainsPatientInfoResponseObjectDRF' description: '' /api/extensions/v2/user/patients: post: operationId: api_extensions_v2_user_patients_create_[retrieve_patients] description: |- Search Patients in User Deployments Provide just the Id, Name and DOB of Patient USers or full information about patients in the requested resource if the detailed flag is set to true. summary: Retrieve Patients tags: - User v2 requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrievePatientsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrievePatientsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrievePatientsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PatientsResponseObjectDRF' description: '' /api/extensions/v2/user/staff: post: operationId: api_extensions_v2_user_staff_create_[retrieve_staff] description: |- Search Staff v2 Provide full information about staff members in the requested resource. summary: Retrieve Staff tags: - User v2 requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveStaffV2RequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveStaffV2RequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveStaffV2RequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveStaffResponseObjectDRF' description: '' /api/extensions/v2/user/staff/details: post: operationId: api_extensions_v2_user_staff_details_create_[retrieve_staff_details] description: |- Retrieve Staff Details Provides minimal information about staff members in the requested resource. summary: Retrieve Staff Details tags: - User v2 requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveStaffRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveStaffRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveStaffRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/StaffDetailsResponseObjectDRF' description: '' /api/hemophilia/v1/user/{user_id}/prerequisites: get: operationId: api_hemophilia_v1_user_prerequisites_retrieve_[retrieve_prerequisites] description: |- Retrieve Hemophilia Profile Retrieve the latest record of the hemophilia profile questionnaire. summary: Retrieve Prerequisites parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Pfizer Hemophilia security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HemophiliaPrerequisitesResponseObjectDRF' description: '' post: operationId: api_hemophilia_v1_user_prerequisites_create_[submit_prerequisites] description: |- Submit Hemophilia Profile Submit the hemophilia profile questionnaire result. summary: Submit Prerequisites parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Pfizer Hemophilia requestBody: content: application/json: schema: $ref: '#/components/schemas/HemophiliaPrerequisitesRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/HemophiliaPrerequisitesRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/HemophiliaPrerequisitesRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/inbox/v1/message/confirm: post: operationId: api_inbox_v1_message_confirm_create_[confirm_messages] summary: Confirm Messages tags: - Inbox requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfirmMessageRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ConfirmMessageRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ConfirmMessageRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ConfirmMessageResponseObjectDRF' description: '' /api/inbox/v1/user/{user_id}/message/all: get: operationId: api_inbox_v1_user_message_all_retrieve_[all_messages] summary: All Messages parameters: - in: query name: authzUser schema: type: string - in: query name: limit schema: type: integer - in: query name: skip schema: type: integer - in: query name: userId schema: type: string - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Inbox security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MessagesResponseObjectDRF' description: '' /api/inbox/v1/user/{user_id}/message/search: post: operationId: api_inbox_v1_user_message_search_create_[search_messages] summary: Search Messages parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Inbox requestBody: content: application/json: schema: $ref: '#/components/schemas/MessageSearchRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MessageSearchRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/MessageSearchRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MessagesResponseObjectDRF' description: '' /api/inbox/v1/user/{user_id}/message/send: post: operationId: api_inbox_v1_user_message_send_create_[send_message] summary: Send Message parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Inbox requestBody: content: application/json: schema: $ref: '#/components/schemas/MessageSendRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MessageSendRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/MessageSendRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/inbox/v1/user/{user_id}/message/summary/search: post: operationId: api_inbox_v1_user_message_summary_search_create_[summary_messages] summary: Summary Messages parameters: - in: path name: authzUser schema: type: string required: true - in: path name: userId schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Inbox security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MessageSummaryResponseObjectDRF' description: '' /api/integration/v1/auth/sign-consent: post: operationId: api_integration_v1_auth_sign_consent_create_[sign_consent] summary: Sign Consent parameters: - in: header name: deploymentId schema: type: string required: true - in: header name: signature schema: type: string required: true tags: - Integration requestBody: content: application/json: schema: $ref: '#/components/schemas/IntegrationSignConsentRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/IntegrationSignConsentRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/IntegrationSignConsentRequestBodyDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': description: No response body /api/integration/v1/auth/signin: post: operationId: api_integration_v1_auth_signin_create_[sign_in] description: |- Sign in Responsible for authenticating users and providing access to secure resources. summary: Sign In parameters: - in: header name: deploymentId schema: type: string required: true - in: header name: signature schema: type: string required: true tags: - Integration requestBody: content: application/json: schema: $ref: '#/components/schemas/IntegrationSignInRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/IntegrationSignInRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/IntegrationSignInRequestBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SignInResponseObjectDRF' description: '' /api/integration/v1/auth/signup: post: operationId: api_integration_v1_auth_signup_create_[sign_up] description: |- Sign up Register new third party users securely with sign-up endpoint. summary: Sign Up parameters: - in: header name: deploymentId schema: type: string required: true - in: header name: signature schema: type: string required: true tags: - Integration requestBody: content: application/json: schema: $ref: '#/components/schemas/IntegrationSignUpRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/IntegrationSignUpRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/IntegrationSignUpRequestBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/IntegrationSignUpResponseObjectDRF' description: '' /api/integration/v1/configs/android: get: operationId: api_integration_v1_configs_android_retrieve_[retrieve_android_config] description: |- Download Android JSON Config Generate Android Configuration JSON file and provide as a file. summary: Retrieve Android Config tags: - Integration security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/integration/v1/configs/backend: get: operationId: api_integration_v1_configs_backend_retrieve_[retrieve_backend_config] description: |- Download Backend JSON Config Generate Backend Configuration JSON file and provide as a file. summary: Retrieve Backend Config tags: - Integration security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/integration/v1/configs/ios: get: operationId: api_integration_v1_configs_ios_retrieve_[retrieve_ios_config] description: |- Download iOS JSON Config Generate iOS Configuration JSON file and provide as a file. summary: Retrieve Ios Config tags: - Integration security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/integration/v1/secrets/: get: operationId: api_integration_v1_secrets_retrieve_[retrieve_api_secret] description: |- Retrieve API Secret Retrieve already generated API secret. summary: Retrieve Api Secret parameters: - in: query name: organizationId schema: type: string required: true tags: - Integration security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrganizationAPISecretDTODRF' description: '' post: operationId: api_integration_v1_secrets_create_[generate_api_secret] description: |- Generate API Secret Generate new API secret for provided organization. summary: Generate Api Secret tags: - Integration requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateAPISecretRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GenerateAPISecretRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/GenerateAPISecretRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/OrganizationAPISecretDTODRF' description: '' delete: operationId: api_integration_v1_secrets_destroy_[delete_api_secret] description: |- Delete API Secret Delete API secret for provided organization. summary: Delete Api Secret tags: - Integration security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/location/v1/coordinates-search: get: operationId: api_location_v1_coordinates_search_retrieve_[search_location_by_coordinates] summary: Search Location By Coordinates parameters: - in: query name: language schema: type: string - in: query name: latitude schema: type: number format: float required: true - in: query name: longitude schema: type: number format: float required: true tags: - Location security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/LocationInfoDRF' description: '' /api/location/v1/place-search: get: operationId: api_location_v1_place_search_retrieve_[search_locations_by_text] summary: Search Locations By Text parameters: - in: query name: language schema: type: string - in: query name: query schema: type: string required: true tags: - Location security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/LocationInfoDRF' description: '' /api/natural-conditions/v1/heatmap: get: operationId: api_natural_conditions_v1_heatmap_retrieve_[heatmap_tile] summary: Heatmap Tile parameters: - in: query name: x schema: type: integer required: true - in: query name: y schema: type: integer required: true - in: query name: zoom schema: type: integer required: true tags: - Natural Conditions security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/natural-conditions/v1/natural-conditions: get: operationId: api_natural_conditions_v1_natural_conditions_retrieve_[retrieve_natural_conditions] summary: Retrieve Natural Conditions parameters: - in: query name: language schema: type: string - in: query name: latitude schema: type: number format: float required: true - in: query name: longitude schema: type: number format: float required: true tags: - Natural Conditions security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveNaturalConditionsResponseDRF' description: '' /api/notification/v1/device: get: operationId: api_notification_v1_device_retrieve_[get_user_devices] description: |- List user devices Provides list of user devices which are currently registered in system summary: Get User Devices tags: - Devices security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DevicesResponseDataDRF' description: '' /api/notification/v1/device/register: post: operationId: api_notification_v1_device_register_create_[register_device] description: |- Register device Registers user device in system, which can later be used for sending push notifications. summary: Register Device tags: - Devices requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterDeviceRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RegisterDeviceRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RegisterDeviceRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/notification/v1/device/unregister: delete: operationId: api_notification_v1_device_unregister_destroy_[unregister_device] description: |- Unregister device Removes user device from system based on push id summary: Unregister Device tags: - Devices security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/plugin/v1/deployment/{deployment_id}/configs/: get: operationId: api_plugin_v1_deployment_configs_retrieve_[retrieve_plugin_container_for_deployment] description: Retrieve Plugin Container for a Deployment summary: Retrieve Plugin Container For Deployment parameters: - in: path name: deploymentId schema: type: string required: true - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Plugins security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrievePluginContainerResponseObjectDRF' description: '' /api/plugin/v1/deployment/{deployment_id}/configs/{config_name}: get: operationId: api_plugin_v1_deployment_configs_retrieve_[retrieve_plugin_config_for_deployment] description: Retrieve Plugin Config for a Deployment summary: Retrieve Plugin Config For Deployment parameters: - in: path name: configName schema: type: string required: true - in: path name: config_name schema: type: string required: true - in: path name: deploymentId schema: type: string required: true - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Plugins security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrievePluginConfigResponseObjectDRF' description: '' put: operationId: api_plugin_v1_deployment_configs_update_[update_plugin_config_for_deployment] description: Update Plugin Config for a Deployment summary: Update Plugin Config For Deployment parameters: - in: path name: config_name schema: type: string required: true - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Plugins requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDeploymentPluginConfigRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateDeploymentPluginConfigRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateDeploymentPluginConfigRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdatePluginConfigResponseObjectDRF' description: '' /api/plugin/v1/organization/{organization_id}/configs/: get: operationId: api_plugin_v1_organization_configs_retrieve_[retrieve_plugin_container_for_org] description: Retrieve Plugin Container for an Organization summary: Retrieve Plugin Container For Org parameters: - in: path name: organizationId schema: type: string required: true - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Plugins security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrievePluginContainerResponseObjectDRF' description: '' /api/plugin/v1/organization/{organization_id}/configs/{config_name}: get: operationId: api_plugin_v1_organization_configs_retrieve_[retrieve_plugin_config_for_org] description: Retrieve Plugin Config for an Organization summary: Retrieve Plugin Config For Org parameters: - in: path name: configName schema: type: string required: true - in: path name: config_name schema: type: string required: true - in: path name: organizationId schema: type: string required: true - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Plugins security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrievePluginConfigResponseObjectDRF' description: '' put: operationId: api_plugin_v1_organization_configs_update_[update_plugin_config_for_org] description: Update Plugin Config for an Organization summary: Update Plugin Config For Org parameters: - in: path name: config_name schema: type: string required: true - in: path name: organization_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Plugins requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOrganizationPluginConfigRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateOrganizationPluginConfigRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateOrganizationPluginConfigRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdatePluginConfigResponseObjectDRF' description: '' /api/plugins/v1/five_lives/user/{user_id}: get: operationId: api_plugins_v1_five_lives_user_retrieve_[fetch_user_data] description: |- Fetch User Data Returns the user data including score history, rank, and instructions shown history. summary: Fetch User Data parameters: - in: query name: userId schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Servier Five Lives responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDataResponseDRF' description: '' /api/plugins/v1/five_lives/user/{user_id}/history: post: operationId: api_plugins_v1_five_lives_user_history_create_[update_history] description: |- Update History Updates the score history and rank for a specific game. summary: Update History parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Servier Five Lives requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateHistoryRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateHistoryRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateHistoryRequestObjectDRF' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDataResponseDRF' description: '' /api/plugins/v1/five_lives/user/{user_id}/instructions: post: operationId: api_plugins_v1_five_lives_user_instructions_create_[update_instructions_shown_history] description: |- Update Instructions Shown History Sets the specified keys in the instructions shown history to true. summary: Update Instructions Shown History parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Servier Five Lives requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateInstructionsShownHistoryRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateInstructionsShownHistoryRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateInstructionsShownHistoryRequestObjectDRF' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDataResponseDRF' description: '' /api/plugins/v1/five_lives/user/{user_id}/token: post: operationId: api_plugins_v1_five_lives_user_token_create_[create_auth_token] description: |- Create Auth Token for Five Lives Creates an authentication token with limited scope and longer lifetime to access Five Lives games APIs. summary: Create Auth Token parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Servier Five Lives requestBody: content: application/json: schema: $ref: '#/components/schemas/FiveLivesTokenRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/FiveLivesTokenRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/FiveLivesTokenRequestObjectDRF' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FiveLivesTokenResponseObjectDRF' description: '' /api/plugins/v1/order-management/products: get: operationId: api_plugins_v1_order_management_products_retrieve_[list_products] description: |- List Products Returns all available products. summary: List Products tags: - Order Management security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProductsResponseDRF' description: '' /api/plugins/v1/order-management/user/{user_id}/order: post: operationId: api_plugins_v1_order_management_user_order_create_[create_order] description: |- Create OrderDTO Creates a new order for the user. summary: Create Order parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Order Management requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOrderRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateOrderRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateOrderRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/plugins/v1/order-management/user/{user_id}/order/{order_id}: put: operationId: api_plugins_v1_order_management_user_order_update_[update_order] description: |- Update OrderDTO Updates an order's status or cart. summary: Update Order parameters: - in: path name: order_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Order Management requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOrderRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateOrderRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateOrderRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/plugins/v1/order-management/user/{user_id}/orders: get: operationId: api_plugins_v1_order_management_user_orders_retrieve_[list_orders] description: |- List Orders Returns all orders for the user. summary: List Orders parameters: - in: query name: userId schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Order Management security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListOrdersResponseObjectDRF' description: '' /api/public/v1/internationalization/languages: get: operationId: api_public_v1_internationalization_languages_retrieve_[list_languages_route] summary: List Languages Route tags: - Misc security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListRetrieveLanguageDRF' description: '' /api/public/v1/invitation-validity/{invitation_code}: get: operationId: api_public_v1_invitation_validity_retrieve_[invitation_validity_check] description: |- Check invitation validity Checks if invitation code is valid or not summary: Invitation Validity Check parameters: - in: path name: invitation_code schema: type: string required: true tags: - Invitations security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvitationValidityResponseObjectDRF' description: '' /api/public/v1/module-invite/{shortcode}: get: operationId: api_public_v1_module_invite_retrieve_[get_module_invite] description: |- Verify Shortcode Verify public module invitation shortcode summary: Get Module Invite parameters: - in: path name: shortcode schema: type: string required: true tags: - Module Results security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrievePublicModuleResponseObjectDRF' description: '' /api/public/v1/module-invite/{shortcode}/verify-dob: post: operationId: api_public_v1_module_invite_verify_dob_create_[verify_dob_of_module_invite] description: |- Verify DOB Verify public module invitation using date_of_birth summary: Verify Dob Of Module Invite parameters: - in: path name: shortcode schema: type: string required: true tags: - Module Results requestBody: content: application/json: schema: $ref: '#/components/schemas/VerifyPublicModuleRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/VerifyPublicModuleRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/VerifyPublicModuleRequestObjectDRF' required: true security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerifyPublicModuleResponseObjectDRF' description: '' /api/public/v1/region: get: operationId: api_public_v1_region_retrieve_[get_region] summary: Get Region tags: - Misc security: - {} responses: '200': description: No response body /api/public/v1/video/{video_call_id}/complete: post: operationId: api_public_v1_video_complete_create_[complete_video_call_public] summary: Complete Video Call Public parameters: - in: path name: video_call_id schema: type: string required: true tags: - Video Call requestBody: content: application/json: schema: $ref: '#/components/schemas/CompleteVideoCallRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CompleteVideoCallRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CompleteVideoCallRequestObjectDRF' required: true security: - {} responses: '204': description: No response body /api/sdk/v1/deployment/{deployment_id}/builder/tabs: post: operationId: api_sdk_v1_deployment_builder_tabs_create_[add_tab] description: |- Add Tab Adds a new tab to the builder for the specified deployment. summary: Add Tab parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Builder requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTabRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateTabRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/CreateTabRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/sdk/v1/deployment/{deployment_id}/builder/tabs/{tab_id}: put: operationId: api_sdk_v1_deployment_builder_tabs_update_[update_tab] description: |- Update Tab Updates an existing tab in the builder for the specified deployment. summary: Update Tab parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: tab_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Builder requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTabRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateTabRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateTabRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' delete: operationId: api_sdk_v1_deployment_builder_tabs_destroy_[remove_tab] description: |- Remove Tab Removes a specific tab from the builder for the specified deployment. summary: Remove Tab parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: tab_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Builder security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/sdk/v1/deployment/{deployment_id}/builder/tabs/{tab_id}/widgets: post: operationId: api_sdk_v1_deployment_builder_tabs_widgets_create_[add_widget] description: |- Add Widget Adds a new widget to the specified tab in the builder. summary: Add Widget parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: tab_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Builder requestBody: content: application/json: schema: $ref: '#/components/schemas/BaseWidgetRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BaseWidgetRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/BaseWidgetRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/sdk/v1/deployment/{deployment_id}/builder/tabs/{tab_id}/widgets/{widget_id}: put: operationId: api_sdk_v1_deployment_builder_tabs_widgets_update_[update_widget] description: |- Update Widget Updates an existing widget in the specified tab. summary: Update Widget parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: tab_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Builder requestBody: content: application/json: schema: $ref: '#/components/schemas/BaseWidgetRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BaseWidgetRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/BaseWidgetRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' delete: operationId: api_sdk_v1_deployment_builder_tabs_widgets_destroy_[remove_widget] description: |- Remove Widget Removes a specific widget from the specified tab. summary: Remove Widget parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: tab_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Builder security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/sdk/v1/deployment/{deployment_id}/builder/tabs/{tab_id}/widgets/reorder: put: operationId: api_sdk_v1_deployment_builder_tabs_widgets_reorder_update_[reorder_widgets] description: |- Reorder Widgets Changes the order of multiple widgets within a tab in the builder interface at once. summary: Reorder Widgets parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: tab_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Builder requestBody: content: application/json: schema: $ref: '#/components/schemas/ReorderWidgetsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ReorderWidgetsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ReorderWidgetsRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' /api/sdk/v1/deployment/{deployment_id}/builder/tabs/reorder: put: operationId: api_sdk_v1_deployment_builder_tabs_reorder_update_[reorder_tabs] description: |- Reorder Tabs Changes the order of multiple tabs in the builder interface at once. summary: Reorder Tabs parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Builder requestBody: content: application/json: schema: $ref: '#/components/schemas/ReorderTabsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ReorderTabsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ReorderTabsRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' /api/sdk/v1/deployment/{deployment_id}/builder/widgets/move: post: operationId: api_sdk_v1_deployment_builder_widgets_move_create_[move_widget] description: |- Move Widget Moves a widget from one tab to another within the same deployment. summary: Move Widget parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Builder requestBody: content: application/json: schema: $ref: '#/components/schemas/MoveWidgetRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/MoveWidgetRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/MoveWidgetRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/sdk/v1/deployment/{deployment_id}/builder/widgets/validate: put: operationId: api_sdk_v1_deployment_builder_widgets_validate_update_[validate_widget] description: |- Validate Widget Validates a widget configuration for the specified deployment. summary: Validate Widget parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Builder requestBody: content: application/json: schema: $ref: '#/components/schemas/ValidateWidgetRequestDataDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ValidateWidgetRequestDataDRF' multipart/form-data: schema: $ref: '#/components/schemas/ValidateWidgetRequestDataDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' /api/sdk/v1/deployment/{deployment_id}/draft: post: operationId: api_sdk_v1_deployment_draft_create_[create_draft] summary: Create Draft parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/sdk/v1/deployment/{deployment_id}/publish: post: operationId: api_sdk_v1_deployment_publish_create_[publish_draft] summary: Publish Draft parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/PublishDeploymentRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PublishDeploymentRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/PublishDeploymentRequestBodyDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/sdk/v1/deployment/{deployment_id}/releases: get: operationId: api_sdk_v1_deployment_releases_retrieve_[retrieve_releases] summary: Retrieve Releases parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReleasesResponseObjectDRF' description: '' /api/sdk/v1/deployment/{deployment_id}/rollback: post: operationId: api_sdk_v1_deployment_rollback_create_[rollback_draft] summary: Rollback Draft parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment requestBody: content: application/json: schema: $ref: '#/components/schemas/RollbackRequestBodyDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RollbackRequestBodyDRF' multipart/form-data: schema: $ref: '#/components/schemas/RollbackRequestBodyDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/sdk/v1/deployment/{deployment_id}/versions: get: operationId: api_sdk_v1_deployment_versions_retrieve_[retrieve_versions] summary: Retrieve Versions parameters: - in: path name: deployment_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Deployment security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VersionsResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/ai.lifelight.widget.ai_scan/{widget_id}: get: operationId: api_sdk_v1_user_widget_ai.lifelight.widget.ai_scan_retrieve_[func] description: Ai Lifelight Widget Ai Scan summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.connection/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.connection_retrieve_[func] description: Connection summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/sdk/v1/user/{user_id}/widget/com.huma.widget.device_sync/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.device_sync_retrieve_[func] description: Device Sync summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/sdk/v1/user/{user_id}/widget/com.huma.widget.diary/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.diary_retrieve_[func] description: Diary summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DiaryWidgetResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.epro.act/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.epro.act_retrieve_[func] description: ePRO ACT summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.epro.ahq/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.epro.ahq_retrieve_[func] description: ePRO AHQ summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.epro.cat/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.epro.cat_retrieve_[func] description: ePRO CAT summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.epro.dds/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.epro.dds_retrieve_[func] description: ePRO DDS summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.epro.eq5d5l/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.epro.eq5d5l_retrieve_[func] description: ePRO EQ5D5L summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.epro.gad7/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.epro.gad7_retrieve_[func] description: ePRO GAD7 summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.epro.ikdc/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.epro.ikdc_retrieve_[func] description: ePRO IKDC summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.epro.kccq/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.epro.kccq_retrieve_[func] description: ePRO KCCQ summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.epro.mg_adl/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.epro.mg_adl_retrieve_[func] description: ePRO MG_ADL summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.epro.ndi/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.epro.ndi_retrieve_[func] description: ePRO NDI summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.epro.odi/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.epro.odi_retrieve_[func] description: ePRO ODI summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.epro.phq8/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.epro.phq8_retrieve_[func] description: ePRO PHQ8 summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.epro.promis_pain/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.epro.promis_pain_retrieve_[func] description: ePRO PROMIS Pain summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.epro.promis_physical/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.epro.promis_physical_retrieve_[func] description: ePRO PROMIS Physical summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.epro.pss/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.epro.pss_retrieve_[func] description: ePRO PSS summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.epro.sf36/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.epro.sf36_retrieve_[func] description: ePRO SF36 summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.epro.whq/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.epro.whq_retrieve_[func] description: ePRO WHQ summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.featuredArticles/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.featuredArticles_retrieve_[func] description: Featured Articles summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CMSLearnArticleResponseDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.feedback.sleep/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.feedback.sleep_retrieve_[func] description: Feedback Sleep summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/sdk/v1/user/{user_id}/widget/com.huma.widget.five_lives/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.five_lives_retrieve_[func] description: FiveLives summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FiveLivesWidgetResponseDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.geolocation/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.geolocation_retrieve_[func] description: Geolocation summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GeolocationDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.header/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.header_retrieve_[func] description: Header summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/sdk/v1/user/{user_id}/widget/com.huma.widget.health-coach/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.health_coach_retrieve_[func] description: Health Coach summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/sdk/v1/user/{user_id}/widget/com.huma.widget.huma_watch/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.huma_watch_retrieve_[func] description: Huma Watch summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/sdk/v1/user/{user_id}/widget/com.huma.widget.learn/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.learn_retrieve_[func] description: Learn summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/LearnWidgetSectionResponseDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.medication/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.medication_retrieve_[func] description: Medication summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/sdk/v1/user/{user_id}/widget/com.huma.widget.mg.arm_fatigue/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.mg.arm_fatigue_retrieve_[func] description: MG Arm Fatigue summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MGDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.mg.ptosis/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.mg.ptosis_retrieve_[func] description: MG Ptosis summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MGDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.mg.voice_assessments/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.mg.voice_assessments_retrieve_[func] description: MG Voice Assessments summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VADataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.oms/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.oms_retrieve_[func] description: Order Management System summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OMSWidgetResponseDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.profile/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.profile_retrieve_[func] description: Profile summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/sdk/v1/user/{user_id}/widget/com.huma.widget.questionnaire.cms.scored/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.questionnaire.cms.scored_retrieve_[func] description: Questionnaire Cms Scored summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/QuestionnaireWidgetResponseDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.questionnaire.cms/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.questionnaire.cms_retrieve_[func] description: Questionnaire Cms summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/QuestionnaireWidgetResponseDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.questionnaire.scored/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.questionnaire.scored_retrieve_[func] description: Questionnaire Scored summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/QuestionnaireWidgetResponseDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.questionnaire/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.questionnaire_retrieve_[func] description: Questionnaire summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/QuestionnaireWidgetResponseDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.reminder/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.reminder_retrieve_[func] description: Reminder summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/sdk/v1/user/{user_id}/widget/com.huma.widget.surgery_checklist/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.surgery_checklist_retrieve_[func] description: Surgery Checklist summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SurgeryChecklistWidgetResponseDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.todo/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.todo_retrieve_[func] description: Todo summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ToDoWidgetResponseDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.treatment/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.treatment_retrieve_[func] description: Treatment summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TreatmentWidgetResponseDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.virtual_care.hypertension/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.virtual_care.hypertension_retrieve_[func] description: Virtual Care Hypertension summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HypertensionWidgetResponseDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.virtual_care/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.virtual_care_retrieve_[func] description: Virtual Care summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualCareWidgetResponseDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.air_quality/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.air_quality_retrieve_[func] description: Vitals Air Quality summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.blood_glucose/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.blood_glucose_retrieve_[func] description: Vitals Blood Glucose summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.blood_pressure/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.blood_pressure_retrieve_[func] description: Vitals Blood Pressure summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.bmi/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.bmi_retrieve_[func] description: Vitals BMI summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.body_power/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.body_power_retrieve_[func] description: Vitals Body Power summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.body_stress/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.body_stress_retrieve_[func] description: Vitals Body Stress summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.cvd_risk_score/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.cvd_risk_score_retrieve_[func] description: CVD Risk Score summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.daily_check_in/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.daily_check_in_retrieve_[func] description: Vitals Daily Check In summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.heart_rate/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.heart_rate_retrieve_[func] description: Vitals Heart Rate summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.journal/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.journal_retrieve_[func] description: Vitals Journal summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.medication/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.medication_retrieve_[func] description: Vitals Medication summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.oxygen_saturation/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.oxygen_saturation_retrieve_[func] description: Vitals Oxygen Saturation summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.peak_flow/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.peak_flow_retrieve_[func] description: Vitals Peak Flow summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.photo/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.photo_retrieve_[func] description: Vitals Photo summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.respiratory_rate/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.respiratory_rate_retrieve_[func] description: Vitals Respiratory Rate summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.sleep/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.sleep_retrieve_[func] description: Vitals Sleep summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.spirometry/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.spirometry_retrieve_[func] description: Vitals Spirometry summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.step/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.step_retrieve_[func] description: Vitals Step summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.symptom/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.symptom_retrieve_[func] description: Vitals Symptom summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.temperature/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.temperature_retrieve_[func] description: Vitals Temperature summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.vitals.weight/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.vitals.weight_retrieve_[func] description: Vitals Weight summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VitalsDataResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.welcome/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.welcome_retrieve_[func] description: Welcome summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WelcomeWidgetResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.huma.widget.wellness/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.wellness_retrieve_[func] description: Wellness summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/sdk/v1/user/{user_id}/widget/com.huma.widget.who/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.huma.widget.who_retrieve_[func] description: WHO summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WHOWidgetResponseDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.pfizer.widget.hemophilia_journal/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.pfizer.widget.hemophilia_journal_retrieve_[func] description: Com Pfizer Widget Hemophilia Journal summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HemophiliaResponseObjectDRF' description: '' /api/sdk/v1/user/{user_id}/widget/com.roche.widget.pre_eclampsia_risk/{widget_id}: get: operationId: api_sdk_v1_user_widget_com.roche.widget.pre_eclampsia_risk_retrieve_[func] description: Com Roche Widget Pre Eclampsia Risk summary: Func parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: widget_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Widgets security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CDSDataResponseObjectDRF' description: '' /api/spirometry/v1/user/{user_id}/reports: get: operationId: api_spirometry_v1_user_reports_retrieve_[retrieve_spirometry_reports] description: Retrieve spirometry reports for user per reading. summary: Retrieve Spirometry Reports parameters: - in: query name: spirometryId schema: type: string required: true - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Spirometry security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpirometryReportDTODRF' description: '' /api/storage/v1/download/{file_id}: get: operationId: api_storage_v1_download_retrieve_[download_file_v1] description: |- Download file Download requested file from bucket summary: Download File V1 parameters: - in: path name: file_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Storage security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/storage/v1/signed-url/{file_id}: get: operationId: api_storage_v1_signed_url_retrieve_[retrieve_download_url_v1] description: |- Get signed url Generate signed url for provided file summary: Retrieve Download Url V1 parameters: - in: path name: file_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Storage security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetSignedUrlResponseObjectV1DRF' description: '' /api/storage/v1/signed-urls: post: operationId: api_storage_v1_signed_urls_create_[retrieve_download_urls_v1] description: |- Retrieve signed URLs Retrieve signed urls for multiple files provided summary: Retrieve Download Urls V1 tags: - Storage requestBody: content: application/json: schema: $ref: '#/components/schemas/GetSignedUrlsRequestObjectV1DRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GetSignedUrlsRequestObjectV1DRF' multipart/form-data: schema: $ref: '#/components/schemas/GetSignedUrlsRequestObjectV1DRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetSignedUrlsResponseObjectV1DRF' description: '' /api/storage/v1/upload: post: operationId: api_storage_v1_upload_create_[upload_file_v1] description: |- Upload file Upload provided file to bucket summary: Upload File V1 tags: - Storage V1 requestBody: content: application/json: schema: $ref: '#/components/schemas/UploadFileRequestObjectV1DRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UploadFileRequestObjectV1DRF' multipart/form-data: schema: $ref: '#/components/schemas/UploadFileRequestObjectV1DRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '413': description: No response body '201': content: application/json: schema: $ref: '#/components/schemas/UploadFileResponseObjectV1DRF' description: '' /api/storage/v1beta/download/{bucket}/{filename}: get: operationId: api_storage_v1beta_download_retrieve_[download_file] summary: Download File parameters: - in: path name: bucket schema: type: string required: true - in: path name: filename schema: type: string required: true tags: - Storage security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] deprecated: true responses: {} /api/storage/v1beta/signed/url/{bucket}/{filename}: get: operationId: api_storage_v1beta_signed_url_retrieve_[retrieve_download_url] summary: Retrieve Download Url parameters: - in: path name: bucket schema: type: string required: true - in: path name: filename schema: type: string required: true tags: - Storage security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] deprecated: true responses: {} /api/storage/v1beta/upload/{bucket}: post: operationId: api_storage_v1beta_upload_create_[upload_file] summary: Upload File parameters: - in: path name: bucket schema: type: string required: true tags: - Storage security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] deprecated: true responses: {} /api/twilio/v1/invitation-status/update: post: operationId: api_twilio_v1_invitation_status_update_create_[update_invitation_status] summary: Update Invitation Status tags: - Invitation Status security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' /api/v1/audit-log: post: operationId: api_v1_audit_log_create_[retrieve_audit_logs] summary: Retrieve Audit Logs tags: - Audit Log security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/v1/audit-log/actions: get: operationId: api_v1_audit_log_actions_retrieve_[retrieve_audit_log_actions] summary: Retrieve Audit Log Actions tags: - Audit Log security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/v1/audit-log/generate-csv: post: operationId: api_v1_audit_log_generate_csv_create_[generate_audit_logs_csv] summary: Generate Audit Logs Csv tags: - Audit Log security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/v1/billing-portal/bill/{billId}/charge/{chargeId}: get: operationId: api_v1_billing_portal_bill_charge_retrieve_[get_billing_charge_record] summary: Get Billing Charge Record parameters: - in: path name: authzUser schema: type: string required: true - in: path name: billId schema: type: string required: true - in: path name: chargeId schema: type: string required: true tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CptChargeUnitObjectDRF' description: '' /api/v1/billing-portal/bill/{billId}/charges/delete: delete: operationId: api_v1_billing_portal_bill_charges_delete_destroy_[delete_billing_charge_record] summary: Delete Billing Charge Record parameters: - in: path name: billId schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeleteChargeResponseObjectDRF' description: '' /api/v1/billing-portal/bill/{bill_id}/{charge_id}: patch: operationId: api_v1_billing_portal_bill_partial_update_[update_billing_charge_record] summary: Update Billing Charge Record parameters: - in: path name: bill_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: path name: charge_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedChargeUnitRecordRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedChargeUnitRecordRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/PatchedChargeUnitRecordRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/v1/billing-portal/bill/{bill_id}/charges: post: operationId: api_v1_billing_portal_bill_charges_create_[create_billing_charges_records] summary: Create Billing Charges Records parameters: - in: path name: bill_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/AppendChargeToBillRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AppendChargeToBillRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/AppendChargeToBillRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/v1/billing-portal/billing/{bill_id}/charge: put: operationId: api_v1_billing_portal_billing_charge_update_[create_billing_charge_record] summary: Create Billing Charge Record parameters: - in: path name: bill_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateChargeUnitRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateChargeUnitRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateChargeUnitRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListIdResponseObjectDRF' description: '' /api/v1/billing-portal/call-export-task: post: operationId: api_v1_billing_portal_call_export_task_create_[call_export_task] description: |- Call the export task for the Billing Portal. This endpoint is used to trigger the export of billing data. Month and year are taken from the request query parameters. summary: Call Export Task parameters: - in: query name: deploymentId schema: type: string - in: query name: exportMonth schema: type: integer - in: query name: exportYear schema: type: integer tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '202': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' /api/v1/billing-portal/client-medical-records: get: operationId: api_v1_billing_portal_client_medical_records_retrieve_[get_client_medical_record] description: |- Get client medical records for the Billing Portal. This endpoint is used to retrieve client medical records. summary: Get Client Medical Record parameters: - in: query name: clientId schema: type: string - in: query name: reportEndDate schema: type: string format: date-time - in: query name: yearMonth schema: type: string tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClientMedicalRecordResponseObjectDRF' description: '' /api/v1/billing-portal/clients: post: operationId: api_v1_billing_portal_clients_create_[add_client] description: Add a single client for the Billing Portal. summary: Add Client tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/AddClientRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AddClientRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/AddClientRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' /api/v1/billing-portal/clients/filter: post: operationId: api_v1_billing_portal_clients_filter_create_[get_clients_endpoint] summary: Get Clients Endpoint tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveClientsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveClientsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveClientsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveClientsResponseObjectDRF' description: '' /api/v1/billing-portal/cpt/{client_id}: get: operationId: api_v1_billing_portal_cpt_retrieve_[get_client_report] description: |- Get a client report for the Billing Portal. Responsible for rendering the client report page and downloading the client report data. summary: Get Client Report parameters: - in: query name: clientId schema: type: string required: true - in: path name: client_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true - in: query name: reportEndDate schema: type: string required: true tags: - Billing Portal Route security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: XLSX file /api/v1/billing-portal/cpt/billing/submitted: patch: operationId: api_v1_billing_portal_cpt_billing_submitted_partial_update_[update_billing_submitted_flag] summary: Update Billing Submitted Flag tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUpdateIsSubmittedRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedUpdateIsSubmittedRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/PatchedUpdateIsSubmittedRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdateIsSubmittedResponseObjectDRF' description: '' /api/v1/billing-portal/cpt/months: post: operationId: api_v1_billing_portal_cpt_months_create_[get_cpt_months] summary: Get Cpt Months tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveAvailableMonthsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RetrieveAvailableMonthsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/RetrieveAvailableMonthsRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveAvailableMonthsResponseObjectDRF' description: '' /api/v1/billing-portal/cpt/profiles: get: operationId: api_v1_billing_portal_cpt_profiles_retrieve_[get_cpt_profiles] description: |- Get Billing Portal profiles. Returns CPT profiles for the given year-month, filtered by accessible deployments and optional client/search. summary: Get Cpt Profiles parameters: - in: query name: clientId schema: type: string - in: query name: filter schema: type: string - in: query name: limit schema: type: integer - in: query name: requester schema: type: string required: true - in: query name: search schema: type: string - in: query name: skip schema: type: integer - in: query name: submitted schema: type: string - in: query name: yearMonth schema: type: string required: true tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetCPTProfilesResponseObjectDRF' description: '' /api/v1/billing-portal/deployment-client/: post: operationId: api_v1_billing_portal_deployment_client_create_[add_deployment_client] description: Add a deployment to a client for the Billing Portal. summary: Add Deployment Client tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/AddClientDeploymentRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AddClientDeploymentRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/AddClientDeploymentRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ResultIdResponseObjectDRF' description: '' put: operationId: api_v1_billing_portal_deployment_client_update_[update_deployment_client] description: Update a deployment for a client for the Billing Portal. summary: Update Deployment Client tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClientDeploymentRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateClientDeploymentRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpdateClientDeploymentRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' delete: operationId: api_v1_billing_portal_deployment_client_destroy_[delete_deployment_client] description: Delete a deployment for a client for the Billing Portal. summary: Delete Deployment Client tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' /api/v1/billing-portal/export-data: delete: operationId: api_v1_billing_portal_export_data_destroy_[delete_export] description: |- Delete the export data for the Billing Portal. This endpoint is used to remove the export of billing data. Month and year are taken from the request query parameters. summary: Delete Export parameters: - in: query name: deploymentId schema: type: string - in: query name: exportMonth schema: type: integer - in: query name: exportYear schema: type: integer tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': description: No response body /api/v1/billing-portal/export/cpt/profiles: get: operationId: api_v1_billing_portal_export_cpt_profiles_retrieve_[export_cpt_profile_overview] description: |- Get Billing Portal profiles. Returns CPT profiles for the given year-month, filtered by accessible deployments and optional client/search. summary: Export Cpt Profile Overview parameters: - in: query name: clientId schema: type: string - in: query name: file_name schema: type: string - in: query name: filter schema: type: string - in: query name: limit schema: type: integer - in: query name: requester schema: type: string required: true - in: query name: search schema: type: string - in: query name: skip schema: type: integer - in: query name: submitted schema: type: string - in: query name: yearMonth schema: type: string required: true tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/v1/billing-portal/export/invoice/client: post: operationId: api_v1_billing_portal_export_invoice_client_create_[export_invoice_details_csv] summary: Export Invoice Details Csv tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportClientInvoiceDetailsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ExportClientInvoiceDetailsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ExportClientInvoiceDetailsRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/v1/billing-portal/export/invoice/overview: get: operationId: api_v1_billing_portal_export_invoice_overview_retrieve_[export_invoices_overview_to_csv] summary: Export Invoices Overview To Csv parameters: - in: query name: authzUser schema: type: string - in: query name: clientId schema: type: string - in: query name: file_name schema: type: string - in: query name: format schema: type: string - in: query name: limit schema: type: integer - in: query name: search schema: type: string - in: query name: skip schema: type: integer - in: query name: yearMonth schema: type: string required: true tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/v1/billing-portal/generate/billing_and_invoices/: get: operationId: api_v1_billing_portal_generate_billing_and_invoices_retrieve_[generate_reports] description: Generate billing and invoice reports for the Billing Portal. summary: Generate Reports parameters: - in: query name: monthYear schema: type: string tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OkResponseDRF' description: '' /api/v1/billing-portal/get-clients-invoices: get: operationId: api_v1_billing_portal_get_clients_invoices_retrieve_[get_clients_invoices] description: |- Get all clients' invoices for the Billing Portal. This endpoint is used to retrieve all clients' invoices as a CSV file. If no report_end_date is provided, all reports from all dates will be included. If a report_end_date is provided, only reports for that date will be included. summary: Get Clients Invoices parameters: - in: query name: reportEndDate schema: type: string format: date-time tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/v1/billing-portal/import/salesforce: post: operationId: api_v1_billing_portal_import_salesforce_create_[add_sales_force_file] summary: Add Sales Force File tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AddSalesForceFileResponseObjectDRF' description: '' /api/v1/billing-portal/import/salesforce/: get: operationId: api_v1_billing_portal_import_salesforce_retrieve_[download_sales_force_file] description: Downloads the sales force file for the Billing Portal. summary: Download Sales Force File parameters: - in: query name: version schema: type: integer tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/v1/billing-portal/invoice/client: post: operationId: api_v1_billing_portal_invoice_client_create_[get_client_invoice_details] summary: Get Client Invoice Details tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientInvoiceDetailsRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ClientInvoiceDetailsRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/ClientInvoiceDetailsRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveClientsInvoicesResponseObjectDRF' description: '' /api/v1/billing-portal/invoice/overview: get: operationId: api_v1_billing_portal_invoice_overview_retrieve_[get_invoices_overview] summary: Get Invoices Overview parameters: - in: query name: authzUser schema: type: string - in: query name: clientId schema: type: string - in: query name: format schema: type: string - in: query name: limit schema: type: integer - in: query name: search schema: type: string - in: query name: skip schema: type: integer - in: query name: yearMonth schema: type: string required: true tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetrieveInvoiceOverviewResponseObjectDRF' description: '' /api/v1/billing-portal/patient-medical-records: get: operationId: api_v1_billing_portal_patient_medical_records_retrieve_[get_patient_medical_record] description: |- Get patient medical records for the Billing Portal. This endpoint is used to retrieve client medical records. summary: Get Patient Medical Record parameters: - in: query name: reportEndDate schema: type: string format: date-time - in: query name: userId schema: type: string - in: query name: yearMonth schema: type: string tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/v1/billing-portal/patient-medical-records/all/pdf: get: operationId: api_v1_billing_portal_patient_medical_records_all_pdf_retrieve_[get_patient_medical_record_all_pdf] description: |- Get all patient medical records for the Billing Portal. This endpoint retrieves all patient medical records in PDF formats, zipped together. summary: Get Patient Medical Record All Pdf parameters: - in: query name: reportEndDate schema: type: string format: date-time - in: query name: yearMonth schema: type: string tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/v1/billing-portal/patient-medical-records/pdf: get: operationId: api_v1_billing_portal_patient_medical_records_pdf_retrieve_[get_patient_medical_record_pdf] description: |- Get patient medical records for the Billing Portal. This endpoint retrieves patient medical records in PDF format. summary: Get Patient Medical Record Pdf parameters: - in: query name: reportEndDate schema: type: string format: date-time - in: query name: userId schema: type: string - in: query name: yearMonth schema: type: string tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': description: No response body /api/v1/billing-portal/performance: get: operationId: api_v1_billing_portal_performance_retrieve_[get_performance_overview] summary: Get Performance Overview parameters: - in: query name: authzUser schema: type: string - in: query name: filters schema: type: string - in: query name: limit schema: type: integer - in: query name: search schema: type: string - in: query name: skip schema: type: integer - in: query name: sort schema: type: string - in: query name: stateFilter schema: type: string tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PerformanceOverviewResponseObjectDRF' description: '' /api/v1/billing-portal/record: post: operationId: api_v1_billing_portal_record_create_[create_billing_record] summary: Create Billing Record tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/UpsertBillingRecordRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpsertBillingRecordRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/UpsertBillingRecordRequestObjectDRF' required: true security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpsertBillingRecordResponseObjectDRF' description: '' /api/v1/billing-portal/record/{bill_id}: get: operationId: api_v1_billing_portal_record_retrieve_[get_billing_record] summary: Get Billing Record parameters: - in: path name: bill_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetBillingRecordResponseObjectDRF' description: '' patch: operationId: api_v1_billing_portal_record_partial_update_[update_billing_record] summary: Update Billing Record parameters: - in: path name: bill_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUpdateBillingRecordRequestObjectDRF' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedUpdateBillingRecordRequestObjectDRF' multipart/form-data: schema: $ref: '#/components/schemas/PatchedUpdateBillingRecordRequestObjectDRF' security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '204': content: application/json: schema: $ref: '#/components/schemas/UpsertBillingRecordResponseObjectDRF' description: '' delete: operationId: api_v1_billing_portal_record_destroy_[delete_billing_record] summary: Delete Billing Record parameters: - in: path name: bill_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Billing security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeleteBillingRecordResponseObjectDRF' description: '' /api/v1/visit/user/{user_id}: post: operationId: api_v1_visit_user_create_[create_virtual_visit] description: Create a virtual visit with multiple module results summary: Create Virtual Visit parameters: - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Virtual Visit security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateVirtualCareResponseObjectDRF' description: '' /api/v1/visit/user/{user_id}/search: get: operationId: api_v1_visit_user_search_retrieve_[search_virtual_visits] description: Search for virtual visit instances grouped by moduleResultId summary: Search Virtual Visits parameters: - in: query name: limit schema: type: integer - in: query name: skip schema: type: integer - in: path name: user_id schema: type: string pattern: ^[a-f0-9]{24}$ required: true tags: - Virtual Visit security: - JWT Auth: [] - Hawk Auth: [] - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SearchVirtualVisitResponseObjectDRF' description: '' /docs/: get: operationId: docs_retrieve_[docs] summary: Docs tags: - Docs Route security: - {} responses: '200': description: No response body /health/live: get: operationId: health_live_retrieve_[live] description: |- Liveness check Checks the liveness of the server summary: Live tags: - Health Route security: - {} responses: '400': content: application/json: schema: $ref: '#/components/schemas/StatusResponseObjectDRF' description: '' /health/ready: get: operationId: health_ready_retrieve_[ready] description: |- Readiness check Checks the readiness of the server summary: Ready tags: - Health Route security: - {} responses: '400': content: application/json: schema: $ref: '#/components/schemas/StatusResponseObjectDRF' description: '' /install-app: get: operationId: install_app_retrieve_[install_app_html_page] summary: Install App Html Page tags: - Misc security: - {} responses: '200': description: No response body /install-huma-app: get: operationId: install_huma_app_retrieve_[get_install_app_link] summary: Get Install App Link tags: - Misc security: - {} responses: '200': description: No response body /privacy/e-label: get: operationId: privacy_e_label_retrieve_[e_label] summary: E Label parameters: - in: query name: buildNumber schema: type: string - in: query name: deploymentId schema: type: string - in: query name: host schema: type: string - in: query name: organizationId schema: type: string - in: query name: type schema: type: string tags: - Privacy Assets security: - {} responses: '200': description: HTML Template /privacy/instructions-for-use: get: operationId: privacy_instructions_for_use_retrieve_[instructions_for_use] summary: Instructions For Use parameters: - in: query name: type schema: type: string required: true tags: - Privacy Assets security: - {} responses: '200': description: No response body /version: get: operationId: version_retrieve_[retrieve_version] description: |- Retrieve version Provides detailed information about server build. summary: Retrieve Version tags: - Misc security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/VersionDRF' description: '' components: schemas: AHQDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer required: - deploymentId - deviceName - moduleId - userId - value AHQResultsDRF: type: object properties: AHQ: type: array items: $ref: '#/components/schemas/AHQDTODRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' AZFurtherPregnancyKeyActionTriggerDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string currentGroupCategory: type: string metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - currentGroupCategory - deploymentId - deviceName - metadata - moduleId - userId AZFurtherPregnancyKeyActionTriggerResultsDRF: type: object properties: AZFurtherPregnancyKeyActionTrigger: type: array items: $ref: '#/components/schemas/AZFurtherPregnancyKeyActionTriggerDTODRF' AZGroupKeyActionTriggerDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string firstVaccineDate: type: string format: date-time groupCategory: type: string metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - deploymentId - deviceName - firstVaccineDate - groupCategory - metadata - moduleId - userId AZGroupKeyActionTriggerResultsDRF: type: object properties: AZGroupKeyActionTrigger: type: array items: $ref: '#/components/schemas/AZGroupKeyActionTriggerDTODRF' AZScreeningQuestionnaireDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string hasReceivedCOVIDVacInPast4Weeks: type: boolean isAZVaccineFirstDose: type: boolean is18YearsOldDuringVaccination: type: boolean metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - deploymentId - deviceName - hasReceivedCOVIDVacInPast4Weeks - is18YearsOldDuringVaccination - isAZVaccineFirstDose - metadata - moduleId - userId AZScreeningQuestionnaireResultsDRF: type: object properties: AZScreeningQuestionnaire: type: array items: $ref: '#/components/schemas/AZScreeningQuestionnaireDTODRF' AZVaccineBatchNumberAutocompleteResponseDRF: type: object properties: limit: type: integer skip: type: integer values: type: array items: type: string required: - limit - skip - values AcceptabilityDRF: type: object properties: slowStart: type: boolean weakBlast: type: boolean weakEndBlow: type: boolean hasArtifacts: type: boolean has1stSecondArtifacts: type: boolean tooShort: type: boolean AddClientDeploymentRequestObjectDRF: type: object properties: clientId: type: string deploymentId: type: string AddClientRequestObjectDRF: type: object properties: name: type: string paymentFormula: type: string rate: type: integer required: - name - paymentFormula AddFilesToLibraryRequestObjectBodyDRF: type: object properties: libraryId: type: string deploymentId: type: string fileIds: type: array items: type: string required: - fileIds - libraryId AddRolesInputDRF: type: object properties: roleId: type: string resource: type: string userType: type: string isActive: type: boolean required: - resource - roleId AddRolesToUserResponseDRF: type: object properties: updatedUsers: type: integer AddRolesToUsersRequestDataDRF: type: object properties: userIds: type: array items: type: string allUsers: type: boolean roles: type: array items: $ref: '#/components/schemas/RoleAssignmentDTODRF' required: - roles AddSalesForceFileResponseObjectDRF: type: object properties: id: type: integer message: type: string AddUserNotesV2RequestDataDRF: type: object properties: note: type: string type: type: string required: - note AdditionalConsentQuestionDRF: type: object properties: type: type: string enabled: type: string format: type: string text: type: string description: type: string order: type: integer LocalizableFields: type: array items: type: string title: ' localizablefields' required: - enabled - format - text - type AdditionalContactDetailsDRF: type: object properties: altContactNumber: type: string regularContactName: type: string regularContactNumber: type: string emergencyContactName: type: string emergencyContactNumber: type: string AdditionalContactDetailsItemDRF: type: object properties: altContactNumber: type: boolean regularContactName: type: boolean regularContactNumber: type: boolean emergencyContactName: type: boolean emergencyContactNumber: type: boolean mandatoryFields: type: array items: type: string AdditionalFieldsDRF: type: object properties: inhaler: $ref: '#/components/schemas/InhalerInfoDRF' AdditionalQoLDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string viewFamily: type: string contactProfessionals: type: string contributeActivities: type: string metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - contactProfessionals - contributeActivities - deploymentId - deviceName - metadata - moduleId - userId - viewFamily AdditionalQoLResultsDRF: type: object properties: AdditionalQoL: type: array items: $ref: '#/components/schemas/AdditionalQoLDTODRF' AddressObjectDRF: type: object properties: fiatNumber: type: string buildingNumber: type: string buildingName: type: string street: type: string subStreet: type: string town: type: string state: type: string postcode: type: string country: type: string line1: type: string line2: type: string line3: type: string AdherenceDRF: type: object properties: unit: type: string value: type: integer type: type: string AggregateModuleResultsRequestObjectsDRF: type: object properties: function: type: string primitiveName: type: string mode: type: string fromDateTime: type: string format: date-time toDateTime: type: string format: date-time skip: type: integer limit: type: integer timezone: type: string moduleConfigId: type: string includeMaxRecord: type: boolean userId: type: string requesterTz: type: string required: - function - mode - primitiveName AggregateModuleResultsResponseObjectDRF: type: object properties: totalCount: type: integer value: type: number format: double valueMin: type: number format: double valueMax: type: number format: double valueAvg: type: number format: double flags: $ref: '#/components/schemas/FlagsDRF' startDateTime: type: string format: date-time endDateTime: type: string format: date-time timePeriod: $ref: '#/components/schemas/TimePeriodDRF' AirQualityDRF: type: object properties: current: $ref: '#/components/schemas/AqiByHourDRF' required: - current AirQualityIndexDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer latitude: type: number format: double longitude: type: number format: double required: - deploymentId - deviceName - latitude - longitude - moduleId - userId - value AirQualityResultsDRF: type: object properties: AirQualityIndex: type: array items: $ref: '#/components/schemas/AirQualityIndexDTODRF' AlcoholConsumptionDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string drinkAlcohol: type: boolean sections: type: array items: $ref: '#/components/schemas/AlcoholItemDRF' required: - deploymentId - deviceName - drinkAlcohol - moduleId - sections - userId AlcoholItemDRF: type: object properties: alcoholType: type: string bottleCount: type: integer canCount: type: integer pintCount: type: integer litreCount: type: integer largeGlassCount: type: integer standardGlassCount: type: integer smallGlassCount: type: integer smallShotCount: type: integer largeShotCount: type: integer glassCount: type: integer doubleCount: type: integer largeDoubleCount: type: integer singleCount: type: integer largeSingleCount: type: integer alcoholAverageStrength: type: string period: type: string required: - alcoholAverageStrength - alcoholType - period AndroidAppLinksDRF: type: object properties: relation: type: array items: type: string target: $ref: '#/components/schemas/AndroidAppTargetDRF' AndroidAppTargetDRF: type: object properties: namespace: type: string packageName: type: string sha256CertFingerprints: type: array items: type: string AnyOfCreateBloodPressureDRF_Or_CreateSymptomDRFItem: oneOf: - $ref: '#/components/schemas/CreateBloodPressureDRF' - $ref: '#/components/schemas/CreateSymptomDRF' AnyOfCreateBodyMeasurementDRF_Or_CreateHeartRateDRF_Or_CreateQuestionnaireDRFItem: oneOf: - $ref: '#/components/schemas/CreateQuestionnaireDRF' - $ref: '#/components/schemas/CreateHeartRateDRF' - $ref: '#/components/schemas/CreateBodyMeasurementDRF' AnyOfCreateBodyMeasurementDRF_Or_CreateQuestionnaireDRFItem: oneOf: - $ref: '#/components/schemas/CreateQuestionnaireDRF' - $ref: '#/components/schemas/CreateBodyMeasurementDRF' AnyOfCreateDysarthriaDRF_Or_CreateDysphoniaDRFItem: oneOf: - $ref: '#/components/schemas/CreateDysphoniaDRF' - $ref: '#/components/schemas/CreateDysarthriaDRF' AnyOfCreateQuestionnaireDRF_Or_CreateSymptomDRFItem: oneOf: - $ref: '#/components/schemas/CreateSymptomDRF' - $ref: '#/components/schemas/CreateQuestionnaireDRF' AppLinksDetailsDRF: type: object properties: appIDs: type: array items: type: string paths: type: array items: type: string AppSectionDRF: type: object properties: title: type: string order: type: integer type: type: string status: type: string onboardingItems: type: array items: $ref: '#/components/schemas/OnboardingItemDRF' moduleConfigId: type: string learnArticleId: type: string content: $ref: '#/components/schemas/LearnArticleContentDRF' required: - order - status - title - type AppendChargeToBillRequestObjectDRF: type: object properties: billId: type: string charges: type: array items: $ref: '#/components/schemas/ChargeUnitRecordRequestObjectDRF' AppleAppLinksDRF: type: object properties: apps: type: array items: type: string details: type: array items: $ref: '#/components/schemas/AppLinksDetailsDRF' ApplyEConsentActionRequestBodyDRF: type: object properties: enabled: type: string review: $ref: '#/components/schemas/ConsentReviewDRF' revision: type: integer additionalConsentQuestions: type: array items: $ref: '#/components/schemas/AdditionalConsentQuestionDRF' signature: $ref: '#/components/schemas/ConsentSignatureDRF' sections: type: array items: $ref: '#/components/schemas/EConsentSectionDRF' instituteName: type: string instituteFullName: type: string instituteTextDetails: type: string admissionText: type: string LocalizableFields: type: array items: type: string title: ' localizablefields' title: type: string overviewText: type: string contactText: type: string state: type: string reason: type: string deploymentIds: type: array items: type: string action: type: string required: - action - contactText - deploymentIds - enabled - overviewText - sections - title AppointmentDTODRF: type: object properties: id: type: string userId: type: string title: type: string description: type: string managerId: type: string status: type: string noteId: type: string callId: type: string keyActionId: type: string startDateTime: type: string format: date-time endDateTime: type: string format: date-time completeDateTime: type: string format: date-time createDateTime: type: string format: date-time updateDateTime: type: string format: date-time AqiByHourDRF: type: object properties: datetime: type: string indexes: $ref: '#/components/schemas/IndexDataDRF' healthRecommendations: type: object additionalProperties: {} required: - datetime - indexes AqiDataDRF: type: object properties: aqi: type: integer color: type: string category: type: string required: - aqi - category ArchiveFirmwareRequestObjectDRF: type: object properties: make: type: string model: type: string version: type: string required: - make - model - version ArchiveFirmwareResponseItemDRF: type: object properties: filename: type: string error: type: string required: - filename ArchiveFirmwareResponseObjectDRF: type: object properties: archived: type: array items: $ref: '#/components/schemas/ArchiveFirmwareResponseItemDRF' failed: type: array items: $ref: '#/components/schemas/ArchiveFirmwareResponseItemDRF' required: - archived - failed ArmAngleQualityCheckRequestObjectDRF: type: object properties: arm: type: string image: $ref: '#/components/schemas/S3ObjectDRF' language: type: string userId: type: string firstCheck: type: boolean numPrompt: type: integer required: - arm - firstCheck - image - numPrompt ArmAngleQualityCheckResponseObjectDRF: type: object properties: numPrompts: type: integer qcOutputMessage: type: string stopExercise: type: boolean canSubmitRecording: type: boolean required: - canSubmitRecording - numPrompts - qcOutputMessage - stopExercise ArmFatigueDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string arm: type: string angle: type: number format: double classification: type: string output: $ref: '#/components/schemas/S3ObjectDRF' recording: $ref: '#/components/schemas/S3ObjectDRF' time: type: number format: double required: - arm - deploymentId - deviceName - moduleId - recording - userId ArmFatigueResultsDRF: type: object properties: ArmFatigue: type: array items: $ref: '#/components/schemas/ArmFatigueDTODRF' ArticleDRF: type: object properties: id: type: string slug: type: string therapeutic: type: array items: type: string title: type: string titleImage: type: string readTimeInMinutes: type: integer body: type: string excerpt: type: string required: - id ArticleRatingDTODRF: type: object properties: id: type: string userId: type: string deploymentId: type: string createDateTime: type: string format: date-time updateDateTime: type: string format: date-time rating: type: string articleType: type: string articleId: type: string required: - articleId - articleType - rating - userId AssignCarePlanRequestObjectDRF: type: object properties: id: type: string userId: type: string name: type: string type: type: string description: type: string startDate: type: string format: date-time endDate: type: string format: date-time updateDateTime: type: string format: date-time createDateTime: type: string format: date-time required: - name - startDate - type AssignLabelsToUserRequestDataDRF: type: object properties: labelIds: type: array items: type: string required: - labelIds AssignLabelsToUsersRequestDataDRF: type: object properties: labelIds: type: array items: type: string userIds: type: array items: type: string required: - labelIds - userIds AssignManagersToUsersRequestDataDRF: type: object properties: managerIds: type: array items: type: string userIds: type: array items: type: string allUsers: type: boolean required: - managerIds AssignUsersResponseDRF: type: object properties: assignedUsers: type: integer AsthmaControlTestDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer required: - deploymentId - deviceName - moduleId - userId - value AsthmaControlTestResultsDRF: type: object properties: AsthmaControlTest: type: array items: $ref: '#/components/schemas/AsthmaControlTestDTODRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' AuthProfileRequestObjectDRF: type: object properties: authToken: type: string AuthProfileResponseObjectDRF: type: object properties: uid: type: string AuthorisedRepDRF: type: object properties: iconObject: $ref: '#/components/schemas/S3ObjectDRF' addressTitle: type: string address: type: string showBuildNumber: type: boolean required: - address - addressTitle - iconObject - showBuildNumber AuthorizeFitbitRequestDataDRF: type: object properties: type: type: string code: type: string required: - code - type AutocompleteMetadataDTODRF: type: object properties: moduleId: type: string language: type: string s3Object: $ref: '#/components/schemas/S3ObjectDRF' updateDateTime: type: string format: date-time required: - language - moduleId - s3Object AwarenessTrainingDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string certificateNumber: type: string totalHealthScore: type: integer status: type: string required: - deploymentId - deviceName - moduleId - userId AwarenessTrainingResultsDRF: type: object properties: AwarenessTraining: type: array items: $ref: '#/components/schemas/AwarenessTrainingDTODRF' AxisDataDRF: type: object properties: mainText: type: string secondaryText: type: string valueDate: type: string format: date-time valueInt: type: integer valueDouble: type: number format: double AxisStepsDRF: type: object properties: default: type: number format: double min: type: number format: double max: type: number format: double required: - default BMIDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double valueUnit: type: string originalValue: type: number format: double originalUnit: type: string required: - deploymentId - deviceName - moduleId - userId - value BMIResultsDRF: type: object properties: BMI: type: array items: $ref: '#/components/schemas/BMIDTODRF' Weight: type: array items: $ref: '#/components/schemas/WeightDTODRF' BodyComposition: type: array items: $ref: '#/components/schemas/BodyCompositionDTODRF' BTPSInfoDRF: type: object properties: temperature: type: number format: double pressure: type: number format: double humidity: type: number format: double lowBTPSCoef: type: array items: type: number format: double highBTPSCoef: type: array items: type: number format: double required: - highBTPSCoef - humidity - lowBTPSCoef - pressure - temperature BabyInfoDRF: type: object properties: pregnancyForBaby: type: string dateDelivery: type: string format: date-time pregnancyDuration: type: integer specifiedOutcome: type: array items: type: string babyGender: type: string methodDelivery: type: string isBreastfeedingBaby: type: boolean isCurrentlyBreastfeedingBaby: type: boolean breastfeedLongTerm: type: integer isBabyNoLiquid: type: boolean isBabyIssues: type: string specifiedIssues: type: array items: type: string required: - pregnancyForBaby BackgroundDRF: type: object properties: value: type: string type: type: string required: - type - value BackgroundInformationDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string age: type: integer sexAtBirth: type: string genderIdentity: type: string genderOther: type: string residenceCountry: type: string birthCountry: type: string weight: type: number format: double height: type: number format: double employment: type: string otherEmployment: type: string isHealthcareWorker: type: boolean smokingStatus: type: string smokingStopped: type: string metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - age - birthCountry - deploymentId - deviceName - employment - genderIdentity - height - metadata - moduleId - residenceCountry - sexAtBirth - smokingStatus - userId - weight BackgroundInformationResultsDRF: type: object properties: BackgroundInformation: type: array items: $ref: '#/components/schemas/BackgroundInformationDTODRF' BasePhoenixDynamicConfigDRF: type: object properties: updateDateTime: type: string format: date-time createDateTime: type: string format: date-time BaseThirdPartyAppRequestObjectDRF: type: object properties: type: type: string appUserId: type: string accessToken: type: string refreshToken: type: string permissions: type: array items: type: string status: type: string lastSyncDateTime: type: string format: date-time required: - accessToken - appUserId - refreshToken - status - type BaseVersionDRF: type: object properties: server: type: string api: type: string build: type: string required: - api - server BaseWidgetRequestObjectDRF: type: object properties: order: type: integer enabled: type: boolean config: type: object additionalProperties: {} type: type: string moduleUpdate: type: object additionalProperties: {} required: - config - order - type BillingMonitoringLogsResponseObjectDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/ResponseBillingMonitoringLogDTODRF' total: type: integer limit: type: integer skip: type: integer required: - items - total BloodGlucoseDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double valueUnit: type: string originalValue: type: number format: double originalUnit: type: string required: - deploymentId - deviceName - moduleId - userId - value BloodGlucoseResultsDRF: type: object properties: BloodGlucose: type: array items: $ref: '#/components/schemas/BloodGlucoseDTODRF' BloodPressureDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string diastolicValue: type: integer systolicValue: type: integer diastolicValueUnit: type: string systolicValueUnit: type: string takenMedications: type: array items: type: string required: - deploymentId - deviceName - diastolicValue - moduleId - systolicValue - userId BloodPressureResultsDRF: type: object properties: BloodPressure: type: array items: $ref: '#/components/schemas/BloodPressureDTODRF' BoardingStatusDRF: type: object properties: status: type: string updateDateTime: type: string format: date-time submitterId: type: string reasonOffBoarded: type: string detailsOffBoarded: type: string required: - status BodyCompositionDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/CustomDeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string bmiDevice: type: number format: double restingMetabolism: type: integer visceralFatLevel: type: integer visceralFatLevelClassification: type: integer bodyFatLevel: type: integer bodyFatPercentage: type: number format: double skeletalMuscleLevel: type: integer skeletalMuscleLevelPercentage: type: number format: double required: - deploymentId - deviceName - moduleId - userId BodyMapItemDRF: type: object properties: location: type: string color: type: string BodyMeasurementDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string visceralFat: type: number format: double totalBodyFat: type: number format: double waistCircumference: type: number format: double waistCircumferenceUnit: type: string hipCircumference: type: number format: double hipCircumferenceUnit: type: string waistToHipRatio: type: number format: double required: - deploymentId - deviceName - moduleId - userId BodyMeasurementResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' BodyMeasurement: type: array items: $ref: '#/components/schemas/BodyMeasurementDTODRF' BodyPowerDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double minValue: type: integer maxValue: type: integer medianValue: type: number format: double rawDataObject: $ref: '#/components/schemas/S3ObjectDRF' required: - deploymentId - deviceName - moduleId - userId - value BodyPowerResultsDRF: type: object properties: BodyPower: type: array items: $ref: '#/components/schemas/BodyPowerDTODRF' BodyStressDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double minValue: type: integer maxValue: type: integer medianValue: type: number format: double rawDataObject: $ref: '#/components/schemas/S3ObjectDRF' required: - deploymentId - deviceName - moduleId - userId - value BodyStressResultsDRF: type: object properties: BodyStress: type: array items: $ref: '#/components/schemas/BodyStressDTODRF' BreastFeedingBabyStatusDetailsItemDRF: type: object properties: ageInMonths: type: integer hasOnlyBreastMilk: type: boolean weightAtBirth: type: number format: double hasBirthDefects: type: boolean babyBirthDefectList: type: array items: type: string hasChronicConditions: type: boolean chronicConditionList: type: array items: type: string hasMedications: type: boolean isMedicationByDoctor: type: boolean conditionList: type: array items: type: string required: - ageInMonths - hasBirthDefects - hasChronicConditions - hasMedications - weightAtBirth BreastFeedingStatusDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string isBreastFeedingCurrently: type: boolean numberOfWeeksAtChildBirth: type: integer hadComplicationsAtBirth: type: boolean complicationList: type: array items: type: string hasHighRiskConditions: type: boolean highRiskConditions: type: array items: type: string familyHistoryOfDefects: type: string familyHistoryOfDefectsList: type: array items: type: string numBreastFeedingBabies: type: integer breastFeedingBabyDetails: type: array items: $ref: '#/components/schemas/BreastFeedingBabyStatusDetailsItemDRF' metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - deploymentId - deviceName - isBreastFeedingCurrently - metadata - moduleId - userId BreastFeedingStatusResultsDRF: type: object properties: BreastFeedingStatus: type: array items: $ref: '#/components/schemas/BreastFeedingStatusDTODRF' BreastFeedingUpdateBabyDetailsDRF: type: object properties: healthIssue: type: array items: type: string healthIssueAction: type: array items: type: string hasReceivedDiagnosis: type: boolean diagnosisList: type: array items: type: string required: - hasReceivedDiagnosis - healthIssue - healthIssueAction BreastFeedingUpdateDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string isBreastFeedingNow: type: boolean stopDate: type: string format: date-time newOrWorseSymptoms: type: array items: type: string numBreastFeedingBabies: type: integer breastFeedingBabyDetails: type: array items: $ref: '#/components/schemas/BreastFeedingUpdateBabyDetailsDRF' metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - deploymentId - deviceName - isBreastFeedingNow - metadata - moduleId - newOrWorseSymptoms - userId BreastFeedingUpdateResultsDRF: type: object properties: BreastFeedingUpdate: type: array items: $ref: '#/components/schemas/BreastFeedingUpdateDTODRF' BreathingResultsDRF: type: object properties: SensorCapture: type: array items: $ref: '#/components/schemas/SensorCaptureDTODRF' BreathlessnessResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' BucketDRF: type: object properties: name: type: string rule: type: array items: $ref: '#/components/schemas/RuleConditionDRF' required: - name - rule BuilderDRF: type: object properties: tabs: type: array items: $ref: '#/components/schemas/UITabDRF' BulkDeleteAppointmentsResponseObjectDRF: type: object properties: deletedAppointments: type: integer required: - deletedAppointments CATDRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer required: - deploymentId - deviceName - moduleId - userId - value CATResultsDRF: type: object properties: CAT: type: array items: $ref: '#/components/schemas/CATDRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' CDSDataResponseObjectDRF: type: object properties: pregnancyDate: type: string state: type: string stage: type: string title: type: string subtitle: type: string description: type: string primaryCTAtext: type: string secondaryCTAtext: type: string progress: type: number format: double progressText: type: string message: $ref: '#/components/schemas/_CDSCardMessageDRF' imageUrl: type: string dueDate: type: string CMSContentDTODRF: type: object properties: id: type: string status: type: string data: type: object additionalProperties: {} draftData: type: object additionalProperties: {} schema: type: string tags: type: array items: type: string resources: type: array items: type: string owner: type: string editors: type: array items: type: string viewers: type: array items: type: string version: type: integer updateDateTime: type: string format: date-time publishDateTime: type: string format: date-time createDateTime: type: string format: date-time required: - resources - schema - status CMSLearnArticleContentDRF: type: object properties: id: type: string cmsArticleId: type: string cmsThumbnail: type: string type: type: string timeToRead: type: integer textDetails: type: string videoUrl: type: string url: type: string contentObject: $ref: '#/components/schemas/S3ObjectDRF' read: type: boolean isValid: type: boolean LocalizableFields: type: array items: type: string title: ' localizablefields' body: type: string contentType: type: string CMSLearnArticleDRF: type: object properties: id: type: string title: type: string type: type: string thumbnailUrl: $ref: '#/components/schemas/S3ObjectDRF' order: type: integer content: $ref: '#/components/schemas/CMSLearnArticleContentDRF' updateDateTime: type: string format: date-time createDateTime: type: string format: date-time LocalizableFields: type: array items: type: string title: ' localizablefields' tags: type: array items: type: string thumbnailImageUrl: type: string required: - content - type CMSLearnArticleResponseDRF: type: object properties: id: type: string title: type: string type: type: string thumbnailUrl: $ref: '#/components/schemas/S3ObjectDRF' order: type: integer content: $ref: '#/components/schemas/CMSLearnArticleContentDRF' updateDateTime: type: string format: date-time createDateTime: type: string format: date-time LocalizableFields: type: array items: type: string title: ' localizablefields' tags: type: array items: type: string thumbnailImageUrl: type: string required: - content - type CMSRecommendationDTODRF: type: object properties: id: type: string title: type: string content: type: string reviewer: type: string language: type: string photo: type: string required: - content - language - title CPTProfileEntryDRF: type: object properties: id: type: string mongoId: type: string userId: type: string givenName: type: string familyName: type: string clinicName: type: string clientId: type: string diagnosisType: type: string provider: type: string monitoringMinutes: type: integer numberOfCalls: type: integer monthReading: type: integer deploymentId: type: string reportEndDate: type: string cptCodes: type: string dateOfBirth: type: string mrn: type: string isSubmitted: type: boolean CPTReportResponseObjectDRF: type: object properties: status: type: string earliestBillingDate: type: string format: date-time startDate: type: string format: date-time endDate: type: string format: date-time daysHaveSubmission: type: integer timeSpent: type: number format: double cptCodeIteration: type: string cptCode: type: string order: type: integer required: - cptCode - order - status CVDRiskScoreDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string age: type: number format: double sex: type: string alcoholIntake: type: string sleepDuration: type: number format: double smokingStatus: type: boolean walkingPace: type: string overallHealth: type: string existingConditions: type: array items: type: string existingSymptoms: type: array items: type: string currentMedications: type: array items: type: string familyHeartDisease: type: array items: type: string heartRate: type: number format: double waistCircumference: type: number format: double hipCircumference: type: number format: double waistToHipRatio: type: number format: double riskFactors: type: array items: $ref: '#/components/schemas/RiskFactorDRF' riskTrajectory: type: array items: $ref: '#/components/schemas/RiskTrajectoryDRF' originalValue: type: number format: double roundedValue: type: number format: double required: - age - alcoholIntake - currentMedications - deploymentId - deviceName - existingConditions - existingSymptoms - familyHeartDisease - heartRate - hipCircumference - moduleId - overallHealth - sex - sleepDuration - smokingStatus - userId - waistCircumference - walkingPace CVDRiskScoreResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' CVDRiskScore: type: array items: $ref: '#/components/schemas/CVDRiskScoreDTODRF' HeartRate: type: array items: $ref: '#/components/schemas/HeartRateDTODRF' BodyMeasurement: type: array items: $ref: '#/components/schemas/BodyMeasurementDTODRF' CalculateCumulativeMonitoringTimeResponseObjectDRF: type: object properties: monitoringTimeSeconds: type: number format: double userId: type: string cptCode: type: string cptCodeIteration: type: integer status: type: string required: - cptCode - cptCodeIteration - monitoringTimeSeconds - status - userId CalendarEventDTODRF: type: object properties: id: type: string userId: type: string title: type: string description: type: string model: type: string isRecurring: type: boolean instanceExpiresIn: type: string startDateTime: type: string endDateTime: type: string enabled: type: boolean extraFields: type: object additionalProperties: {} parentId: type: string snoozing: type: array items: type: string hasCustomSchedule: type: boolean isSilent: type: boolean updateDateTime: type: string createDateTime: type: string completeDateTime: type: string required: - model CancerTypeItemDRF: type: object properties: name: type: string isTakingMedication: type: boolean metastatic: type: string required: - isTakingMedication - metastatic - name CaptureChangeDRF: type: object properties: old: type: string new: type: string required: - new - old CarePlanResponseObjectDRF: type: object properties: id: type: string userId: type: string name: type: string type: type: string description: type: string startDate: type: string format: date-time endDate: type: string format: date-time updateDateTime: type: string format: date-time createDateTime: type: string format: date-time required: - name - startDate - type - userId ChargeUnitRecordRequestObjectDRF: type: object properties: code: type: string units: type: integer dateOfService: type: string format: date-time extraDetails: type: string dependentUnitId: type: string required: - code - units CheckAuthAttributesRequestObjectDRF: type: object properties: authToken: type: string tokenType: type: string email: type: string phoneNumber: type: string clientId: type: string projectId: type: string required: - clientId - projectId CheckAuthAttributesResponseObjectDRF: type: object properties: phoneNumber: type: string email: type: string passwordSet: type: boolean emailVerified: type: boolean phoneNumberVerified: type: boolean eligibleForMFA: type: boolean mfaEnabled: type: boolean shortenedCode: type: string contactEmail: type: string ssoEnabled: type: boolean CheckExportDeploymentTaskStatusResponseObjectDRF: type: object properties: status: type: string exportData: $ref: '#/components/schemas/ExportResultObjectDRF' CheckPhoneNumberTypeResponseObjectDRF: type: object properties: numberType: type: string ChecklistDRF: type: object properties: title: type: string subtitle: type: string checklist: type: array items: $ref: '#/components/schemas/CalendarEventDTODRF' isActive: type: boolean ChildrenItemDRF: type: object properties: issues: type: array items: type: string additionalInfo: type: string hasChildDevelopIssues: type: boolean required: - hasChildDevelopIssues ClearUserProfileDataRequestDataDRF: type: object properties: fieldsToRemove: type: array items: type: string required: - fieldsToRemove ClientDTODRF: type: object properties: id: type: string name: type: string paymentFormula: type: object additionalProperties: {} ClientInvoiceDetailRowObjectDRF: type: object properties: invoiceId: type: string clientId: type: string clientName: type: string invoiceEndDate: type: string userId: type: string givenName: type: string familyName: type: string dateOfBirth: type: string mrn: type: string serviceDescription: type: string units: type: integer rates: type: integer total: type: integer ClientInvoiceDetailsRequestObjectDRF: type: object properties: skip: type: integer limit: type: integer yearMonth: type: string clientId: type: string search: type: string required: - yearMonth ClientMedicalRecordResponseObjectDRF: type: object properties: patients: type: array items: $ref: '#/components/schemas/MedicalRecordEntryDRF' ClinicianOnlyFieldsDRF: type: object properties: surgeryDateTime: type: boolean CloneDeploymentRequestObjectDRF: type: object properties: name: type: string referenceId: type: string organizationId: type: string isSaMD: type: boolean required: - name - organizationId - referenceId CloneOrganizationRequestBodyDRF: type: object properties: name: type: string referenceId: type: string deploymentIds: type: array items: type: string required: - deploymentIds - name - referenceId CloneOrganizationResponseObjectDRF: type: object properties: id: type: string deploymentIds: type: array items: type: string CodingDRF: type: object properties: code: type: string display: type: string system: type: string required: - code - display - system CompleteVideoCallByUserRequestObjectDRF: type: object properties: reason: type: string userId: type: string videoCallId: type: string required: - userId - videoCallId CompleteVideoCallRequestObjectDRF: type: object properties: token: type: string callId: type: string required: - callId - token ComplexSymptomValueDRF: type: object properties: name: type: string severity: type: integer value: type: string followUpQuestionIds: type: array items: type: string required: - name ComponentConfigRequestBodyDRF: type: object properties: componentName: type: string config: $ref: '#/components/schemas/BasePhoenixDynamicConfigDRF' required: - componentName ComponentUIDRF: type: object properties: title: type: string icon: type: string banner: type: string author: type: string descriptionLink: type: string required: - author - banner - descriptionLink - icon - title ConditionFlowRequestObjectDRF: type: object properties: action: type: string conditionCodeName: type: string responseId: type: string questionId: type: string answers: type: array items: type: string required: - action ConditionFlowResponseObjectDRF: type: object properties: responseId: type: string question: $ref: '#/components/schemas/QuestionResponseObjectDRF' submitResults: type: array items: $ref: '#/components/schemas/CreateModuleResultResponseObjectDRF' allQuestionsCompleted: type: boolean flowCompleted: type: boolean currentProgress: type: integer totalQuestionnaires: type: integer required: - responseId ConfigUIDRF: type: object properties: title: type: string name: type: string type: type: string value: type: string isRequired: type: boolean required: - name - title - type ConfigurationRoleDRF: type: object properties: id: type: string name: type: string permissions: type: array items: type: string userType: type: string isThirdParty: type: boolean resourceId: type: string resourceType: type: string ConfirmExportBadgesRequestDataDRF: type: object properties: exportProcessIds: type: array items: type: string required: - exportProcessIds ConfirmExportBadgesResponseObjectDRF: type: object properties: updated: type: integer required: - updated ConfirmMessageRequestObjectDRF: type: object properties: messageIds: type: array items: type: string required: - messageIds ConfirmMessageResponseObjectDRF: type: object properties: updated: type: integer required: - updated ConfirmationOutDRF: type: object properties: ok: type: boolean authToken: type: string refreshToken: type: string expiresIn: type: integer uid: type: string authTokenExpiresIn: type: integer ConfirmationRequestObjectDRF: type: object properties: email: type: string phoneNumber: type: string confirmationCode: type: string clientId: type: string projectId: type: string deviceAgent: type: string required: - clientId - confirmationCode - email - projectId ConnectFitbitRequestDataDRF: type: object properties: code: type: string required: - code ConsentConfigObjectDRF: type: object properties: consent: $ref: '#/components/schemas/ConsentDRF' eulaUrl: type: string privacyPolicyUrl: type: string termAndConditionUrl: type: string onboardingConfigs: type: array items: $ref: '#/components/schemas/OnboardingModuleConfigDTODRF' ConsentDRF: type: object properties: id: type: string enabled: type: string review: $ref: '#/components/schemas/ConsentReviewDRF' revision: type: integer additionalConsentQuestions: type: array items: $ref: '#/components/schemas/AdditionalConsentQuestionDRF' signature: $ref: '#/components/schemas/ConsentSignatureDRF' sections: type: array items: $ref: '#/components/schemas/ConsentSectionDRF' instituteName: type: string instituteFullName: type: string instituteTextDetails: type: string admissionText: type: string createDateTime: type: string format: date-time LocalizableFields: type: array items: type: string title: ' localizablefields' required: - enabled ConsentResponseObjectDRF: type: object properties: id: type: string enabled: type: string review: $ref: '#/components/schemas/ConsentReviewDRF' revision: type: integer additionalConsentQuestions: type: array items: $ref: '#/components/schemas/AdditionalConsentQuestionDRF' signature: $ref: '#/components/schemas/ConsentSignatureDRF' sections: type: array items: $ref: '#/components/schemas/ConsentSectionDRF' instituteName: type: string instituteFullName: type: string instituteTextDetails: type: string admissionText: type: string createDateTime: type: string format: date-time LocalizableFields: type: array items: type: string title: ' localizablefields' required: - enabled ConsentReviewDRF: type: object properties: title: type: string details: type: string LocalizableFields: type: array items: type: string title: ' localizablefields' required: - details - title ConsentSectionDRF: type: object properties: type: type: string title: type: string details: type: string reviewDetails: type: string options: type: array items: $ref: '#/components/schemas/ConsentSectionOptionsDRF' LocalizableFields: type: array items: type: string title: ' localizablefields' required: - type ConsentSectionOptionsDRF: type: object properties: type: type: integer text: type: string order: type: integer abortOnChoose: type: boolean LocalizableFields: type: array items: type: string title: ' localizablefields' required: - text - type ConsentSignatureDRF: type: object properties: signatureTitle: type: string signatureDetails: type: string nameTitle: type: string nameDetails: type: string hasMiddleName: type: boolean showFirstLastName: type: boolean LocalizableFields: type: array items: type: string title: ' localizablefields' required: - nameDetails - nameTitle - signatureDetails - signatureTitle Covid19DailyCheckInDRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string contactType: type: string required: - contactType - deploymentId - deviceName - moduleId - userId Covid19DailyCheckInResultsDRF: type: object properties: Covid19DailyCheckIn: type: array items: $ref: '#/components/schemas/Covid19DailyCheckInDRF' Covid19RiskScoreCoreQuestionsDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string bloodType: type: string preExistingConditions: type: array items: type: string currentSymptoms: type: array items: type: string score: type: number format: double status: type: string required: - bloodType - currentSymptoms - deploymentId - deviceName - moduleId - preExistingConditions - userId Covid19RiskScoreDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double status: type: string required: - deploymentId - deviceName - moduleId - userId Covid19RiskScoreResultsDRF: type: object properties: Covid19RiskScoreCoreQuestions: type: array items: $ref: '#/components/schemas/Covid19RiskScoreCoreQuestionsDTODRF' Weight: type: array items: $ref: '#/components/schemas/WeightDTODRF' SmokeQuestions: type: array items: $ref: '#/components/schemas/SmokeQuestionsDTODRF' Temperature: type: array items: $ref: '#/components/schemas/TemperatureDTODRF' HeartRate: type: array items: $ref: '#/components/schemas/HeartRateDTODRF' RestingBreathingRate: type: array items: $ref: '#/components/schemas/RestingBreathingRateDTODRF' OxygenSaturation: type: array items: $ref: '#/components/schemas/OxygenSaturationDTODRF' Covid19RiskScore: type: array items: $ref: '#/components/schemas/Covid19RiskScoreDTODRF' CovidSymptomsItemDRF: type: object properties: name: type: string intensity: type: integer persistPostInfection: type: string required: - intensity - name - persistPostInfection CovidTestListItemDRF: type: object properties: method: type: string date_: type: string format: date-time title: 'Date ' otherMethodName: type: string result: type: string required: - method - result CptChargeUnitObjectDRF: type: object properties: billingRecordId: type: string id: type: string code: type: string units: type: integer dateOfService: type: string extraDetails: type: object additionalProperties: {} CreateAirQualityIndexDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer latitude: type: number format: double longitude: type: number format: double required: - deploymentId - deviceName - latitude - longitude - moduleId - type - userId - value CreateArmFatigueDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string arm: type: string angle: type: number format: double classification: type: string output: $ref: '#/components/schemas/S3ObjectDRF' recording: $ref: '#/components/schemas/S3ObjectDRF' time: type: number format: double required: - arm - deploymentId - deviceName - moduleId - recording - type - userId CreateArticleRatingRequestObjectDRF: type: object properties: deployment: $ref: '#/components/schemas/DeploymentDTODRF' articleRating: $ref: '#/components/schemas/ArticleRatingDTODRF' required: - articleRating CreateBillingRequestBodyDRF: type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time CreateBloodGlucoseDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double valueUnit: type: string originalValue: type: number format: double originalUnit: type: string required: - deploymentId - deviceName - moduleId - type - userId - value CreateBloodPressureDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string diastolicValue: type: integer systolicValue: type: integer diastolicValueUnit: type: string systolicValueUnit: type: string takenMedications: type: array items: type: string required: - deploymentId - deviceName - diastolicValue - moduleId - systolicValue - type - userId CreateBodyMeasurementDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string visceralFat: type: number format: double totalBodyFat: type: number format: double waistCircumference: type: number format: double waistCircumferenceUnit: type: string hipCircumference: type: number format: double hipCircumferenceUnit: type: string waistToHipRatio: type: number format: double required: - deploymentId - deviceName - moduleId - type - userId CreateBodyPowerDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double minValue: type: integer maxValue: type: integer medianValue: type: number format: double rawDataObject: $ref: '#/components/schemas/S3ObjectDRF' required: - deploymentId - deviceName - moduleId - type - userId - value CreateBodyStressDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double minValue: type: integer maxValue: type: integer medianValue: type: number format: double rawDataObject: $ref: '#/components/schemas/S3ObjectDRF' required: - deploymentId - deviceName - moduleId - type - userId - value CreateConsentRequestObjectDRF: type: object properties: id: type: string enabled: type: string review: $ref: '#/components/schemas/ConsentReviewDRF' revision: type: integer additionalConsentQuestions: type: array items: $ref: '#/components/schemas/AdditionalConsentQuestionDRF' signature: $ref: '#/components/schemas/ConsentSignatureDRF' sections: type: array items: $ref: '#/components/schemas/ConsentSectionDRF' instituteName: type: string instituteFullName: type: string instituteTextDetails: type: string admissionText: type: string createDateTime: type: string format: date-time LocalizableFields: type: array items: type: string title: ' localizablefields' required: - enabled CreateContentRequestObjectDRF: type: object properties: id: type: string status: type: string data: type: object additionalProperties: {} draftData: type: object additionalProperties: {} schema: type: string tags: type: array items: type: string resources: type: array items: type: string owner: type: string editors: type: array items: type: string viewers: type: array items: type: string version: type: integer updateDateTime: type: string format: date-time publishDateTime: type: string format: date-time createDateTime: type: string format: date-time required: - resources - schema - status CreateContentResponseObjectDRF: type: object properties: id: type: string required: - id CreateDeploymentRequestObjectDRF: type: object properties: termAndConditionUrl: type: string privacyPolicyUrl: type: string eulaUrl: type: string privacyPolicyObject: $ref: '#/components/schemas/S3ObjectDRF' termAndConditionObject: $ref: '#/components/schemas/S3ObjectDRF' eulaObject: $ref: '#/components/schemas/S3ObjectDRF' authorisedRep: $ref: '#/components/schemas/AuthorisedRepDRF' roles: type: array items: $ref: '#/components/schemas/RoleDTODRF' sso: $ref: '#/components/schemas/SsoDRF' id: type: string draftId: type: string name: type: string description: type: string status: type: string color: type: string icon: $ref: '#/components/schemas/S3ObjectDRF' iconFileId: type: string templateThumbnailFileId: type: string descriptionUrl: type: string isSaMD: type: boolean updateDateTime: type: string format: date-time createDateTime: type: string format: date-time moduleConfigs: type: array items: $ref: '#/components/schemas/ModuleConfigDRF' onboardingConfigs: type: array items: $ref: '#/components/schemas/OnboardingModuleConfigDTODRF' learn: $ref: '#/components/schemas/LearnDRF' consent: $ref: '#/components/schemas/ConsentDRF' econsent: $ref: '#/components/schemas/EConsentDRF' keyActions: type: array items: $ref: '#/components/schemas/KeyActionConfigDRF' keyActionsEnabled: type: boolean profile: $ref: '#/components/schemas/ProfileDRF' features: $ref: '#/components/schemas/FeaturesDRF' extraCustomFields: type: object additionalProperties: {} surgeryDetails: $ref: '#/components/schemas/SurgeryDetailsDRF' contactUsURL: type: string version: type: integer integration: $ref: '#/components/schemas/IntegrationConfigDRF' language: type: string duration: type: string security: $ref: '#/components/schemas/SecurityDRF' mfaRequired: type: boolean code: type: string enrollmentCounter: type: integer staticEventConfig: $ref: '#/components/schemas/StaticEventConfigDRF' stats: $ref: '#/components/schemas/DeploymentStatsDRF' localizations: type: object additionalProperties: {} country: type: string dashboardConfiguration: $ref: '#/components/schemas/DeploymentLevelConfigurationDRF' labels: type: array items: $ref: '#/components/schemas/LabelDRF' tags: type: array items: type: string location: $ref: '#/components/schemas/LocationDRF' integrationDevices: type: array items: $ref: '#/components/schemas/IntegrationDeviceDRF' componentConfigs: type: object additionalProperties: {} defaultUnits: type: object additionalProperties: {} builder: $ref: '#/components/schemas/BuilderDRF' programId: type: integer LocalizableFields: type: array items: type: string title: ' localizablefields' CreateDysarthriaDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string countingRecordingID: type: string initialProbability: type: number format: double fatiguedProbability: type: number format: double probability: type: number format: double confidence: type: string buttercupInitialRecordingID: type: string buttercupFatiguedRecordingID: type: string required: - buttercupFatiguedRecordingID - buttercupInitialRecordingID - countingRecordingID - deploymentId - deviceName - moduleId - type - userId CreateDysphoniaDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string countingRecordingID: type: string initialProbability: type: number format: double fatiguedProbability: type: number format: double probability: type: number format: double confidence: type: string aaahhhInitialRecordingID: type: string aaahhhFatiguedRecordingID: type: string required: - aaahhhFatiguedRecordingID - aaahhhInitialRecordingID - countingRecordingID - deploymentId - deviceName - moduleId - type - userId CreateECGDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string averageHeartRate: type: integer classification: type: string leadType: type: string pdf: $ref: '#/components/schemas/S3ObjectDRF' dataPoints: $ref: '#/components/schemas/FlatBufferS3ObjectDRF' required: - averageHeartRate - classification - deploymentId - deviceName - leadType - moduleId - type - userId CreateEConsentRequestBodyDRF: type: object properties: enabled: type: string review: $ref: '#/components/schemas/ConsentReviewDRF' revision: type: integer additionalConsentQuestions: type: array items: $ref: '#/components/schemas/AdditionalConsentQuestionDRF' signature: $ref: '#/components/schemas/ConsentSignatureDRF' sections: type: array items: $ref: '#/components/schemas/EConsentSectionDRF' instituteName: type: string instituteFullName: type: string instituteTextDetails: type: string admissionText: type: string LocalizableFields: type: array items: type: string title: ' localizablefields' title: type: string overviewText: type: string contactText: type: string state: type: string reason: type: string deploymentIds: type: array items: type: string required: - contactText - deploymentIds - enabled - overviewText - sections - title CreateEConsentRequestObjectDRF: type: object properties: id: type: string enabled: type: string review: $ref: '#/components/schemas/ConsentReviewDRF' revision: type: integer additionalConsentQuestions: type: array items: $ref: '#/components/schemas/AdditionalConsentQuestionDRF' signature: $ref: '#/components/schemas/ConsentSignatureDRF' sections: type: array items: $ref: '#/components/schemas/EConsentSectionDRF' instituteName: type: string instituteFullName: type: string instituteTextDetails: type: string admissionText: type: string createDateTime: type: string format: date-time LocalizableFields: type: array items: type: string title: ' localizablefields' title: type: string overviewText: type: string contactText: type: string required: - contactText - enabled - overviewText - sections - title CreateEConsentResponseObjectDRF: type: object properties: id: type: string econsentId: type: string CreateExportProfileRequestObjectDRF: type: object properties: name: type: string content: $ref: '#/components/schemas/ExportParametersDRF' deploymentId: type: string organizationId: type: string default: type: boolean CreateFitbitHRVDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string rmssd: type: number format: double coverage: type: number format: double hf: type: number format: double lf: type: number format: double required: - deploymentId - deviceName - moduleId - type - userId CreateFullDeploymentLearnSectionRequestObjectDRF: type: object properties: id: type: string title: type: string order: type: integer articles: type: array items: $ref: '#/components/schemas/CreateLearnArticleRequestObjectDRF' updateDateTime: type: string format: date-time createDateTime: type: string format: date-time LocalizableFields: type: array items: type: string title: ' localizablefields' CreateFullDeploymentRequestObjectDRF: type: object properties: termAndConditionUrl: type: string privacyPolicyUrl: type: string eulaUrl: type: string privacyPolicyObject: $ref: '#/components/schemas/S3ObjectDRF' termAndConditionObject: $ref: '#/components/schemas/S3ObjectDRF' eulaObject: $ref: '#/components/schemas/S3ObjectDRF' authorisedRep: $ref: '#/components/schemas/AuthorisedRepDRF' roles: type: array items: $ref: '#/components/schemas/RoleDTODRF' sso: $ref: '#/components/schemas/SsoDRF' id: type: string draftId: type: string name: type: string description: type: string status: type: string color: type: string icon: $ref: '#/components/schemas/S3ObjectDRF' iconFileId: type: string templateThumbnailFileId: type: string descriptionUrl: type: string isSaMD: type: boolean updateDateTime: type: string format: date-time createDateTime: type: string format: date-time moduleConfigs: type: array items: $ref: '#/components/schemas/CreateModuleConfigRequestObjectDRF' onboardingConfigs: type: array items: $ref: '#/components/schemas/CreateFullOnboardingConfigRequestObjectDRF' learn: $ref: '#/components/schemas/FullDeploymentLearnDRF' consent: $ref: '#/components/schemas/CreateConsentRequestObjectDRF' econsent: $ref: '#/components/schemas/CreateEConsentRequestObjectDRF' keyActions: type: array items: $ref: '#/components/schemas/CreateFullKeyActionConfigRequestObjectDRF' keyActionsEnabled: type: boolean profile: $ref: '#/components/schemas/ProfileDRF' features: $ref: '#/components/schemas/FeaturesDRF' extraCustomFields: type: object additionalProperties: {} surgeryDetails: $ref: '#/components/schemas/SurgeryDetailsDRF' contactUsURL: type: string version: type: integer integration: $ref: '#/components/schemas/IntegrationConfigDRF' language: type: string duration: type: string security: $ref: '#/components/schemas/SecurityDRF' mfaRequired: type: boolean code: type: string enrollmentCounter: type: integer staticEventConfig: $ref: '#/components/schemas/StaticEventConfigDRF' stats: $ref: '#/components/schemas/DeploymentStatsDRF' localizations: type: object additionalProperties: {} country: type: string dashboardConfiguration: $ref: '#/components/schemas/DeploymentLevelConfigurationDRF' labels: type: array items: $ref: '#/components/schemas/LabelDRF' tags: type: array items: type: string location: $ref: '#/components/schemas/LocationDRF' integrationDevices: type: array items: $ref: '#/components/schemas/IntegrationDeviceDRF' componentConfigs: type: object additionalProperties: {} defaultUnits: type: object additionalProperties: {} builder: $ref: '#/components/schemas/BuilderDRF' programId: type: integer LocalizableFields: type: array items: type: string title: ' localizablefields' CreateFullKeyActionConfigRequestObjectDRF: type: object properties: id: type: string title: type: string description: type: string deltaFromTriggerTime: type: string durationFromTrigger: type: string durationIso: type: string instanceExpiresIn: type: string type: type: string trigger: type: string notifyEvery: type: string numberOfNotifications: type: integer learnArticleId: type: string learnArticle: type: object additionalProperties: {} moduleId: type: string moduleConfigId: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time LocalizableFields: type: array items: type: string title: ' localizablefields' required: - deltaFromTriggerTime - durationIso - trigger - type CreateFullOnboardingConfigRequestObjectDRF: type: object properties: id: type: string onboardingId: type: string preloadNeeded: type: boolean status: type: string configBody: type: object additionalProperties: {} order: type: integer version: type: integer versionString: type: string userTypes: type: array items: type: string organizationId: type: string reason: type: string deploymentIds: type: array items: type: string versionInt: type: object additionalProperties: {} updateDateTime: type: string format: date-time createDateTime: type: string format: date-time required: - onboardingId - order CreateGeolocationDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string latitude: type: string format: decimal pattern: ^-?\d{0,15}(?:\.\d{0,4})?$ longitude: type: string format: decimal pattern: ^-?\d{0,15}(?:\.\d{0,4})?$ altitude: type: string format: decimal pattern: ^-?\d{0,15}(?:\.\d{0,4})?$ accuracy: type: number format: double altitudeAccuracy: type: number format: double heading: type: number format: double speed: type: number format: double required: - deploymentId - deviceName - latitude - longitude - moduleId - type - userId CreateHRVDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double minValue: type: integer maxValue: type: integer medianValue: type: number format: double rawDataObject: $ref: '#/components/schemas/S3ObjectDRF' required: - deploymentId - deviceName - moduleId - type - userId - value CreateHeartRateDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer heartRateType: type: string classification: type: string variabilityAVNN: type: integer variabilitySDNN: type: integer variabilityRMSSD: type: integer variabilityPNN50: type: number format: double variabilityprcLF: type: number format: double confidence: type: integer goodIBI: type: integer rawDataObject: $ref: '#/components/schemas/S3ObjectDRF' valueUnit: type: string metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - deploymentId - deviceName - moduleId - type - userId - value CreateHelperAgreementLogRequestDataDRF: type: object properties: status: type: string required: - status CreateHemophiliaJournalDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string bodyLocation: type: string bodyPartInjury: type: string customBodyPart: type: string extraData: $ref: '#/components/schemas/HemophiliaJournalAnswersDRF' required: - bodyPartInjury - deploymentId - deviceName - moduleId - type - userId CreateHighFrequencyHeartRateDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer heartRateType: type: string classification: type: string variabilityAVNN: type: integer variabilitySDNN: type: integer variabilityRMSSD: type: integer variabilityPNN50: type: number format: double variabilityprcLF: type: number format: double confidence: type: integer goodIBI: type: integer rawDataObject: $ref: '#/components/schemas/S3ObjectDRF' valueUnit: type: string metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' multipleValues: type: array items: $ref: '#/components/schemas/MultipleValuesDataDRF' dataType: type: string required: - deploymentId - deviceName - moduleId - type - userId - value CreateIntegrationRequestObjectDRF: type: object properties: organizationIds: type: array items: type: string deploymentIds: type: array items: type: string moduleNames: type: array items: type: string excludedModuleNames: type: array items: type: string integrationType: type: string webhook: $ref: '#/components/schemas/WebhookDTODRF' kafka: $ref: '#/components/schemas/KafkaDRF' gcpFhir: $ref: '#/components/schemas/GCPFhirDTODRF' genericEhr: $ref: '#/components/schemas/GenericEHRDTODRF' name: type: string enabled: type: boolean required: - deploymentIds - integrationType - name - organizationIds CreateJournalDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: string required: - deploymentId - deviceName - moduleId - type - userId - value CreateKardiaPatientRequestBodyDRF: type: object properties: email: type: string dob: type: string required: - dob - email CreateKardiaPatientResponseDRF: type: object properties: id: type: string mrn: type: string dob: type: string email: type: string firstname: type: string lastname: type: string sex: type: integer password: type: string CreateKeyActionConfigRequestObjectDRF: type: object properties: id: type: string title: type: string description: type: string deltaFromTriggerTime: type: string durationFromTrigger: type: string durationIso: type: string instanceExpiresIn: type: string type: type: string trigger: type: string notifyEvery: type: string numberOfNotifications: type: integer learnArticleId: type: string learnArticle: type: object additionalProperties: {} moduleId: type: string moduleConfigId: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time LocalizableFields: type: array items: type: string title: ' localizablefields' required: - deltaFromTriggerTime - durationIso - trigger - type CreateKeyActionLogDTORequestBodyDRF: type: object properties: model: type: string userId: type: string startDateTime: type: string format: date-time endDateTime: type: string format: date-time completeDateTime: type: string format: date-time required: - endDateTime - model - startDateTime CreateLabelsRequestObjectBodyDRF: type: object properties: texts: type: array items: type: string required: - texts CreateLearnArticleRequestObjectDRF: type: object properties: id: type: string title: type: string type: type: string thumbnailUrl: $ref: '#/components/schemas/S3ObjectDRF' order: type: integer content: $ref: '#/components/schemas/LearnArticleContentDRF' updateDateTime: type: string format: date-time createDateTime: type: string format: date-time LocalizableFields: type: array items: type: string title: ' localizablefields' required: - content - type CreateLearnSectionRequestObjectDRF: type: object properties: id: type: string title: type: string order: type: integer articles: type: array items: $ref: '#/components/schemas/LearnArticleDRF' updateDateTime: type: string format: date-time createDateTime: type: string format: date-time LocalizableFields: type: array items: type: string title: ' localizablefields' CreateMedicationLogRequestObjectDRF: type: object properties: id: type: string userId: type: string deploymentId: type: string eventId: type: string medicationId: type: string logsCount: type: integer status: type: string medicatedDateTimeSlots: type: array items: type: string format: date-time startDateTime: type: string format: date-time updateDateTime: type: string format: date-time createDateTime: type: string format: date-time device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string medicationName: type: string dosage: type: number format: double unit: type: string customUnit: type: string meal: type: string userNote: type: string relatedPrimitiveData: $ref: '#/components/schemas/ShortPrimitiveDataDRF' deployment: $ref: '#/components/schemas/DeploymentDTODRF' user: $ref: '#/components/schemas/UserDTODRF' CreateMedicationRequestObjectDRF: type: object properties: prn: type: boolean enabled: type: boolean userId: type: string deploymentId: type: string moduleId: type: string name: type: string doseQuantity: type: number format: double doseUnits: type: string schedule: $ref: '#/components/schemas/MedicationScheduleDRF' extraProperties: type: object additionalProperties: {} updateDateTime: type: string format: date-time createDateTime: type: string format: date-time changeHistory: type: array items: $ref: '#/components/schemas/MedicationHistoryDRF' required: - name - userId CreateMedicationRequestObjectV2DRF: type: object properties: enabled: type: boolean userId: type: string deploymentId: type: string moduleId: type: string moduleConfigId: type: string name: type: string coding: type: array items: $ref: '#/components/schemas/CodingDRF' dosage: type: number format: double unit: type: string customUnit: type: string indication: $ref: '#/components/schemas/IndicationDRF' isNotificationEnabled: type: boolean maxDosage: type: number format: double schedule: $ref: '#/components/schemas/MedicationV2ScheduleDRF' submitterId: type: string submitterUserType: type: string startDate: type: string format: date-time endDate: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time additionalFields: $ref: '#/components/schemas/AdditionalFieldsDRF' mealSchedule: type: array items: $ref: '#/components/schemas/MedicationMealScheduleDRF' connectedModules: type: array items: type: string groupId: type: string user: $ref: '#/components/schemas/UserDTODRF' deployment: $ref: '#/components/schemas/DeploymentDTODRF' submitter: $ref: '#/components/schemas/UserDTODRF' moduleConfig: $ref: '#/components/schemas/ModuleConfigDRF' required: - moduleConfigId - name CreateModuleConfigRequestObjectDRF: type: object properties: id: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time moduleId: type: string moduleName: type: string shortModuleName: type: string status: type: string order: type: integer configBody: type: object additionalProperties: {} about: type: string footnote: $ref: '#/components/schemas/FootnoteDRF' schedule: $ref: '#/components/schemas/ModuleScheduleDRF' ragThresholds: type: array items: $ref: '#/components/schemas/RagThresholdDRF' learnArticleIds: type: array items: type: string version: type: integer staticEvent: $ref: '#/components/schemas/StaticEventDRF' notificationData: $ref: '#/components/schemas/NotificationDataDRF' localizationPrefix: type: string goal: $ref: '#/components/schemas/ModuleGoalDTODRF' goalEnabled: type: boolean feedback: $ref: '#/components/schemas/FeedbackConfigDRF' feedbackTexts: type: array items: $ref: '#/components/schemas/FeedbackTextsDRF' readOnly: type: boolean LocalizableFields: type: array items: type: string title: ' localizablefields' required: - moduleId CreateModuleRatingRequestObjectDRF: type: object properties: deployment: $ref: '#/components/schemas/DeploymentDTODRF' moduleRating: $ref: '#/components/schemas/ModuleRatingDTODRF' required: - moduleRating CreateModuleResultResponseObjectDRF: type: object properties: ids: type: array items: type: string moduleResultId: type: string errors: type: array items: type: string CreateMultipleModuleConfigsRequestObjectBodyDRF: type: object properties: moduleConfigs: type: array items: $ref: '#/components/schemas/CreateModuleConfigRequestObjectDRF' required: - moduleConfigs CreateOfflineCallRequestObjectDRF: type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time note: type: string required: - endDateTime - note - startDateTime CreateOrderRequestObjectDRF: type: object properties: userId: type: string cart: type: array items: $ref: '#/components/schemas/OrderItemDRF' required: - cart - userId CreateOrganizationDTORequestBodyDRF: type: object properties: termAndConditionUrl: type: string privacyPolicyUrl: type: string eulaUrl: type: string privacyPolicyObject: $ref: '#/components/schemas/S3ObjectDRF' termAndConditionObject: $ref: '#/components/schemas/S3ObjectDRF' eulaObject: $ref: '#/components/schemas/S3ObjectDRF' authorisedRep: $ref: '#/components/schemas/AuthorisedRepDRF' name: type: string status: type: string enrollmentTarget: type: integer studyCompletionTarget: type: integer viewType: type: string dashboardId: type: string features: $ref: '#/components/schemas/FeaturesDRF' intercom: $ref: '#/components/schemas/IntercomSettingsDRF' security: type: object additionalProperties: {} pluginConfigContainerId: type: string sso: $ref: '#/components/schemas/SsoDRF' required: - name CreateOxfordHipScoreDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string hipAffected: type: string hipsData: type: array items: $ref: '#/components/schemas/HipDataDRF' rightHipScore: type: integer leftHipScore: type: integer required: - deploymentId - deviceName - hipAffected - hipsData - moduleId - type - userId CreateOxfordKneeScoreDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string legAffected: type: string legsData: type: array items: $ref: '#/components/schemas/LegDataDRF' rightKneeScore: type: integer leftKneeScore: type: integer required: - deploymentId - deviceName - legAffected - legsData - moduleId - type - userId CreateOxfordShoulderScoreDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string shoulderAffected: type: string shouldersData: type: array items: $ref: '#/components/schemas/ShoulderDataDRF' rightShoulderScore: type: integer leftShoulderScore: type: integer required: - deploymentId - deviceName - moduleId - shoulderAffected - shouldersData - type - userId CreateOxygenSaturationDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double valueUnit: type: string originalValue: type: number format: double oxygenSupplement: $ref: '#/components/schemas/OxygenSupplementDRF' required: - deploymentId - deviceName - moduleId - type - userId - value CreatePatientProfileRequestObjectDRF: type: object properties: givenName: type: string familyName: type: string dateOfBirth: type: string format: date-time email: type: string gender: type: string phoneNumber: type: string deploymentId: type: string required: - dateOfBirth - deploymentId - familyName - givenName CreatePatientProfileResponseObjectDRF: type: object properties: userId: type: string ok: type: boolean required: - userId CreatePeakFlowDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer valuePercent: type: number format: double valueUnit: type: string required: - deploymentId - deviceName - moduleId - type - userId - value CreatePersonalDocumentRequestDataDRF: type: object properties: name: type: string fileType: type: string fileObject: $ref: '#/components/schemas/S3ObjectDRF' required: - fileObject - fileType - name CreatePersonalReminderRequestDataDRF: type: object properties: title: type: string description: type: string isRecurring: type: boolean instanceExpiresIn: type: string startDateTime: type: string endDateTime: type: string enabled: type: boolean extraFields: type: object additionalProperties: {} parentId: type: string snoozing: type: array items: type: string hasCustomSchedule: type: boolean isSilent: type: boolean completeDateTime: type: string durationIso: type: string specificWeekDays: type: array items: type: string specificMonthDays: type: array items: type: integer CreatePhotoDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string s3Object: $ref: '#/components/schemas/S3ObjectDRF' s3Thumbnail: $ref: '#/components/schemas/S3ObjectDRF' note: type: string required: - deploymentId - deviceName - moduleId - s3Object - type - userId CreatePrescriptionRequestObjectDRF: type: object properties: id: type: string userId: type: string carePlanId: type: string name: type: string dosage: type: string unit: type: string frequency: type: string startTime: type: string endTime: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time required: - carePlanId - dosage - frequency - name - startTime - unit CreatePtosisDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string recording: $ref: '#/components/schemas/S3ObjectDRF' severityLeft: type: integer severityRight: type: integer timeLeft: type: integer timeRight: type: integer isPrompted: type: boolean required: - deploymentId - deviceName - moduleId - recording - type - userId CreatePublicModuleItemRequestBodyDRF: type: object properties: primitives: type: array items: type: object additionalProperties: {} consentData: type: object additionalProperties: {} required: - primitives CreatePulseOximetryDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double required: - deploymentId - deviceName - moduleId - type - userId - value CreateQuestionnaireDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string answers: type: array items: $ref: '#/components/schemas/QuestionnaireAnswerDRF' appResult: $ref: '#/components/schemas/QuestionnaireAppResultDRF' isForManager: type: boolean questionnaireId: type: string questionnaireName: type: string value: type: number format: double skipped: type: array items: $ref: '#/components/schemas/QuestionnaireAnswerDRF' updateDateTime: type: string format: date-time signOffDateTime: type: string format: date-time status: type: string revision: type: integer required: - answers - deploymentId - deviceName - moduleId - questionnaireId - questionnaireName - type - userId CreateRespiratoryRateDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer valueUnit: type: string originalValue: type: number format: double required: - deploymentId - deviceName - moduleId - type - userId - value CreateServiceAccountRequestObjectDRF: type: object properties: serviceAccountName: type: string authType: type: string validationData: type: object additionalProperties: {} roleId: type: string resourceId: type: string timezone: type: string required: - resourceId - roleId - serviceAccountName - validationData CreateSleepDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/SleepFeedbackDRF' meal: type: string userNote: type: string awake: type: integer awakeCount: type: integer sleep: type: integer outOfBed: type: integer lightSleep: type: integer deepSleep: type: integer remSleep: type: integer duration: type: integer summary: type: array items: $ref: '#/components/schemas/SleepSummaryObjectDRF' dateOfSleep: type: string format: date-time uwake: type: integer score: type: integer required: - deploymentId - deviceName - duration - moduleId - type - userId - uwake CreateSpatialSpaniOSDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer required: - deploymentId - deviceName - moduleId - type - userId - value CreateSpirometryDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string pefr: type: number format: double fvc: type: number format: double fev1: type: number format: double fev1pp: type: integer fef2575: type: number format: double ev: type: number format: double height: type: integer sampleRate: type: number format: double forceData: $ref: '#/components/schemas/ForceDataDRF' zeroFlow: type: array items: type: integer rawData: type: array items: type: integer spirometryDevice: $ref: '#/components/schemas/DeviceInfoDRF' acceptability: $ref: '#/components/schemas/AcceptabilityDRF' technicalAcceptability: $ref: '#/components/schemas/TechnicalAcceptabilityDRF' environment: $ref: '#/components/schemas/EnvironmentDRF' location: $ref: '#/components/schemas/LocationDRF' isGood: type: boolean baseline: type: integer required: - deploymentId - deviceName - fev1pp - forceData - moduleId - rawData - sampleRate - spirometryDevice - type - userId - zeroFlow CreateStepDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer weeklyTotal: type: integer multipleValues: type: array items: $ref: '#/components/schemas/MultipleHourValuesDataDRF' rawDataObject: $ref: '#/components/schemas/FlatBufferS3ObjectDRF' dataType: type: string required: - deploymentId - deviceName - moduleId - type - userId - value CreateSymptomDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: array items: type: string complexValues: type: array items: $ref: '#/components/schemas/ComplexSymptomValueDRF' followUpQuestionIds: type: array items: type: string required: - deploymentId - deviceName - moduleId - type - userId CreateTabRequestObjectDRF: type: object properties: order: type: integer screenId: type: string name: type: string type: type: string description: type: string icon: type: string status: type: string background: $ref: '#/components/schemas/BackgroundDRF' extras: type: object additionalProperties: {} updateDateTime: type: string format: date-time createDateTime: type: string format: date-time required: - background - icon - name - order - status CreateTakenMedicationDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string medicationName: type: string required: - deploymentId - deviceName - moduleId - type - userId CreateTemperatureDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double valueUnit: type: string originalValue: type: number format: double originalUnit: type: string required: - deploymentId - deviceName - moduleId - type - userId - value CreateTemplateRequestObjectDRF: type: object properties: fileId: type: string thumbnailFileId: type: string title: type: string description: type: string descriptionUrl: type: string sortingIndex: type: integer test: type: boolean required: - fileId - sortingIndex CreateUserModuleReminderRequestDataDRF: type: object properties: title: type: string description: type: string isRecurring: type: boolean instanceExpiresIn: type: string startDateTime: type: string endDateTime: type: string enabled: type: boolean extraFields: type: object additionalProperties: {} parentId: type: string snoozing: type: array items: type: string hasCustomSchedule: type: boolean isSilent: type: boolean completeDateTime: type: string durationIso: type: string specificWeekDays: type: array items: type: string specificMonthDays: type: array items: type: integer moduleId: type: string moduleConfigId: type: string required: - moduleConfigId - moduleId CreateUserServiceAccountRequestObjectDRF: type: object properties: serviceAccountName: type: string authType: type: string validationData: type: object additionalProperties: {} roleId: type: string resourceId: type: string timezone: type: string singleResourceAccess: type: boolean required: - resourceId - roleId - serviceAccountName - validationData CreateVirtualCareDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string deploymentVersion: type: integer required: - deploymentId - deviceName - moduleId - type - userId CreateVirtualCareResponseObjectDRF: type: object properties: moduleResultId: type: string primitiveIds: type: array items: type: string errors: type: array items: type: string CreateWeightDRF: type: object properties: type: type: string id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double valueUnit: type: string originalValue: type: number format: double originalUnit: type: string required: - deploymentId - deviceName - moduleId - type - userId - value CreateWorkflowRequestObjectDRF: type: object properties: id: type: string name: type: string tasks: type: array items: $ref: '#/components/schemas/TaskDTODRF' resourceId: type: array items: type: string startNode: type: string schedule: type: string status: type: string createDateTime: type: string format: date-time updateDateTime: type: string format: date-time publishedWorkflowId: type: string isDraft: type: boolean required: - name - tasks CustomDeviceDetailsDRF: type: object properties: uuid: type: string serialNumber: type: string modelName: type: string manufacturer: type: string userIndex: type: integer required: - manufacturer - modelName - uuid DailyCheckInResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' DashScoreDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string quickDashQuestions: $ref: '#/components/schemas/QuickDashQuestionsDRF' workQuestions: $ref: '#/components/schemas/WorkQuestionsDRF' sportArtQuestions: $ref: '#/components/schemas/SportArtQuestionsDRF' doWork: type: boolean doSportArt: type: boolean workName: type: string sportArtName: type: string quickDashScore: type: integer workScore: type: integer sportArtScore: type: integer required: - deploymentId - deviceName - moduleId - quickDashQuestions - userId DashScoreResultsDRF: type: object properties: DashScore: type: array items: $ref: '#/components/schemas/DashScoreDTODRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' DashboardDRF: type: object properties: id: type: string title: type: string gadgets: type: array items: $ref: '#/components/schemas/GadgetLinkDRF' required: - gadgets - id - title DataPointDRF: type: object properties: values: type: array items: $ref: '#/components/schemas/DataValueDRF' legend: type: string ref: type: string required: - values DataValueDRF: type: object properties: axisId: type: string element: type: integer valueDate: type: string format: date-time valueInt: type: integer valueDouble: type: number format: double valueString: type: string required: - axisId DeleteBillingRecordResponseObjectDRF: type: object properties: deletedCount: type: integer totalDeleteCount: type: integer DeleteChargeResponseObjectDRF: type: object properties: deletedCount: type: integer DeleteInvitationsListResponseDRF: type: object properties: deletedInvitations: type: integer DeploymentConfigDRF: type: object properties: termAndConditionUrl: type: string privacyPolicyUrl: type: string eulaUrl: type: string privacyPolicyObject: $ref: '#/components/schemas/S3ObjectDRF' termAndConditionObject: $ref: '#/components/schemas/S3ObjectDRF' eulaObject: $ref: '#/components/schemas/S3ObjectDRF' authorisedRep: $ref: '#/components/schemas/AuthorisedRepDRF' roles: type: array items: $ref: '#/components/schemas/RoleDTODRF' sso: $ref: '#/components/schemas/SsoDRF' draftId: type: string name: type: string description: type: string status: type: string color: type: string icon: $ref: '#/components/schemas/S3ObjectDRF' iconFileId: type: string templateThumbnailFileId: type: string descriptionUrl: type: string isSaMD: type: boolean updateDateTime: type: string format: date-time createDateTime: type: string format: date-time moduleConfigs: type: array items: $ref: '#/components/schemas/ModuleConfigDRF' onboardingConfigs: type: array items: $ref: '#/components/schemas/OnboardingModuleConfigDTODRF' learn: $ref: '#/components/schemas/LearnDRF' consent: $ref: '#/components/schemas/ConsentDRF' econsent: $ref: '#/components/schemas/EConsentDRF' keyActions: type: array items: $ref: '#/components/schemas/KeyActionConfigDRF' keyActionsEnabled: type: boolean profile: $ref: '#/components/schemas/ProfileDRF' features: $ref: '#/components/schemas/FeaturesDRF' extraCustomFields: type: object additionalProperties: {} surgeryDetails: $ref: '#/components/schemas/SurgeryDetailsDRF' contactUsURL: type: string version: type: integer integration: $ref: '#/components/schemas/IntegrationConfigDRF' language: type: string duration: type: string security: $ref: '#/components/schemas/SecurityDRF' mfaRequired: type: boolean code: type: string enrollmentCounter: type: integer staticEventConfig: $ref: '#/components/schemas/StaticEventConfigDRF' stats: $ref: '#/components/schemas/DeploymentStatsDRF' country: type: string dashboardConfiguration: $ref: '#/components/schemas/DeploymentLevelConfigurationDRF' labels: type: array items: $ref: '#/components/schemas/LabelDRF' tags: type: array items: type: string location: $ref: '#/components/schemas/LocationDRF' integrationDevices: type: array items: $ref: '#/components/schemas/IntegrationDeviceDRF' componentConfigs: type: object additionalProperties: {} defaultUnits: type: object additionalProperties: {} builder: $ref: '#/components/schemas/BuilderDRF' programId: type: integer LocalizableFields: type: array items: type: string title: ' localizablefields' deploymentId: type: string instructionsForUseUrl: type: string eLabelTemplateUrl: type: string DeploymentContainsPatientInfoObjectDRF: type: object properties: id: type: string name: type: string status: type: string patients: type: array items: $ref: '#/components/schemas/PatientInfoObjectDRF' DeploymentContainsPatientInfoResponseObjectDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/DeploymentContainsPatientInfoObjectDRF' count: type: integer skip: type: integer limit: type: integer required: - items DeploymentDTODRF: type: object properties: termAndConditionUrl: type: string privacyPolicyUrl: type: string eulaUrl: type: string privacyPolicyObject: $ref: '#/components/schemas/S3ObjectDRF' termAndConditionObject: $ref: '#/components/schemas/S3ObjectDRF' eulaObject: $ref: '#/components/schemas/S3ObjectDRF' authorisedRep: $ref: '#/components/schemas/AuthorisedRepDRF' roles: type: array items: $ref: '#/components/schemas/RoleDTODRF' sso: $ref: '#/components/schemas/SsoDRF' id: type: string draftId: type: string name: type: string description: type: string status: type: string color: type: string icon: $ref: '#/components/schemas/S3ObjectDRF' iconFileId: type: string templateThumbnailFileId: type: string descriptionUrl: type: string isSaMD: type: boolean updateDateTime: type: string format: date-time createDateTime: type: string format: date-time moduleConfigs: type: array items: $ref: '#/components/schemas/ModuleConfigDRF' onboardingConfigs: type: array items: $ref: '#/components/schemas/OnboardingModuleConfigDTODRF' learn: $ref: '#/components/schemas/LearnDRF' consent: $ref: '#/components/schemas/ConsentDRF' econsent: $ref: '#/components/schemas/EConsentDRF' keyActions: type: array items: $ref: '#/components/schemas/KeyActionConfigDRF' keyActionsEnabled: type: boolean profile: $ref: '#/components/schemas/ProfileDRF' features: $ref: '#/components/schemas/FeaturesDRF' extraCustomFields: type: object additionalProperties: {} surgeryDetails: $ref: '#/components/schemas/SurgeryDetailsDRF' contactUsURL: type: string version: type: integer integration: $ref: '#/components/schemas/IntegrationConfigDRF' language: type: string duration: type: string security: $ref: '#/components/schemas/SecurityDRF' mfaRequired: type: boolean code: type: string enrollmentCounter: type: integer staticEventConfig: $ref: '#/components/schemas/StaticEventConfigDRF' stats: $ref: '#/components/schemas/DeploymentStatsDRF' localizations: type: object additionalProperties: {} country: type: string dashboardConfiguration: $ref: '#/components/schemas/DeploymentLevelConfigurationDRF' labels: type: array items: $ref: '#/components/schemas/LabelDRF' tags: type: array items: type: string location: $ref: '#/components/schemas/LocationDRF' integrationDevices: type: array items: $ref: '#/components/schemas/IntegrationDeviceDRF' componentConfigs: type: object additionalProperties: {} defaultUnits: type: object additionalProperties: {} builder: $ref: '#/components/schemas/BuilderDRF' programId: type: integer LocalizableFields: type: array items: type: string title: ' localizablefields' DeploymentEventDRF: type: object properties: title: type: string description: type: string enabled: type: boolean startDateTime: type: string endDateTime: type: string keyActionConfigId: type: string model: type: string moduleConfigId: type: string moduleId: type: string learnArticleId: type: string DeploymentInfoDRF: type: object properties: id: type: string name: type: string code: type: string draftId: type: string status: type: string required: - id - name DeploymentLevelConfigurationDRF: type: object properties: targetConsentedMonthly: type: integer targetConsented: type: integer day0Anchor: type: string targetCompleted: type: integer DeploymentResponseObjectDRF: type: object properties: termAndConditionUrl: type: string privacyPolicyUrl: type: string eulaUrl: type: string privacyPolicyObject: $ref: '#/components/schemas/S3ObjectDRF' termAndConditionObject: $ref: '#/components/schemas/S3ObjectDRF' eulaObject: $ref: '#/components/schemas/S3ObjectDRF' authorisedRep: $ref: '#/components/schemas/AuthorisedRepDRF' roles: type: array items: $ref: '#/components/schemas/RoleDTODRF' sso: $ref: '#/components/schemas/SsoDRF' id: type: string draftId: type: string name: type: string description: type: string status: type: string color: type: string icon: $ref: '#/components/schemas/S3ObjectDRF' iconFileId: type: string templateThumbnailFileId: type: string descriptionUrl: type: string isSaMD: type: boolean updateDateTime: type: string format: date-time createDateTime: type: string format: date-time moduleConfigs: type: array items: $ref: '#/components/schemas/ModuleConfigDRF' onboardingConfigs: type: array items: $ref: '#/components/schemas/OnboardingModuleConfigDTODRF' learn: $ref: '#/components/schemas/LearnDRF' consent: $ref: '#/components/schemas/ConsentDRF' econsent: $ref: '#/components/schemas/EConsentDRF' keyActions: type: array items: $ref: '#/components/schemas/KeyActionConfigDRF' keyActionsEnabled: type: boolean profile: $ref: '#/components/schemas/ProfileDRF' features: $ref: '#/components/schemas/FeaturesDRF' extraCustomFields: type: object additionalProperties: {} surgeryDetails: $ref: '#/components/schemas/SurgeryDetailsDRF' contactUsURL: type: string version: type: integer integration: $ref: '#/components/schemas/IntegrationConfigDRF' language: type: string duration: type: string security: $ref: '#/components/schemas/SecurityDRF' mfaRequired: type: boolean code: type: string enrollmentCounter: type: integer staticEventConfig: $ref: '#/components/schemas/StaticEventConfigDRF' stats: $ref: '#/components/schemas/DeploymentStatsDRF' localizations: type: object additionalProperties: {} country: type: string dashboardConfiguration: $ref: '#/components/schemas/DeploymentLevelConfigurationDRF' labels: type: array items: $ref: '#/components/schemas/LabelDRF' tags: type: array items: type: string location: $ref: '#/components/schemas/LocationDRF' integrationDevices: type: array items: $ref: '#/components/schemas/IntegrationDeviceDRF' componentConfigs: type: object additionalProperties: {} defaultUnits: type: object additionalProperties: {} builder: $ref: '#/components/schemas/BuilderDRF' programId: type: integer LocalizableFields: type: array items: type: string title: ' localizablefields' patientCount: type: integer originalId: type: string orgInfo: $ref: '#/components/schemas/OrgInfoDRF' DeploymentRoleUpdateObjectBodyDRF: type: object properties: roles: type: array items: $ref: '#/components/schemas/RoleDTODRF' DeploymentStatsDRF: type: object properties: completedCount: $ref: '#/components/schemas/StatDRF' completedTask: $ref: '#/components/schemas/StatDRF' consentedCount: $ref: '#/components/schemas/StatDRF' enrolledCount: $ref: '#/components/schemas/StatDRF' patientCount: $ref: '#/components/schemas/StatDRF' updateDateTime: type: string format: date-time DeploymentStatsResponseObjectDRF: type: object properties: numberOfActiveUsers: type: integer numberOfOffboardedUsers: type: integer numberOfOnboardedUsers: type: integer DeploymentTemplateDTODRF: type: object properties: id: type: string name: type: string description: type: string organizationIds: type: array items: type: string category: type: string template: $ref: '#/components/schemas/DeploymentDTODRF' status: type: string isVerified: type: boolean updateDateTime: type: string format: date-time createDateTime: type: string format: date-time required: - category - description - name DestinationDRF: type: object properties: destinationId: type: string destinationName: type: string destinationFunc: type: string isTest: type: boolean required: - destinationFunc - destinationId DetailedInvitationDRF: type: object properties: id: type: string email: type: string contactEmail: type: string phoneNumber: type: string text: type: string code: type: string shortenedCode: type: string givenName: type: string familyName: type: string roles: type: array items: $ref: '#/components/schemas/RoleAssignmentDTODRF' numberOfTry: type: integer expiresAt: type: string format: date-time createDateTime: type: string format: date-time updateDateTime: type: string format: date-time senderId: type: string clientId: type: string language: type: string extraInfo: type: object additionalProperties: {} type: type: string status: type: string deferredLink: type: string deferredLinkExpiresAt: type: string format: date-time deepLinkValue: type: string ssoEnabled: type: boolean userId: type: string invitedBy: $ref: '#/components/schemas/UserDTODRF' required: - code - expiresAt - invitedBy DeviceCategoriesDRF: type: object properties: devices: type: array items: $ref: '#/components/schemas/DeviceCategoryDRF' DeviceCategoryDRF: type: object properties: name: type: string connections: type: array items: $ref: '#/components/schemas/DeviceConnectionDRF' DeviceConnectionDRF: type: object properties: id: type: string status: type: string name: type: string brand: type: array items: type: string description: type: string cover: type: string DeviceConnectionIdDRF: type: object properties: id: type: string required: - id DeviceDTODRF: type: object properties: devicePushId: type: string devicePushIdType: type: string deviceDetails: type: string id: type: string userId: type: string createDateTime: type: string format: date-time updateDateTime: type: string format: date-time required: - devicePushId - devicePushIdType DeviceDetailsDRF: type: object properties: uuid: type: string serialNumber: type: string modelName: type: string manufacturer: type: string required: - manufacturer - modelName - uuid DeviceInfoDRF: type: object properties: id: type: string firmwareVersion: type: string coefs: type: array items: type: number format: double btps: $ref: '#/components/schemas/BTPSInfoDRF' required: - btps - coefs DeviceIntegrationDRF: type: object properties: enabled: type: boolean DeviceManufacturerDRF: type: object properties: name: type: string displayName: type: string sdkKey: type: string sdkConfig: $ref: '#/components/schemas/SdkConfigDRF' required: - name DeviceSessionDTODRF: type: object properties: id: type: string userId: type: string refreshToken: type: string deviceAgent: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time isActive: type: boolean required: - deviceAgent DevicesResponseDataDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/DeviceDTODRF' total: type: integer DiabetesDistressScoreDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string totalDDS: type: number format: double emotionalBurden: type: number format: double physicianDistress: type: number format: double regimenDistress: type: number format: double interpersonalDistress: type: number format: double required: - deploymentId - deviceName - moduleId - totalDDS - userId DiabetesDistressScoreResultsDRF: type: object properties: DiabetesDistressScore: type: array items: $ref: '#/components/schemas/DiabetesDistressScoreDTODRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' DiaryButtonDRF: type: object properties: label: type: string action: type: string required: - action - label DiaryCategoryResponseDRF: type: object properties: id: type: string name: type: string items: type: array items: $ref: '#/components/schemas/ItemDRF' required: - id - name DiaryChipResponseDRF: type: object properties: icon: type: string text: type: string textColor: type: string iconColor: type: string borderColor: type: string required: - text DiaryDetailItemResponseDRF: type: object properties: key: type: string value: type: string valueColor: type: string icon: type: string iconColor: type: string DiaryItemResponseDRF: type: object properties: id: type: string userId: type: string diaryId: type: string diarySourceId: type: string moduleConfigId: type: string diaryType: type: string primitiveType: type: string title: type: string value: type: array items: type: string unit: type: array items: type: string diaryBG: type: string diarySidebar: type: string diaryChips: type: array items: $ref: '#/components/schemas/DiaryChipResponseDRF' mealEventType: type: string flags: type: object additionalProperties: {} detailsTitle: type: string details: type: array items: $ref: '#/components/schemas/DiaryDetailItemResponseDRF' buttons: type: array items: $ref: '#/components/schemas/DiaryButtonDRF' detailsPresentation: type: string visibility: type: array items: type: string localizationData: type: object additionalProperties: {} extraFields: type: object additionalProperties: {} updateDateTime: type: string format: date-time createDateTime: type: string format: date-time startDateTime: type: string format: date-time required: - createDateTime - details - diaryBG - diaryId - diarySidebar - diarySourceId - diaryType - id - startDateTime - title - updateDateTime - userId - visibility DiaryOverviewDRF: type: object properties: title: type: string value: type: string diarySidebar: type: string valueTextColor: type: string startDateTime: type: string format: date-time localizationData: type: object additionalProperties: {} required: - startDateTime - title DiaryWidgetResponseObjectDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/DiaryOverviewDRF' required: - items DysarthriaDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string countingRecordingID: type: string initialProbability: type: number format: double fatiguedProbability: type: number format: double probability: type: number format: double confidence: type: string buttercupInitialRecordingID: type: string buttercupFatiguedRecordingID: type: string required: - buttercupFatiguedRecordingID - buttercupInitialRecordingID - countingRecordingID - deploymentId - deviceName - moduleId - userId DysphoniaDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string countingRecordingID: type: string initialProbability: type: number format: double fatiguedProbability: type: number format: double probability: type: number format: double confidence: type: string aaahhhInitialRecordingID: type: string aaahhhFatiguedRecordingID: type: string required: - aaahhhFatiguedRecordingID - aaahhhInitialRecordingID - countingRecordingID - deploymentId - deviceName - moduleId - userId ECGAliveCorDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string s3Object: $ref: '#/components/schemas/S3ObjectDRF' kardiaEcgRecordId: type: string required: - deploymentId - deviceName - kardiaEcgRecordId - moduleId - s3Object - userId ECGAliveCorResultsDRF: type: object properties: ECGAliveCor: type: array items: $ref: '#/components/schemas/ECGAliveCorDTODRF' ECGDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string averageHeartRate: type: integer classification: type: string leadType: type: string pdf: $ref: '#/components/schemas/S3ObjectDRF' dataPoints: $ref: '#/components/schemas/FlatBufferS3ObjectDRF' required: - averageHeartRate - classification - deploymentId - deviceName - leadType - moduleId - userId ECGHealthKitDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: string ecgReading: $ref: '#/components/schemas/ECGReadingDRF' generatedPDF: $ref: '#/components/schemas/S3ObjectDRF' required: - deploymentId - deviceName - ecgReading - moduleId - userId - value ECGHealthKitResultsDRF: type: object properties: ECGHealthKit: type: array items: $ref: '#/components/schemas/ECGHealthKitDTODRF' ECGReadingDRF: type: object properties: averageHeartRate: type: integer dataPoints: $ref: '#/components/schemas/FlatBufferS3ObjectDRF' required: - averageHeartRate - dataPoints ECGResultsDRF: type: object properties: ECG: type: array items: $ref: '#/components/schemas/ECGDTODRF' EConsentDRF: type: object properties: id: type: string enabled: type: string review: $ref: '#/components/schemas/ConsentReviewDRF' revision: type: integer additionalConsentQuestions: type: array items: $ref: '#/components/schemas/AdditionalConsentQuestionDRF' signature: $ref: '#/components/schemas/ConsentSignatureDRF' sections: type: array items: $ref: '#/components/schemas/EConsentSectionDRF' instituteName: type: string instituteFullName: type: string instituteTextDetails: type: string admissionText: type: string createDateTime: type: string format: date-time LocalizableFields: type: array items: type: string title: ' localizablefields' title: type: string overviewText: type: string contactText: type: string required: - contactText - enabled - overviewText - sections - title EConsentFormDRF: type: object properties: id: type: string econsentId: type: string title: type: string lastUpdated: type: string format: date-time state: type: string versionString: type: string required: - econsentId - id - lastUpdated - state - title - versionString EConsentLogDTODRF: type: object properties: givenName: type: string middleName: type: string familyName: type: string signature: $ref: '#/components/schemas/S3ObjectDRF' sharingOption: type: string privacy: type: boolean feedback: type: boolean agreement: type: boolean additionalConsentAnswers: type: object additionalProperties: {} consentOption: type: string id: type: string userId: type: string consentId: type: string revision: type: integer createDateTime: type: string format: date-time deploymentId: type: string econsentId: type: string pdfLocation: $ref: '#/components/schemas/S3ObjectDRF' endDateTime: type: string format: date-time required: - deploymentId - userId EConsentResponseObjectDRF: type: object properties: id: type: string enabled: type: string review: $ref: '#/components/schemas/ConsentReviewDRF' revision: type: integer additionalConsentQuestions: type: array items: $ref: '#/components/schemas/AdditionalConsentQuestionDRF' signature: $ref: '#/components/schemas/ConsentSignatureDRF' sections: type: array items: $ref: '#/components/schemas/EConsentSectionDRF' instituteName: type: string instituteFullName: type: string instituteTextDetails: type: string admissionText: type: string createDateTime: type: string format: date-time LocalizableFields: type: array items: type: string title: ' localizablefields' title: type: string overviewText: type: string contactText: type: string required: - contactText - enabled - overviewText - sections - title EConsentSectionDRF: type: object properties: type: type: string title: type: string details: type: string reviewDetails: type: string options: type: array items: $ref: '#/components/schemas/ConsentSectionOptionsDRF' LocalizableFields: type: array items: type: string title: ' localizablefields' contentType: type: string thumbnailUrl: type: string thumbnailLocation: $ref: '#/components/schemas/S3ObjectDRF' videoUrl: type: string videoLocation: $ref: '#/components/schemas/S3ObjectDRF' required: - contentType - type EQ5D5LDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string indexValue: type: number format: double healthState: type: integer mobility: type: integer selfCare: type: integer usualActivities: type: integer pain: type: integer anxiety: type: integer eqVas: type: integer required: - deploymentId - deviceName - moduleId - userId EQ5D5LResultsDRF: type: object properties: EQ5D5L: type: array items: $ref: '#/components/schemas/EQ5D5LDTODRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' EhrLogDTODRF: type: object properties: id: type: integer mongoId: type: string userId: type: string deploymentId: type: string integrationId: type: string method: type: string endpoint: type: string requestHeaders: type: string requestData: type: string statusCode: type: integer responseHeaders: type: string responseData: type: string responseTime: type: integer errorMessage: type: string authType: type: string destinationFunc: type: string createDateTime: type: string format: date-time updateDateTime: type: string format: date-time EmailConfigDRF: type: object properties: enabled: type: boolean templates: type: array items: $ref: '#/components/schemas/EmailTemplateDRF' EmailTemplateDRF: type: object properties: name: type: string subject: type: string template: type: string required: - name - template EncryptValueRequestObjectBodyDRF: type: object properties: value: type: string required: - value EncryptValueResponseObjectDRF: type: object properties: encryptedValue: type: string EndpointDRF: type: object properties: id: type: string name: type: string path: type: string verificationToken: type: string required: - id - path - verificationToken EnvironmentDRF: type: object properties: pressure: type: number format: double temperature: type: number format: double humidity: type: number format: double required: - humidity - pressure - temperature EthnicityOptionDRF: type: object properties: displayName: type: string value: type: string LocalizableFields: type: array items: type: string title: ' localizablefields' required: - displayName - value ExportClientInvoiceDetailsRequestObjectDRF: type: object properties: fileName: type: string skip: type: integer limit: type: integer yearMonth: type: string clientId: type: string search: type: string required: - yearMonth ExportDeploymentConfigsServiceInfoDRF: type: object properties: exporterEmail: type: string exportedDateTime: type: string format: date-time platform: type: string fileSize: type: integer fileName: type: string exporterVersion: type: string fileId: type: string fileIntegrityVerified: type: boolean deploymentName: type: string ExportOrganizationConfigsServiceInfoDRF: type: object properties: exporterEmail: type: string exportedDateTime: type: string format: date-time platform: type: string fileSize: type: integer fileName: type: string exporterVersion: type: string fileId: type: string fileIntegrityVerified: type: boolean organizationName: type: string deploymentNames: type: array items: type: string ExportParametersDRF: type: object properties: fromDate: type: string format: date-time toDate: type: string format: date-time moduleNames: type: array items: type: string excludedModuleNames: type: array items: type: string userIds: type: array items: type: string deIdentified: type: boolean maskFreeText: type: boolean includeNullFields: type: boolean includeUserMetaData: type: boolean useFlatStructure: type: boolean extraQuestionIds: type: object additionalProperties: {} view: type: string format: type: string binaryOption: type: string layer: type: string quantity: type: string questionnairePerName: type: boolean splitMultipleChoice: type: boolean splitSymptoms: type: boolean translatePrimitives: type: boolean organizationId: type: string deploymentIds: type: array items: type: string singleFileResponse: type: boolean translationShortCodesObject: $ref: '#/components/schemas/S3ObjectDRF' translationShortCodesObjectFormat: type: string includeFields: type: array items: type: string excludeFields: type: array items: type: string deIdentifyHashFields: type: array items: type: string deIdentifyRemoveFields: type: array items: type: string exportBucket: type: string onboardingModuleNames: type: array items: type: string preferShortCode: type: boolean useCreationTime: type: boolean bucketing: type: array items: $ref: '#/components/schemas/FieldBucketingDRF' forThirdParty: type: boolean excludeMinors: type: boolean ExportProcessDTODRF: type: object properties: id: type: string resultObject: $ref: '#/components/schemas/ExportResultObjectDRF' status: type: string seen: type: boolean exportParams: $ref: '#/components/schemas/ExportParametersDRF' deploymentId: type: string deploymentIds: type: array items: type: string organizationId: type: string requesterId: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time exportType: type: string taskId: type: string ExportProfileContentDRF: type: object properties: name: type: string content: $ref: '#/components/schemas/ExportParametersDRF' deploymentId: type: string organizationId: type: string default: type: boolean ExportProfileDTODRF: type: object properties: name: type: string content: $ref: '#/components/schemas/ExportParametersDRF' deploymentId: type: string organizationId: type: string default: type: boolean id: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time ExportResultObjectDRF: type: object properties: bucket: type: string key: type: string required: - bucket - key ExportRevereResultsRequestObjectDRF: type: object properties: status: type: string ExportUserRequestDataDRF: type: object properties: fromDate: type: string format: date-time toDate: type: string format: date-time moduleNames: type: array items: type: string excludedModuleNames: type: array items: type: string userIds: type: array items: type: string deIdentified: type: boolean maskFreeText: type: boolean includeNullFields: type: boolean includeUserMetaData: type: boolean useFlatStructure: type: boolean extraQuestionIds: type: object additionalProperties: {} view: type: string format: type: string binaryOption: type: string layer: type: string quantity: type: string questionnairePerName: type: boolean splitMultipleChoice: type: boolean splitSymptoms: type: boolean translatePrimitives: type: boolean singleFileResponse: type: boolean translationShortCodesObject: $ref: '#/components/schemas/S3ObjectDRF' translationShortCodesObjectFormat: type: string includeFields: type: array items: type: string excludeFields: type: array items: type: string deIdentifyHashFields: type: array items: type: string deIdentifyRemoveFields: type: array items: type: string exportBucket: type: string onboardingModuleNames: type: array items: type: string preferShortCode: type: boolean useCreationTime: type: boolean bucketing: type: array items: $ref: '#/components/schemas/FieldBucketingDRF' excludeMinors: type: boolean useExportProfile: type: boolean baseProfile: type: string doTranslate: type: boolean managerId: type: string ExtendedUpdateQuestionnaireObjectDRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string answers: type: array items: $ref: '#/components/schemas/QuestionnaireAnswerDRF' appResult: $ref: '#/components/schemas/QuestionnaireAppResultDRF' isForManager: type: boolean questionnaireId: type: string questionnaireName: type: string value: type: number format: double skipped: type: array items: $ref: '#/components/schemas/QuestionnaireAnswerDRF' updateDateTime: type: string format: date-time signOffDateTime: type: string format: date-time status: type: string revision: type: integer type: type: string note: type: string required: - answers - deploymentId - deviceName - moduleId - questionnaireId - questionnaireName - type - userId ExtraDRF: type: object properties: sortPrimitiveName: type: string moduleId: type: string moduleConfigId: type: string required: - moduleConfigId - moduleId FJSHipResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' FJSKneeResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' FeaturesDRF: type: object properties: appMenu: type: array items: type: string appointment: type: boolean carePlanDailyAdherence: type: boolean offBoarding: type: boolean personalDocuments: type: boolean patientPersonalization: $ref: '#/components/schemas/PatientPersonalizationDRF' proxy: type: boolean surgeryDateRule: $ref: '#/components/schemas/SurgeryDateRuleDRF' labels: type: boolean portal: type: object additionalProperties: {} offBoardingReasons: $ref: '#/components/schemas/OffBoardingReasonsDRF' moveUserReasons: $ref: '#/components/schemas/MoveUserReasonsDRF' messaging: $ref: '#/components/schemas/MessagingDRF' hideAppSupport: type: boolean summaryReport: $ref: '#/components/schemas/SummaryReportDRF' linkInvites: type: boolean classB: type: boolean deviceIntegration: $ref: '#/components/schemas/DeviceIntegrationDRF' customAppConfig: type: object additionalProperties: {} improvedOnboarding: type: boolean timeline: type: boolean profilePicture: type: boolean unitsIsHidden: type: boolean dataDownloadIsHidden: type: boolean labelIsHidden: type: boolean ifuIsHidden: type: boolean videoAdapter: type: string mealBasedModules: type: array items: type: string email: $ref: '#/components/schemas/EmailConfigDRF' LocalizableFields: type: array items: type: string title: ' localizablefields' FeedBacksGroupedByRagDRF: type: object properties: rag: type: array items: type: string texts: type: array items: $ref: '#/components/schemas/FeedbackTextDRF' required: - rag - texts FeedbackConfigDRF: type: object properties: enabled: type: boolean upperBound: type: integer lowerBound: type: integer query: type: string tags: type: array items: type: string cmsContentIds: type: array items: type: string severityFilter: type: array items: $ref: '#/components/schemas/SeverityFilterDRF' variabilityFilter: $ref: '#/components/schemas/VariabilityFilterDRF' feedbacks: type: array items: $ref: '#/components/schemas/FeedBacksGroupedByRagDRF' required: - enabled FeedbackNotificationDataDRF: type: object properties: title: type: string body: type: string offline: type: boolean LocalizableFields: type: array items: type: string title: ' localizablefields' order: type: integer FeedbackTextDRF: type: object properties: id: type: string text: type: string order: type: integer required: - id - text FeedbackTextResponseDRF: type: object properties: feedbackTextId: type: string title: type: string text: type: string required: - feedbackTextId - text - title FeedbackTextsDRF: type: object properties: groupedBy: type: array items: type: string notifications: type: array items: $ref: '#/components/schemas/FeedbackNotificationDataDRF' FeverAndPainDrugsDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string hasAntiFeverPainDrugs: type: boolean medStartedBeforeAfter: type: string daysBeforeVacMedication: type: integer daysAfterVacMedication: type: integer isUnderMedication: type: boolean daysCountMedication: type: integer metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - deploymentId - deviceName - hasAntiFeverPainDrugs - metadata - moduleId - userId FeverAndPainDrugsResultsDRF: type: object properties: FeverAndPainDrugs: type: array items: $ref: '#/components/schemas/FeverAndPainDrugsDTODRF' FieldBucketingDRF: type: object properties: fieldPath: type: string buckets: type: array items: $ref: '#/components/schemas/BucketDRF' undefineUnmatched: type: boolean required: - buckets - fieldPath FileFieldDRF: type: object properties: fileId: type: string required: - fileId FirmwareMetadataDRF: type: object properties: version: type: string releaseDate: type: string releaseNotes: type: string crc32Checksum: type: string FirmwareUpdateResponseObjectDRF: type: object properties: make: type: string model: type: string fileURL: type: string metadata: $ref: '#/components/schemas/FirmwareMetadataDRF' required: - fileURL - make - metadata - model FitbitHRVDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string rmssd: type: number format: double coverage: type: number format: double hf: type: number format: double lf: type: number format: double required: - deploymentId - deviceName - moduleId - userId FiveLivesTokenRequestObjectDRF: type: object properties: userId: type: string required: - userId FiveLivesTokenResponseObjectDRF: type: object properties: authToken: type: string required: - authToken FiveLivesWidgetResponseDRF: type: object properties: title: type: string description: type: string about: type: string rank: type: string scoreTables: type: array items: $ref: '#/components/schemas/ScoreTableDRF' gameId: type: string buttonText: type: string required: - about - buttonText - description - gameId - rank - title FlagsDRF: type: object properties: red: type: integer amber: type: integer gray: type: integer FlatBufferS3ObjectDRF: type: object properties: bucket: type: string key: type: string region: type: string fbsVersion: type: integer required: - bucket - key FootnoteDRF: type: object properties: enabled: type: boolean text: type: string LocalizableFields: type: array items: type: string title: ' localizablefields' ForceDataDRF: type: object properties: x: type: array items: type: integer y: type: array items: type: integer z: type: array items: type: integer zeroX: type: array items: type: integer zeroY: type: array items: type: integer zeroZ: type: array items: type: integer required: - x - y - z - zeroX - zeroY - zeroZ FormDataDRF: type: object properties: id: type: string userId: type: string title: type: string description: type: string model: type: string isRecurring: type: boolean instanceExpiresIn: type: string startDateTime: type: string endDateTime: type: string format: date-time enabled: type: boolean parentId: type: string hasCustomSchedule: type: boolean isSilent: type: boolean updateDateTime: type: string createDateTime: type: string completeDateTime: type: string keyActionConfigId: type: string learnArticleId: type: string moduleId: type: string moduleConfigId: type: string deploymentId: type: string result: $ref: '#/components/schemas/QuestionnaireDTODRF' status: type: string required: - keyActionConfigId - model FormRevisionDTODRF: type: object properties: id: type: string version: type: integer note: type: string submitterId: type: string createDateTime: type: string format: date-time content: $ref: '#/components/schemas/QuestionnaireDTODRF' submitterName: type: string required: - content - submitterId - version FullDeploymentLearnDRF: type: object properties: id: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time sections: type: array items: $ref: '#/components/schemas/CreateFullDeploymentLearnSectionRequestObjectDRF' LocalizableFields: type: array items: type: string title: ' localizablefields' GCPFhirDTODRF: type: object properties: url: type: string serviceAccountData: type: string config: type: object additionalProperties: {} required: - serviceAccountData - url GadgetLinkDRF: type: object properties: id: type: string order: type: integer size: type: string required: - id - order - size GenderOptionTypeDRF: type: object properties: displayName: type: string value: type: string LocalizableFields: type: array items: type: string title: ' localizablefields' required: - displayName - value GeneralAnxietyDisorderResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' GenerateAPISecretRequestObjectDRF: type: object properties: organizationId: type: string required: - organizationId GenerateAuthKeysRequestObjectDRF: type: object properties: userId: type: string authType: type: string name: type: string whitelistIPs: type: array items: type: string required: - userId GenerateAuthKeysResponseObjectDRF: type: object properties: authId: type: string authKey: type: string required: - authId - authKey GenerateDeploymentRequestObjectDRF: type: object properties: inputText: type: string required: - inputText GenerateDeploymentResponseObjectDRF: type: object properties: deploymentName: type: string title: type: string description: type: string descriptionUrl: type: string sortingIndex: type: integer templateFile: type: string thumbnail: type: string meta: type: object additionalProperties: {} GenerateMasterTranslationsResponseObjectDRF: type: object properties: masterTranslations: type: object additionalProperties: {} GenerateSummaryReportRequestDataDRF: type: object properties: format: type: string startDateTime: type: string format: date-time endDateTime: type: string format: date-time required: - format GenerateTextRequestObjectDRF: type: object properties: user: $ref: '#/components/schemas/UserDTODRF' submitter: $ref: '#/components/schemas/UserDTODRF' deployment: $ref: '#/components/schemas/DeploymentDTODRF' action: type: string contexts: type: array items: type: string moduleIds: type: array items: type: string inputText: type: string required: - action GenerateTextResponseObjectDRF: type: object properties: prompt: type: string generatedText: type: string GenericEHRDTODRF: type: object properties: url: type: string tokenUrl: type: string authType: type: string apiKey: type: string apiSecret: type: string keyId: type: string clientId: type: string clientSecret: type: string privateKey: type: string sourceId: type: string sourceName: type: string destination: type: array items: $ref: '#/components/schemas/DestinationDRF' endpoint: type: array items: $ref: '#/components/schemas/EndpointDRF' logsId: type: string logsAttemptId: type: string accessToken: type: string accessTokenExpiration: type: string extraCustomFields: type: object additionalProperties: {} retry: type: integer required: - authType - url GeolocationDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string latitude: type: string format: decimal pattern: ^-?\d{0,15}(?:\.\d{0,4})?$ longitude: type: string format: decimal pattern: ^-?\d{0,15}(?:\.\d{0,4})?$ altitude: type: string format: decimal pattern: ^-?\d{0,15}(?:\.\d{0,4})?$ accuracy: type: number format: double altitudeAccuracy: type: number format: double heading: type: number format: double speed: type: number format: double required: - deploymentId - deviceName - latitude - longitude - moduleId - userId GeolocationDataResponseObjectDRF: type: object properties: data: type: array items: $ref: '#/components/schemas/PointDataFieldDRF' value: type: array items: type: string description: type: string date: type: string format: date-time GeolocationResultsDRF: type: object properties: Geolocation: type: array items: $ref: '#/components/schemas/GeolocationDTODRF' GetBillingRecordResponseObjectDRF: type: object properties: id: type: string deployment: $ref: '#/components/schemas/DeploymentDTODRF' deploymentId: type: string patient: $ref: '#/components/schemas/UserDTODRF' patientId: type: string provider: type: string diagnosisType: type: string deviceConnectionDate: type: string primaryInsurance: type: string workFlow: type: string reportEndDate: type: string isEligible: type: boolean monitoringMinutes: type: integer numberOfCalls: type: integer monthReading: type: integer consentDate: type: string consentId: type: string deviceType: type: string deviceModel: type: string charges: type: array items: $ref: '#/components/schemas/CptChargeUnitObjectDRF' GetCPTProfilesResponseObjectDRF: type: object properties: profiles: type: array items: $ref: '#/components/schemas/CPTProfileEntryDRF' GetInvitationLinkRequestDataDRF: type: object properties: language: type: string clientId: type: string projectId: type: string deploymentId: type: string roleId: type: string expiresIn: type: string retrieveShortened: type: boolean userId: type: string required: - clientId - deploymentId - projectId - roleId GetInvitationLinkResponseObjectDRF: type: object properties: link: type: string GetNodesResponseObjectDRF: type: object properties: nodes: type: array items: $ref: '#/components/schemas/NodeConvertibleDRF' required: - nodes GetSignedUrlResponseObjectV1DRF: type: object properties: url: type: string fileName: type: string fileSize: type: integer contentType: type: string GetSignedUrlsRequestObjectV1DRF: type: object properties: fileIds: type: array items: type: string required: - fileIds GetSignedUrlsResponseObjectV1DRF: type: object properties: signedUrls: type: array items: type: string GetTemplateWorkflowsResponseObjectDRF: type: object properties: workflowTemplates: type: array items: $ref: '#/components/schemas/WorkflowDTODRF' required: - workflowTemplates GetWorkflowResponseObjectDRF: type: object properties: workflow: $ref: '#/components/schemas/WorkflowDTODRF' required: - workflow GetWorkflowsResponseObjectDRF: type: object properties: workflows: type: array items: $ref: '#/components/schemas/WorkflowDTODRF' required: - workflows HRVDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double minValue: type: integer maxValue: type: integer medianValue: type: number format: double rawDataObject: $ref: '#/components/schemas/S3ObjectDRF' required: - deploymentId - deviceName - moduleId - userId - value HScoreDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer topValue: type: integer bottomValue: type: integer status: type: string keyAreasItems: type: array items: $ref: '#/components/schemas/KeyAreaItemDRF' required: - bottomValue - deploymentId - deviceName - moduleId - status - topValue - userId - value HeadOrientationQCRequestObjectDRF: type: object properties: image: $ref: '#/components/schemas/S3ObjectDRF' language: type: string userId: type: string numPrompts: type: integer lastCheck: type: boolean required: - image - numPrompts HeadOrientationQCResponseObjectDRF: type: object properties: qcOutputMessage: type: string numPrompts: type: integer stopExercise: type: boolean canSubmitRecording: type: boolean required: - canSubmitRecording - numPrompts - qcOutputMessage - stopExercise HealthMetricDRF: type: object properties: sleep: $ref: '#/components/schemas/SleepScoreDRF' HealthProblemsOrDisabilityItemDRF: type: object properties: reportedBefore: type: string symptomsList: type: array items: $ref: '#/components/schemas/SymptomsListItemDRF' healthIssueAction: type: array items: type: string remoteConsultation: type: integer inPersonConsultation: type: integer hospitalizedNights: type: integer isMedicationsPrescribed: type: boolean medicationName: type: array items: type: string receivedDiagnosis: type: string diagnosisName: type: array items: type: string lostDaysAtWorkOrEducation: type: string lostWorkDays: type: integer lostEducationDays: type: integer isHealthIssueDueToCovid: type: boolean tookCovidTest: type: string numCovidTestsTaken: type: integer covidTestList: type: array items: $ref: '#/components/schemas/CovidTestListItemDRF' otherNewOrWorseSymptoms: type: boolean required: - healthIssueAction - isHealthIssueDueToCovid - isMedicationsPrescribed - lostDaysAtWorkOrEducation - receivedDiagnosis - reportedBefore - symptomsList HealthScoreResultsDRF: type: object properties: BodyMeasurement: type: array items: $ref: '#/components/schemas/BodyMeasurementDTODRF' SelfHealthRate: type: array items: $ref: '#/components/schemas/SelfHealthRateDTODRF' WaistToHeight: type: array items: $ref: '#/components/schemas/WaistToHeightDRF' Weight: type: array items: $ref: '#/components/schemas/WeightDTODRF' HeartRate: type: array items: $ref: '#/components/schemas/HeartRateDTODRF' SleepQuestions: type: array items: $ref: '#/components/schemas/SleepQuestionsDTODRF' SmokeQuestions: type: array items: $ref: '#/components/schemas/SmokeQuestionsDTODRF' ReactionTime: type: array items: $ref: '#/components/schemas/ReactionTimeDRF' AlcoholConsumption: type: array items: $ref: '#/components/schemas/AlcoholConsumptionDTODRF' NumericMemory: type: array items: $ref: '#/components/schemas/NumericMemoryDTODRF' HScore: type: array items: $ref: '#/components/schemas/HScoreDTODRF' HealthStatusDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string newOrWorseSymptoms: type: string healthProblemsOrDisabilityList: type: array items: $ref: '#/components/schemas/HealthProblemsOrDisabilityItemDRF' metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - deploymentId - deviceName - metadata - moduleId - newOrWorseSymptoms - userId HealthStatusResultsDRF: type: object properties: HealthStatus: type: array items: $ref: '#/components/schemas/HealthStatusDTODRF' HeartRateDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer heartRateType: type: string classification: type: string variabilityAVNN: type: integer variabilitySDNN: type: integer variabilityRMSSD: type: integer variabilityPNN50: type: number format: double variabilityprcLF: type: number format: double confidence: type: integer goodIBI: type: integer rawDataObject: $ref: '#/components/schemas/S3ObjectDRF' valueUnit: type: string metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - deploymentId - deviceName - moduleId - userId - value HeartRateResultsDRF: type: object properties: HeartRate: type: array items: $ref: '#/components/schemas/HeartRateDTODRF' FitbitHRV: type: array items: $ref: '#/components/schemas/FitbitHRVDTODRF' HRV: type: array items: $ref: '#/components/schemas/HRVDTODRF' HeightDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double valueUnit: type: string required: - deploymentId - deviceName - moduleId - userId - value HeightResultsDRF: type: object properties: Height: type: array items: $ref: '#/components/schemas/HeightDTODRF' HeightZScoreResultsDRF: type: object properties: Height: type: array items: $ref: '#/components/schemas/HeightDTODRF' HemophiliaJournalAnswersDRF: type: object properties: accidentDate: type: string format: date-time treatment: type: object additionalProperties: {} reason: type: string severity: type: string scale: type: integer factorUnits: type: integer note: type: string photos: type: array items: type: string required: - accidentDate - reason - scale - severity HemophiliaJournalDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string bodyLocation: type: string bodyPartInjury: type: string customBodyPart: type: string extraData: $ref: '#/components/schemas/HemophiliaJournalAnswersDRF' required: - bodyPartInjury - deploymentId - deviceName - moduleId - userId HemophiliaJournalResultsDRF: type: object properties: HemophiliaJournal: type: array items: $ref: '#/components/schemas/HemophiliaJournalDTODRF' HemophiliaPrerequisitesRequestObjectDRF: type: object properties: id: type: string userId: type: string answers: type: array items: $ref: '#/components/schemas/QuestionnaireAnswerDRF' targetJoints: type: array items: type: string prophylacticMedication: type: object additionalProperties: {} asNeededMedication: type: object additionalProperties: {} updateDateTime: type: string format: date-time createDateTime: type: string format: date-time required: - answers HemophiliaPrerequisitesResponseObjectDRF: type: object properties: id: type: string userId: type: string answers: type: array items: $ref: '#/components/schemas/QuestionnaireAnswerDRF' targetJoints: type: array items: type: string prophylacticMedication: type: object additionalProperties: {} asNeededMedication: type: object additionalProperties: {} updateDateTime: type: string format: date-time createDateTime: type: string format: date-time required: - answers - userId HemophiliaResponseObjectDRF: type: object properties: title: type: string description: type: string primaryCTAtext: type: string secondaryCTAtext: type: string state: type: string legend: type: array items: $ref: '#/components/schemas/LegendItemDRF' bodyMapColor: type: array items: $ref: '#/components/schemas/BodyMapItemDRF' tooltip: type: string results: type: array items: $ref: '#/components/schemas/HemophiliaJournalDTODRF' hasSubmissions: type: boolean HiSidekickRequestObjectDRF: type: object properties: userQuery: type: string conversationHistory: type: array items: type: object additionalProperties: {} required: - userQuery HiSidekickResponseObjectDRF: type: object properties: answer: type: string imageUrl: type: string article: type: object additionalProperties: {} appConfig: type: object additionalProperties: {} HighFrequencyHeartRateDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer heartRateType: type: string classification: type: string variabilityAVNN: type: integer variabilitySDNN: type: integer variabilityRMSSD: type: integer variabilityPNN50: type: number format: double variabilityprcLF: type: number format: double confidence: type: integer goodIBI: type: integer rawDataObject: $ref: '#/components/schemas/S3ObjectDRF' valueUnit: type: string metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' multipleValues: type: array items: $ref: '#/components/schemas/MultipleValuesDataDRF' dataType: type: string required: - deploymentId - deviceName - moduleId - userId - value HighFrequencyHeartRateResultsDRF: type: object properties: HighFrequencyHeartRate: type: array items: $ref: '#/components/schemas/HighFrequencyHeartRateDTODRF' HighFrequencyStepDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string stepsObject: $ref: '#/components/schemas/FlatBufferS3ObjectDRF' required: - deploymentId - deviceName - moduleId - stepsObject - userId HighFrequencyStepResultsDRF: type: object properties: HighFrequencyStep: type: array items: $ref: '#/components/schemas/HighFrequencyStepDTODRF' HipDataDRF: type: object properties: pain: type: integer washing: type: integer transport: type: integer socks: type: integer shopping: type: integer walking: type: integer stairs: type: integer standing: type: integer limping: type: integer shooting: type: integer interference: type: integer bed: type: integer score: type: integer hipAffected: type: string required: - bed - interference - limping - pain - shooting - shopping - socks - stairs - standing - transport - walking - washing HypertensionResultsDRF: type: object properties: BloodPressure: type: array items: $ref: '#/components/schemas/BloodPressureDTODRF' Symptom: type: array items: $ref: '#/components/schemas/SymptomDTODRF' HypertensionWidgetResponseDRF: type: object properties: learnArticle: $ref: '#/components/schemas/CMSLearnArticleDRF' range: type: string value: type: array items: type: string units: type: array items: type: string date: type: string format: date-time iconColor: type: string greeting: type: string source: type: string IKDCDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string symptoms: $ref: '#/components/schemas/SymptomsDRF' sportsActivity: $ref: '#/components/schemas/SportsActivityDRF' kneeFunction: $ref: '#/components/schemas/KneeFunctionDRF' value: type: number format: double required: - deploymentId - deviceName - moduleId - userId ImportConfigurationValidateFileRequestObjectDRF: type: object properties: userId: type: string fileIds: type: array items: type: string required: - fileIds - userId ImportDeploymentConfigRequestObjectDRF: type: object properties: userId: type: string fileIds: type: array items: type: string organizationId: type: string name: type: string isSaMD: type: boolean required: - fileIds - organizationId - userId ImportDeploymentConfigurationValidateFileResponseDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/ExportDeploymentConfigsServiceInfoDRF' ImportLocalizationsRequestObjectDRF: type: object properties: deploymentId: type: string languages: type: array items: type: string fileId: type: string submitterId: type: string required: - deploymentId - fileId - submitterId ImportOrgConfigurationValidateFileResponseDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/ExportOrganizationConfigsServiceInfoDRF' ImportOrganizationConfigRequestObjectDRF: type: object properties: userId: type: string fileIds: type: array items: type: string required: - fileIds - userId InboundDRF: type: object properties: topic: type: string eventTypes: type: array items: type: string extraArgs: type: object additionalProperties: {} required: - topic IncidentReportResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' IndexDataDRF: type: object properties: aqi: $ref: '#/components/schemas/AqiDataDRF' required: - aqi IndexFileContentResponseDRF: type: object properties: deploymentTemplates: type: array items: $ref: '#/components/schemas/SharedTemplateFileDRF' IndicationDRF: type: object properties: name: type: string coding: type: array items: $ref: '#/components/schemas/CodingDRF' IndicationsAutocompleteResponseDRF: type: object properties: limit: type: integer skip: type: integer values: type: array items: $ref: '#/components/schemas/SnomedMedDataDRF' required: - limit - skip - values InfantFollowUpDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string isCovPregLiveBirth: type: boolean isMoreThan1ChildCovVac: type: boolean countCovPreg: type: integer children: type: array items: $ref: '#/components/schemas/ChildrenItemDRF' metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - deploymentId - deviceName - isCovPregLiveBirth - metadata - moduleId - userId InfantFollowUpResultsDRF: type: object properties: InfantFollowUp: type: array items: $ref: '#/components/schemas/InfantFollowUpDTODRF' InhalerInfoDRF: type: object properties: frequency: type: string required: - frequency InitiateVideoCallRequestObjectDRF: type: object properties: appointmentId: type: string managerId: type: string userId: type: string required: - managerId - userId InitiateVideoCallResponseObjectDRF: type: object properties: videoCallId: type: string roomSid: type: string authToken: type: string ttl: type: integer webLink: type: string sipAddress: type: string IntegrationConfigDRF: type: object properties: pamConfig: $ref: '#/components/schemas/PAMIntegrationConfigDRF' IntegrationDTODRF: type: object properties: organizationIds: type: array items: type: string deploymentIds: type: array items: type: string moduleNames: type: array items: type: string excludedModuleNames: type: array items: type: string integrationType: type: string webhook: $ref: '#/components/schemas/WebhookDTODRF' kafka: $ref: '#/components/schemas/KafkaDRF' gcpFhir: $ref: '#/components/schemas/GCPFhirDTODRF' genericEhr: $ref: '#/components/schemas/GenericEHRDTODRF' id: type: string name: type: string enabled: type: boolean updateDateTime: type: string format: date-time createDateTime: type: string format: date-time required: - deploymentIds - integrationType - name - organizationIds IntegrationDeviceDRF: type: object properties: model: type: string modelName: type: string displayName: type: string manufacturer: $ref: '#/components/schemas/DeviceManufacturerDRF' moduleIds: type: array items: type: string backgroundSync: type: boolean supportedMedications: type: object additionalProperties: {} required: - manufacturer - model IntegrationSignConsentRequestBodyDRF: type: object properties: email: type: string IntegrationSignInRequestBodyDRF: type: object properties: language: type: string clientId: type: string projectId: type: string deviceAgent: type: string email: type: string required: - clientId - projectId IntegrationSignUpRequestBodyDRF: type: object properties: language: type: string clientId: type: string projectId: type: string email: type: string contactEmail: type: string phoneNumber: type: string password: type: string displayName: type: string validationData: type: object additionalProperties: {} userAttributes: type: object additionalProperties: {} timezone: type: string ssoEnabled: type: boolean userId: type: string deviceAgent: type: string ipAddress: type: string required: - clientId - ipAddress - projectId IntegrationSignUpResponseObjectDRF: type: object properties: authToken: type: string refreshToken: type: string expiresIn: type: integer uid: type: string authTokenExpiresIn: type: integer IntercomSettingsDRF: type: object properties: appId: type: string webSecretKey: type: string androidSecretKey: type: string iosSecretKey: type: string InvitationDTODRF: type: object properties: id: type: string email: type: string contactEmail: type: string phoneNumber: type: string text: type: string code: type: string shortenedCode: type: string givenName: type: string familyName: type: string roles: type: array items: $ref: '#/components/schemas/RoleAssignmentDTODRF' numberOfTry: type: integer expiresAt: type: string format: date-time createDateTime: type: string format: date-time updateDateTime: type: string format: date-time senderId: type: string clientId: type: string language: type: string extraInfo: type: object additionalProperties: {} type: type: string status: type: string deferredLink: type: string deferredLinkExpiresAt: type: string format: date-time deepLinkValue: type: string ssoEnabled: type: boolean userId: type: string required: - code - expiresAt InvitationItemDRF: type: object properties: invitationCode: type: string invitationId: type: string email: type: string phoneNumber: type: string text: type: string InvitationResponseModelDRF: type: object properties: id: type: string email: type: string contactEmail: type: string phoneNumber: type: string text: type: string code: type: string shortenedCode: type: string givenName: type: string familyName: type: string roles: type: array items: $ref: '#/components/schemas/RoleAssignmentDTODRF' numberOfTry: type: integer expiresAt: type: string format: date-time createDateTime: type: string format: date-time updateDateTime: type: string format: date-time senderId: type: string clientId: type: string language: type: string extraInfo: type: object additionalProperties: {} type: type: string status: type: string deferredLink: type: string deferredLinkExpiresAt: type: string format: date-time deepLinkValue: type: string ssoEnabled: type: boolean userId: type: string roleName: type: string invitationLink: type: string invitedBy: type: string required: - code - expiresAt InvitationValidityResponseObjectDRF: type: object properties: ok: type: boolean invitationCode: type: string email: type: string phoneNumber: type: string role: type: string InviteAdminRequestObjectDRF: type: object properties: language: type: string clientId: type: string projectId: type: string emails: type: array items: type: string roles: type: array items: $ref: '#/components/schemas/RoleAssignmentDTODRF' expiresIn: type: string required: - clientId - emails - projectId - roles InviteResponseObjectDRF: type: object properties: alreadySignedUpEmails: type: array items: type: string ids: type: array items: type: string ok: type: boolean InviteUserToModuleRequestObjectDRF: type: object properties: deploymentId: type: string moduleConfigId: type: string expiresIn: type: string invitationType: type: string messageBody: type: string language: type: string userId: type: string required: - deploymentId - invitationType - messageBody InviteeDRF: type: object properties: givenName: type: string familyName: type: string email: type: string contactEmail: type: string phoneNumber: type: string userId: type: string InvoiceOverViewReportRowDTODRF: type: object properties: clientId: type: string clientName: type: string invoiceId: type: integer startDate: type: string endDate: type: string serviceDescription: type: string rates: type: integer sumUnits: type: integer amount: type: integer required: - invoiceId ItemDRF: type: object properties: id: type: string name: type: string required: - id - name JournalDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: string required: - deploymentId - deviceName - moduleId - userId - value JournalResultsDRF: type: object properties: Journal: type: array items: $ref: '#/components/schemas/JournalDTODRF' KCCQDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string physicalLimitation: type: number format: double symptomStability: type: number format: double symptomFrequency: type: number format: double symptomBurden: type: number format: double totalSymptomScore: type: number format: double selfEfficacy: type: number format: double qualityOfLife: type: number format: double socialLimitation: type: number format: double overallSummaryScore: type: number format: double clinicalSummaryScore: type: number format: double required: - clinicalSummaryScore - deploymentId - deviceName - moduleId - overallSummaryScore - physicalLimitation - qualityOfLife - selfEfficacy - socialLimitation - symptomBurden - symptomFrequency - symptomStability - totalSymptomScore - userId KCCQResultsDRF: type: object properties: KCCQ: type: array items: $ref: '#/components/schemas/KCCQDTODRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' KOOSDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string adlScore: type: number format: double qualityOfLifeScore: type: number format: double painScore: type: number format: double symptomsScore: type: number format: double sportRecreationScore: type: number format: double required: - adlScore - deploymentId - deviceName - moduleId - painScore - qualityOfLifeScore - sportRecreationScore - symptomsScore - userId KOOSResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' KOOS: type: array items: $ref: '#/components/schemas/KOOSDTODRF' WOMAC: type: array items: $ref: '#/components/schemas/WOMACDTODRF' KafkaDRF: type: object properties: url: type: string authType: type: string saslUsername: type: string saslPassword: type: string inbound: $ref: '#/components/schemas/InboundDRF' outbound: $ref: '#/components/schemas/OutboundDRF' required: - authType - inbound - outbound - url KeyActionConfigDRF: type: object properties: id: type: string title: type: string description: type: string deltaFromTriggerTime: type: string durationFromTrigger: type: string durationIso: type: string instanceExpiresIn: type: string type: type: string trigger: type: string notifyEvery: type: string numberOfNotifications: type: integer learnArticleId: type: string learnArticle: type: object additionalProperties: {} moduleId: type: string moduleConfigId: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time LocalizableFields: type: array items: type: string title: ' localizablefields' required: - deltaFromTriggerTime - durationIso - trigger - type KeyActionEventDRF: type: object properties: id: type: string userId: type: string title: type: string description: type: string model: type: string isRecurring: type: boolean instanceExpiresIn: type: string startDateTime: type: string endDateTime: type: string enabled: type: boolean extraFields: type: object additionalProperties: {} parentId: type: string snoozing: type: array items: type: string hasCustomSchedule: type: boolean isSilent: type: boolean updateDateTime: type: string createDateTime: type: string completeDateTime: type: string keyActionConfigId: type: string learnArticleId: type: string moduleId: type: string moduleConfigId: type: string deploymentId: type: string required: - keyActionConfigId - model KeyActionResponseDRF: type: object properties: id: type: string userId: type: string title: type: string description: type: string model: type: string isRecurring: type: boolean instanceExpiresIn: type: string startDateTime: type: string endDateTime: type: string enabled: type: boolean parentId: type: string hasCustomSchedule: type: boolean isSilent: type: boolean updateDateTime: type: string createDateTime: type: string completeDateTime: type: string keyActionConfigId: type: string learnArticleId: type: string moduleId: type: string moduleConfigId: type: string deploymentId: type: string required: - keyActionConfigId - model KeyAreaItemDRF: type: object properties: keyArea: type: string messageLine: type: string status: type: string value: type: integer submissionDateTime: type: string format: date-time required: - keyArea - messageLine - status - value KneeFunctionDRF: type: object properties: prior: type: number format: double current: type: number format: double KneeHealthIKDCResultsDRF: type: object properties: IKDC: type: array items: $ref: '#/components/schemas/IKDCDTODRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' LabelDRF: type: object properties: id: type: string text: type: string authorId: type: string createDateTime: type: string format: date-time updatedBy: type: string updateDateTime: type: string format: date-time isStatic: type: boolean operations: type: array items: type: string LearnArticleContentDRF: type: object properties: id: type: string cmsArticleId: type: string cmsThumbnail: type: string type: type: string timeToRead: type: string textDetails: type: string videoUrl: $ref: '#/components/schemas/S3ObjectDRF' url: type: string contentObject: $ref: '#/components/schemas/S3ObjectDRF' read: type: boolean isValid: type: boolean LocalizableFields: type: array items: type: string title: ' localizablefields' required: - type LearnArticleDRF: type: object properties: id: type: string title: type: string type: type: string thumbnailUrl: $ref: '#/components/schemas/S3ObjectDRF' order: type: integer content: $ref: '#/components/schemas/LearnArticleContentDRF' updateDateTime: type: string format: date-time createDateTime: type: string format: date-time LocalizableFields: type: array items: type: string title: ' localizablefields' required: - content - type LearnDRF: type: object properties: id: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time sections: type: array items: $ref: '#/components/schemas/LearnSectionDRF' LocalizableFields: type: array items: type: string title: ' localizablefields' LearnSectionDRF: type: object properties: id: type: string title: type: string order: type: integer articles: type: array items: $ref: '#/components/schemas/LearnArticleDRF' updateDateTime: type: string format: date-time createDateTime: type: string format: date-time LocalizableFields: type: array items: type: string title: ' localizablefields' LearnWidgetSectionResponseDRF: type: object properties: sectionId: type: string articles: type: array items: $ref: '#/components/schemas/CMSLearnArticleDRF' required: - sectionId LegDataDRF: type: object properties: pain: type: integer washing: type: integer transport: type: integer walk: type: integer meal: type: integer limping: type: integer kneelDown: type: integer bed: type: integer usualWork: type: integer letYouDown: type: integer shopping: type: integer stairs: type: integer score: type: integer legAffected: type: string required: - bed - kneelDown - letYouDown - limping - meal - pain - shopping - stairs - transport - usualWork - walk - washing LegendItemDRF: type: object properties: color: type: string label: type: string LibraryFileObjectDRF: type: object properties: id: type: string fileName: type: string fileSize: type: integer contentType: type: string metadata: type: object additionalProperties: {} LimitationDRF: type: object properties: answerId: type: string minimumAge: type: string maximumAge: type: string gender: type: string showForSources: type: array items: type: string method: type: string required: - method LinkProxyRequestDataDRF: type: object properties: proxyEmail: type: string required: - proxyEmail LinkProxyUserResponseObjectDRF: type: object properties: proxyId: type: string required: - proxyId LinkUnlinkDeploymentsRequestBodyDRF: type: object properties: deploymentIds: type: array items: type: string required: - deploymentIds ListAuthKeysResponseObjectDRF: type: object properties: authKeys: type: array items: type: object additionalProperties: {} userId: type: string ListCollectionsResponseDRF: type: object properties: collections: type: array items: type: string required: - collections ListIdResponseObjectDRF: type: object properties: ids: type: array items: type: string ListOrdersResponseObjectDRF: type: object properties: orders: type: array items: $ref: '#/components/schemas/OrderDTODRF' ListRetrieveLanguageDRF: type: object properties: languages: type: array items: $ref: '#/components/schemas/RetrieveLanguageDRF' required: - languages LocalizationSchemaDRF: type: object properties: en: type: object additionalProperties: {} en-GB: type: object additionalProperties: {} en-US: type: object additionalProperties: {} de: type: object additionalProperties: {} de-AT: type: object additionalProperties: {} de-CH: type: object additionalProperties: {} de-DE: type: object additionalProperties: {} fr: type: object additionalProperties: {} fr-CA: type: object additionalProperties: {} es: type: object additionalProperties: {} es-US: type: object additionalProperties: {} sv: type: object additionalProperties: {} ca: type: object additionalProperties: {} ar: type: object additionalProperties: {} nl: type: object additionalProperties: {} it: type: object additionalProperties: {} 'no': type: object additionalProperties: {} nb: type: object additionalProperties: {} ja: type: object additionalProperties: {} el: type: object additionalProperties: {} LocationDRF: type: object properties: address: type: string country: type: string countryCode: type: string city: type: string latitude: type: number format: double longitude: type: number format: double postalCode: type: string state: type: string street: type: string LocationInfoDRF: type: object properties: latitude: type: number format: double longitude: type: number format: double placeName: type: string required: - latitude - longitude - placeName LysholmDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string limp: type: number format: double caneOrCrutches: type: number format: double lockingSensation: type: number format: double givingWaySensation: type: number format: double pain: type: number format: double swelling: type: number format: double climbingStairs: type: number format: double squatting: type: number format: double lysholm: type: number format: double required: - caneOrCrutches - climbingStairs - deploymentId - deviceName - givingWaySensation - limp - lockingSensation - moduleId - pain - squatting - swelling - userId LysholmTegnerResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' Lysholm: type: array items: $ref: '#/components/schemas/LysholmDTODRF' Tegner: type: array items: $ref: '#/components/schemas/TegnerDTODRF' MGChartConfigDRF: type: object properties: legends: type: array items: type: string yMinValue: type: integer yMaxValue: type: integer thresholdLineValue: type: integer required: - legends - thresholdLineValue - yMaxValue - yMinValue MGDataResponseObjectDRF: type: object properties: unit: type: array items: type: string data: type: array items: $ref: '#/components/schemas/VitalsDataFieldDRF' value: type: array items: type: string description: type: string date: type: string format: date-time seen: type: boolean footer: type: array items: $ref: '#/components/schemas/FootnoteDRF' learnArticles: type: array items: $ref: '#/components/schemas/CMSLearnArticleDRF' chartConfig: $ref: '#/components/schemas/MGChartConfigDRF' required: - chartConfig - seen - unit MG_ADLDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer ocularDysfunction: type: integer respiratoryDysfunction: type: integer extremityDysfunction: type: integer oropharyngealDysfunction: type: integer required: - deploymentId - deviceName - extremityDysfunction - moduleId - ocularDysfunction - oropharyngealDysfunction - respiratoryDysfunction - userId - value MG_ADLResultsDRF: type: object properties: MG_ADL: type: array items: $ref: '#/components/schemas/MG_ADLDTODRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' ManagerNotificationsDRF: type: object properties: demographicsChange: type: boolean MarkCompleteUserReminderRequestDataDRF: type: object properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time required: - endDateTime - startDateTime MedicalConditionsItemDRF: type: object properties: conditionName: type: string isTakingMedication: type: boolean required: - conditionName - isTakingMedication MedicalHistoryDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string cancerType: type: array items: $ref: '#/components/schemas/CancerTypeItemDRF' medicalDiagnosis: type: array items: type: string medicalConditions: type: array items: $ref: '#/components/schemas/MedicalConditionsItemDRF' takingImmunoSuppressants: type: string immunoSuppressantMedicationList: type: array items: type: string isCovidInfectedInPast: type: boolean covidInfectedDate: type: string format: date-time isCovidToldByDoctor: type: boolean covidToldByDoctorDate: type: string format: date-time takenCovidTest: type: string covidTestResult: type: string covidTestDate: type: string format: date-time covidTestMethod: type: string covidTestOther: type: string covidSymptoms: type: array items: $ref: '#/components/schemas/CovidSymptomsItemDRF' otherCovidSymptoms: type: array items: $ref: '#/components/schemas/OtherCovidSymptomsItemDRF' covidSymptomAction: type: array items: type: string metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' hadCovidSymptoms: type: boolean hadOtherCovidSymptoms: type: boolean isDiagnosedWithCancer: type: boolean required: - deploymentId - deviceName - isCovidInfectedInPast - isCovidToldByDoctor - isDiagnosedWithCancer - medicalDiagnosis - metadata - moduleId - takenCovidTest - takingImmunoSuppressants - userId MedicalHistoryResultsDRF: type: object properties: MedicalHistory: type: array items: $ref: '#/components/schemas/MedicalHistoryDTODRF' MedicalRecordEntryDRF: type: object properties: id: type: string givenName: type: string familyName: type: string numberOfCalls: type: integer monitoringMinutes: type: integer diagnosis: type: string MedicationCalendarResponseDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/MedicationScheduleEventDRF' medications: type: array items: $ref: '#/components/schemas/MedicationDetailsDRF' MedicationDTODRF: type: object properties: id: type: string prn: type: boolean enabled: type: boolean userId: type: string deploymentId: type: string moduleId: type: string name: type: string doseQuantity: type: number format: double doseUnits: type: string schedule: $ref: '#/components/schemas/MedicationScheduleDRF' extraProperties: type: object additionalProperties: {} updateDateTime: type: string format: date-time createDateTime: type: string format: date-time changeHistory: type: array items: $ref: '#/components/schemas/MedicationHistoryDRF' required: - userId MedicationDetailsDRF: type: object properties: medicationId: type: string history: type: array items: $ref: '#/components/schemas/MedicationHistoryItemDRF' adherences: type: array items: $ref: '#/components/schemas/AdherenceDRF' required: - medicationId MedicationHistoryDRF: type: object properties: id: type: string prn: type: boolean enabled: type: boolean userId: type: string deploymentId: type: string moduleId: type: string name: type: string doseQuantity: type: number format: double doseUnits: type: string schedule: $ref: '#/components/schemas/MedicationScheduleDRF' extraProperties: type: object additionalProperties: {} updateDateTime: type: string format: date-time createDateTime: type: string format: date-time changeType: type: string required: - userId MedicationHistoryItemDRF: type: object properties: regimen: $ref: '#/components/schemas/RegimenChangeDRF' updateDateTime: type: string format: date-time required: - regimen - updateDateTime MedicationHistoryResponseV2DRF: type: object properties: items: type: array items: $ref: '#/components/schemas/MedicationHistoryV2DTODRF' total: type: integer required: - items - total MedicationHistoryV2DTODRF: type: object properties: id: type: string userId: type: string deploymentId: type: string medicationId: type: string medicationName: type: string changeType: type: string userType: type: string seen: type: boolean reason: $ref: '#/components/schemas/MedicationReasonUpdatedDRF' updateDateTime: type: string format: date-time createDateTime: type: string format: date-time regimen: $ref: '#/components/schemas/RegimenChangeDRF' required: - changeType - deploymentId - medicationId - medicationName - userId - userType MedicationLogDTODRF: type: object properties: id: type: string userId: type: string deploymentId: type: string eventId: type: string medicationId: type: string logsCount: type: integer status: type: string medicatedDateTimeSlots: type: array items: type: string format: date-time startDateTime: type: string format: date-time updateDateTime: type: string format: date-time createDateTime: type: string format: date-time device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string medicationName: type: string dosage: type: number format: double unit: type: string customUnit: type: string meal: type: string userNote: type: string relatedPrimitiveData: $ref: '#/components/schemas/ShortPrimitiveDataDRF' required: - deploymentId - eventId - medicationId - status - userId MedicationLogsResponseDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/MedicationLogDTODRF' required: - items MedicationMealScheduleDRF: type: object properties: meal: type: string dosage: type: number format: double unit: type: string customUnit: type: string timeOfReading: type: string required: - dosage - meal - timeOfReading MedicationNotesResponseDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/MedicationReasonUpdatedResponseDRF' MedicationReasonUpdatedDRF: type: object properties: reason: type: string clinicianId: type: string clinicianName: type: string required: - reason MedicationReasonUpdatedResponseDRF: type: object properties: reason: type: string clinicianId: type: string clinicianName: type: string createDateTime: type: string format: date-time required: - reason MedicationScheduleDRF: type: object properties: id: type: string frequency: type: integer period: type: integer periodUnit: type: string required: - frequency - periodUnit MedicationScheduleEventDRF: type: object properties: id: type: string userId: type: string title: type: string description: type: string model: type: string isRecurring: type: boolean instanceExpiresIn: type: string startDateTime: type: string endDateTime: type: string enabled: type: boolean extraFields: type: object additionalProperties: {} parentId: type: string snoozing: type: array items: type: string hasCustomSchedule: type: boolean isSilent: type: boolean updateDateTime: type: string createDateTime: type: string completeDateTime: type: string medication: $ref: '#/components/schemas/MedicationV2DTODRF' localTime: type: string meal: type: string source: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' medicatedDateTimeSlots: type: array items: type: string format: date-time status: type: string logsCount: type: integer medicationIds: type: array items: type: string required: - medication - model MedicationTrackerResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' MedicationV2DTODRF: type: object properties: id: type: string enabled: type: boolean userId: type: string deploymentId: type: string moduleId: type: string moduleConfigId: type: string name: type: string coding: type: array items: $ref: '#/components/schemas/CodingDRF' dosage: type: number format: double unit: type: string customUnit: type: string indication: $ref: '#/components/schemas/IndicationDRF' isNotificationEnabled: type: boolean maxDosage: type: number format: double schedule: $ref: '#/components/schemas/MedicationV2ScheduleDRF' adherence: $ref: '#/components/schemas/AdherenceDRF' adherences: type: array items: $ref: '#/components/schemas/AdherenceDRF' submitterId: type: string reason: $ref: '#/components/schemas/MedicationReasonUpdatedDRF' submitterUserType: type: string startDate: type: string format: date-time endDate: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time additionalFields: $ref: '#/components/schemas/AdditionalFieldsDRF' mealSchedule: type: array items: $ref: '#/components/schemas/MedicationMealScheduleDRF' connectedModules: type: array items: type: string groupId: type: string MedicationV2ScheduleDRF: type: object properties: isoDuration: type: string timesOfReadings: type: array items: type: string timeRanges: type: array items: $ref: '#/components/schemas/TimeDurationDRF' specificWeekDays: type: array items: type: string asNeeded: type: boolean MedicationsAutocompleteResponseDRF: type: object properties: limit: type: integer skip: type: integer values: type: array items: type: string required: - limit - skip - values MedicationsV2AutocompleteResponseDRF: type: object properties: limit: type: integer skip: type: integer values: type: array items: type: string required: - limit - skip - values MessageAttachmentDTODRF: type: object properties: id: type: string attachmentType: type: string title: type: string resource: type: string resourceUrl: type: string isResourceDeleted: type: boolean createDateTime: type: string format: date-time required: - attachmentType - resource - title MessageDTODRF: type: object properties: id: type: string userId: type: string submitterId: type: string submitterName: type: string text: type: string status: type: string createDateTime: type: string format: date-time updateDateTime: type: string format: date-time custom: type: boolean locale: type: string messageType: type: string attachments: type: array items: $ref: '#/components/schemas/MessageAttachmentDTODRF' required: - submitterId MessageSearchRequestObjectDRF: type: object properties: submitterId: type: string custom: type: boolean skip: type: integer limit: type: integer userId: type: string required: - submitterId MessageSendRequestObjectDRF: type: object properties: messageType: type: string text: type: string custom: type: boolean userId: type: string attachments: type: array items: $ref: '#/components/schemas/MessageAttachmentDTODRF' MessageSummaryResponseObjectDRF: type: object properties: messages: type: array items: type: object additionalProperties: {} unreadMessages: type: integer MessagesResponseObjectDRF: type: object properties: messages: type: array items: $ref: '#/components/schemas/MessageDTODRF' required: - messages MessagingDRF: type: object properties: enabled: type: boolean twoWayMessaging: type: boolean messages: type: array items: type: string allowCustomMessage: type: boolean LocalizableFields: type: array items: type: string title: ' localizablefields' MockADPCyclerDataRequestObjectDRF: type: object properties: userId: type: string cycle: type: integer ModuleConfigDRF: type: object properties: id: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time moduleId: type: string moduleName: type: string shortModuleName: type: string status: type: string order: type: integer configBody: type: object additionalProperties: {} about: type: string footnote: $ref: '#/components/schemas/FootnoteDRF' schedule: $ref: '#/components/schemas/ModuleScheduleDRF' ragThresholds: type: array items: $ref: '#/components/schemas/RagThresholdDRF' learnArticleIds: type: array items: type: string learnArticles: type: array items: type: object additionalProperties: {} version: type: integer staticEvent: $ref: '#/components/schemas/StaticEventDRF' notificationData: $ref: '#/components/schemas/NotificationDataDRF' localizationPrefix: type: string goal: $ref: '#/components/schemas/ModuleGoalDTODRF' goalEnabled: type: boolean feedback: $ref: '#/components/schemas/FeedbackConfigDRF' feedbackTexts: type: array items: $ref: '#/components/schemas/FeedbackTextsDRF' readOnly: type: boolean LocalizableFields: type: array items: type: string title: ' localizablefields' required: - moduleId ModuleFeedbackDRF: type: object properties: criteria: type: object additionalProperties: {} text: $ref: '#/components/schemas/FeedbackTextDRF' moduleData: type: object additionalProperties: {} language: type: string notificationData: $ref: '#/components/schemas/FeedbackNotificationDataDRF' ModuleGoalCreatedByDRF: type: object properties: creatorId: type: string creatorName: type: string ModuleGoalDTODRF: type: object properties: values: type: array items: type: object additionalProperties: {} notes: type: string completed: type: boolean dateOfCompletion: type: string format: date-time createdBy: $ref: '#/components/schemas/ModuleGoalCreatedByDRF' createDateTime: type: string format: date-time seenByApp: type: boolean seenByCPAfterCompletion: type: boolean achieveNotificationSent: type: boolean ModuleRatingDTODRF: type: object properties: id: type: string userId: type: string deploymentId: type: string createDateTime: type: string format: date-time updateDateTime: type: string format: date-time rating: type: string moduleId: type: string moduleResultId: type: string required: - moduleId - moduleResultId - rating - userId ModuleResultSignRequestObjectDRF: type: object properties: type: type: string ids: type: array items: type: string moduleId: type: string userId: type: string required: - ids - type ModuleResultUnSignRequestObjectDRF: type: object properties: type: type: string ids: type: array items: type: string moduleId: type: string userId: type: string required: - ids - type ModuleResultsByDateDRF: type: object properties: day: type: string format: date-time results: $ref: '#/components/schemas/ResultsDRF' ModuleScheduleDRF: type: object properties: isoDuration: type: string timesPerDuration: type: integer friendlyText: type: string timesOfDay: type: array items: type: string timesOfReadings: type: array items: type: string specificWeekDays: type: array items: type: string ModuleSchemaDRF: type: object properties: moduleId: type: string primitiveIds: type: array items: type: string MoveDeploymentsRequestObjectBodyDRF: type: object properties: deploymentIds: type: array items: type: string sourceOrganizationId: type: string targetOrganizationId: type: string required: - deploymentIds - sourceOrganizationId - targetOrganizationId MoveUserDetailsDRF: type: object properties: reason: type: string situation: type: string background: type: string assessment: type: string message: type: string recommendation: type: string required: - assessment - background - message - reason - situation MoveUserReasonsDRF: type: object properties: reasons: type: array items: $ref: '#/components/schemas/ReasonDRF' otherReason: type: boolean MoveUserRequestDataDRF: type: object properties: details: $ref: '#/components/schemas/MoveUserDetailsDRF' required: - details MoveWidgetRequestObjectDRF: type: object properties: widgetId: type: string sourceTabId: type: string targetTabId: type: string required: - sourceTabId - targetTabId - widgetId MovedUserDRF: type: object properties: id: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time lastSubmitDateTime: type: string format: date-time givenName: type: string familyName: type: string gender: type: string biologicalSex: type: string ethnicity: type: string dateOfBirth: type: string format: date-time email: type: string calendarLink: type: string phoneNumber: type: string primaryAddress: type: string race: type: string bloodGroup: type: string emergencyPhoneNumber: type: string height: type: number format: double additionalContactDetails: $ref: '#/components/schemas/AdditionalContactDetailsDRF' familyMedicalHistory: type: string pastHistory: type: string presentSymptoms: type: string operationHistory: type: string chronicIllness: type: string allergyHistory: type: string pregnancy: type: string dateOfLastPhysicalExam: type: string format: date-time extraCustomFields: type: object additionalProperties: {} surgeryDetails: $ref: '#/components/schemas/UserSurgeryDetailsDRF' fenlandCohortId: type: string nhsId: type: string insuranceNumber: type: string wechatId: type: string kardiaId: type: string pamThirdPartyIdentifier: type: string medicalRecordNumber: type: string roles: type: array items: $ref: '#/components/schemas/RoleAssignmentDTODRF' timezone: type: string recentModuleResults: type: object additionalProperties: {} tags: type: object additionalProperties: {} labels: type: array items: $ref: '#/components/schemas/UserLabelDRF' tagsAuthorId: type: string surgeryDateTime: type: string format: date-time preferences: type: object additionalProperties: {} preferredUnits: type: object additionalProperties: {} addressComponent: $ref: '#/components/schemas/AddressObjectDRF' personalDocuments: type: array items: $ref: '#/components/schemas/PersonalDocumentDRF' enrollmentId: type: integer enrollmentNumber: type: string deployments: type: array items: type: string deploymentsInfo: type: array items: $ref: '#/components/schemas/DeploymentInfoDRF' boardingStatus: $ref: '#/components/schemas/BoardingStatusDRF' language: type: string finishedOnboarding: type: boolean stats: $ref: '#/components/schemas/UserStatsDRF' ragScore: type: array items: type: integer flags: $ref: '#/components/schemas/UnseenFlagsDRF' unseenFlags: $ref: '#/components/schemas/UnseenFlagsDRF' recentFlags: $ref: '#/components/schemas/RecentFlagsDRF' lastLoginDateTime: type: string format: date-time badges: type: object additionalProperties: {} onboardingConfigs: type: array items: $ref: '#/components/schemas/OnboardingModuleConfigDTODRF' researchTeamActions: $ref: '#/components/schemas/ResearchTeamActionsDRF' hasAssignedManagers: type: boolean componentsData: type: object additionalProperties: {} contactEmail: type: string assignedManagers: type: array items: type: string assignedProxies: type: array items: type: object additionalProperties: {} assignedParticipants: type: array items: type: object additionalProperties: {} assignedUsersCount: type: integer proxyStatus: type: string status: type: string ragThresholds: type: object additionalProperties: {} intercomHash: type: string managerNotifications: $ref: '#/components/schemas/ManagerNotificationsDRF' profilePicture: $ref: '#/components/schemas/FileFieldDRF' createdByManager: type: boolean unreadMessagesCount: $ref: '#/components/schemas/UnreadMessagesCountDRF' userId: type: string moveHistory: $ref: '#/components/schemas/UserMoveHistoryDTODRF' MultiResourceDashboardDataRequestObjectDRF: type: object properties: dataType: type: string organizationIds: type: array items: type: string startDate: type: string format: date-time endDate: type: string format: date-time required: - dataType - organizationIds MultipleAnswerConfigDRF: type: object properties: enabled: type: boolean maxAnswers: type: integer minAnswers: type: integer MultipleHourValuesDataDRF: type: object properties: id: type: string p: type: object additionalProperties: {} d: type: string format: date-time h: type: object additionalProperties: {} MultipleValuesDataDRF: type: object properties: id: type: string p: type: object additionalProperties: {} d: type: string format: date-time NDIDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer required: - deploymentId - deviceName - moduleId - userId - value NDIResultsDRF: type: object properties: NDI: type: array items: $ref: '#/components/schemas/NDIDTODRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' NDayAverageDRF: type: object properties: days: type: integer value: type: integer required: - days - value NORFOLKDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string totalQolScore: type: number format: double physicalFunctionLargeFiber: type: number format: double activitiesOfDailyLiving: type: number format: double symptoms: type: number format: double smallFiber: type: number format: double automic: type: number format: double required: - activitiesOfDailyLiving - automic - deploymentId - deviceName - moduleId - physicalFunctionLargeFiber - smallFiber - symptoms - totalQolScore - userId NORFOLKResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' NORFOLK: type: array items: $ref: '#/components/schemas/NORFOLKDTODRF' NamedVersionDRF: type: object properties: server: type: string api: type: string build: type: string repoName: type: string required: - api - repoName - server NodeConvertibleDRF: type: object properties: name: type: string parameters: type: array items: type: string output: type: array items: type: string isTrigger: type: boolean description: type: string required: - name - output - parameters NotificationDataDRF: type: object properties: title: type: string body: type: string offline: type: boolean LocalizableFields: type: array items: type: string title: ' localizablefields' NumericMemoryDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer required: - deploymentId - deviceName - moduleId - userId - value OACSDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string oacsScore: type: number format: double required: - deploymentId - deviceName - moduleId - oacsScore - userId OACSResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' OACS: type: array items: $ref: '#/components/schemas/OACSDTODRF' OARSDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string painScore: type: number format: double sleepScore: type: number format: double nauseaScore: type: number format: double mobilityScore: type: number format: double oarsScore: type: number format: double required: - deploymentId - deviceName - mobilityScore - moduleId - nauseaScore - oarsScore - painScore - sleepScore - userId OARSResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' OARS: type: array items: $ref: '#/components/schemas/OARSDTODRF' ODIDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer required: - deploymentId - deviceName - moduleId - userId - value ODIResultsDRF: type: object properties: ODI: type: array items: $ref: '#/components/schemas/ODIDTODRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' OMSWidgetResponseDRF: type: object properties: products: type: array items: $ref: '#/components/schemas/ProductDTODRF' orders: type: array items: $ref: '#/components/schemas/OrderDTODRF' OffBoardUsersRequestDataDRF: type: object properties: userIds: type: array items: type: string detailsOffBoarded: type: string required: - detailsOffBoarded - userIds OffBoardingReasonsDRF: type: object properties: reasons: type: array items: $ref: '#/components/schemas/ReasonDRF' otherReason: type: boolean OffboardUsersResponseDRF: type: object properties: offboardedUsers: type: integer OfflineVideoCallDTODRF: type: object properties: id: type: string managerId: type: string userId: type: string duration: type: integer startDateTime: type: string format: date-time endDateTime: type: string format: date-time updateDateTime: type: string format: date-time createDateTime: type: string format: date-time roomStatus: type: string logs: type: array items: $ref: '#/components/schemas/VideoCallLogDTODRF' appointmentId: type: string noteId: type: string type: type: string status: type: string roomId: type: string managerName: type: string OkResponseDRF: type: object properties: ok: type: boolean OnboardingItemDRF: type: object properties: onboardingId: type: string order: type: integer completed: type: boolean configBody: type: object additionalProperties: {} required: - completed - onboardingId - order OnboardingModuleConfigDTODRF: type: object properties: id: type: string onboardingId: type: string preloadNeeded: type: boolean status: type: string configBody: type: object additionalProperties: {} order: type: integer version: type: integer versionString: type: string userTypes: type: array items: type: string organizationId: type: string reason: type: string deploymentIds: type: array items: type: string versionInt: type: object additionalProperties: {} updateDateTime: type: string format: date-time createDateTime: type: string format: date-time required: - onboardingId - order 'One Of: CreateHeartRateDRFSerializer, CreateFitbitHRVDRFSerializer, CreateHRVDRF': oneOf: - $ref: '#/components/schemas/CreateHeartRateDRF' - $ref: '#/components/schemas/CreateFitbitHRVDRF' - $ref: '#/components/schemas/CreateHRVDRF' OptionDRF: type: object properties: codeName: type: string label: type: string value: type: string weight: type: integer visibility: type: array items: $ref: '#/components/schemas/LimitationDRF' restrictions: type: array items: $ref: '#/components/schemas/LimitationDRF' triageLevel: type: integer selected: type: boolean required: - codeName - label - value OrderDTODRF: type: object properties: id: type: string userId: type: string cart: type: array items: $ref: '#/components/schemas/OrderItemDRF' status: type: string createDateTime: type: string format: date-time updateDateTime: type: string format: date-time required: - cart - createDateTime - status - updateDateTime - userId OrderItemDRF: type: object properties: productId: type: string quantity: type: integer sku: type: string title: type: string image: type: string required: - productId - quantity - sku OrderUpdateObjectDRF: type: object properties: id: type: string order: type: integer required: - id - order OrgInfoDRF: type: object properties: id: type: string name: type: string OrganizationAPISecretDTODRF: type: object properties: value: type: string organizationId: type: string createDateTime: type: string format: date-time required: - createDateTime - organizationId - value OrganizationDTODRF: type: object properties: termAndConditionUrl: type: string privacyPolicyUrl: type: string eulaUrl: type: string privacyPolicyObject: $ref: '#/components/schemas/S3ObjectDRF' termAndConditionObject: $ref: '#/components/schemas/S3ObjectDRF' eulaObject: $ref: '#/components/schemas/S3ObjectDRF' authorisedRep: $ref: '#/components/schemas/AuthorisedRepDRF' roles: type: array items: $ref: '#/components/schemas/RoleDTODRF' id: type: string name: type: string status: type: string deploymentIds: type: array items: type: string enrollmentTarget: type: integer studyCompletionTarget: type: integer updateDateTime: type: string format: date-time createDateTime: type: string format: date-time viewType: type: string targetConsented: type: integer dashboardId: type: string features: $ref: '#/components/schemas/FeaturesDRF' intercom: $ref: '#/components/schemas/IntercomSettingsDRF' security: type: object additionalProperties: {} pluginConfigContainerId: type: string sso: $ref: '#/components/schemas/SsoDRF' OrganizationRoleUpdateRequestBodyDRF: type: object properties: roles: type: array items: $ref: '#/components/schemas/RoleDTODRF' required: - roles OrganizationWithExtrasDRF: type: object properties: termAndConditionUrl: type: string privacyPolicyUrl: type: string eulaUrl: type: string privacyPolicyObject: $ref: '#/components/schemas/S3ObjectDRF' termAndConditionObject: $ref: '#/components/schemas/S3ObjectDRF' eulaObject: $ref: '#/components/schemas/S3ObjectDRF' authorisedRep: $ref: '#/components/schemas/AuthorisedRepDRF' roles: type: array items: $ref: '#/components/schemas/RoleDTODRF' id: type: string name: type: string status: type: string deploymentIds: type: array items: type: string enrollmentTarget: type: integer studyCompletionTarget: type: integer updateDateTime: type: string format: date-time createDateTime: type: string format: date-time viewType: type: string targetConsented: type: integer dashboardId: type: string features: $ref: '#/components/schemas/FeaturesDRF' intercom: $ref: '#/components/schemas/IntercomSettingsDRF' security: type: object additionalProperties: {} pluginConfigContainerId: type: string sso: $ref: '#/components/schemas/SsoDRF' deployments: type: array items: $ref: '#/components/schemas/DeploymentInfoDRF' plugins: type: object additionalProperties: {} OtherCovidSymptomsItemDRF: type: object properties: name: type: string intensity: type: integer persistPostInfection: type: string required: - intensity - name - persistPostInfection OtherVaccCategoryItemDRF: type: object properties: name: type: string vaccDate: type: string format: date-time required: - vaccDate OtherVaccineDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string hasFluVaccine: type: boolean fluVaccineDate: type: string format: date-time hasOtherVaccine: type: boolean vaccineCategory: type: array items: type: string vaccineList: type: array items: $ref: '#/components/schemas/VaccineListItemDRF' metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - deploymentId - deviceName - hasFluVaccine - hasOtherVaccine - metadata - moduleId - userId OtherVaccineResultsDRF: type: object properties: OtherVaccine: type: array items: $ref: '#/components/schemas/OtherVaccineDTODRF' OutboundDRF: type: object properties: topic: type: string eventTypes: type: array items: type: string extraArgs: type: object additionalProperties: {} required: - topic OverviewChartDataDRF: type: object properties: skip: type: integer limit: type: integer moduleResults: type: array items: $ref: '#/components/schemas/ModuleResultsByDateDRF' notes: type: array items: $ref: '#/components/schemas/UserNoteDTODRF' OverviewChartRequestObjectDRF: type: object properties: skip: type: integer limit: type: integer direction: type: string fromDateTime: type: string format: date-time toDateTime: type: string format: date-time filters: type: object additionalProperties: {} userId: type: string deploymentId: type: string role: type: string status: type: string useCreateDateTime: type: boolean dataType: type: string moduleNames: type: array items: type: string required: - dataType OxfordHipScoreDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string hipAffected: type: string hipsData: type: array items: $ref: '#/components/schemas/HipDataDRF' rightHipScore: type: integer leftHipScore: type: integer required: - deploymentId - deviceName - hipAffected - hipsData - moduleId - userId OxfordHipScoreResultsDRF: type: object properties: OxfordHipScore: type: array items: $ref: '#/components/schemas/OxfordHipScoreDTODRF' OxfordKneeScoreDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string legAffected: type: string legsData: type: array items: $ref: '#/components/schemas/LegDataDRF' rightKneeScore: type: integer leftKneeScore: type: integer required: - deploymentId - deviceName - legAffected - legsData - moduleId - userId OxfordKneeScoreResultsDRF: type: object properties: OxfordKneeScore: type: array items: $ref: '#/components/schemas/OxfordKneeScoreDTODRF' OxfordShoulderScoreDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string shoulderAffected: type: string shouldersData: type: array items: $ref: '#/components/schemas/ShoulderDataDRF' rightShoulderScore: type: integer leftShoulderScore: type: integer required: - deploymentId - deviceName - moduleId - shoulderAffected - shouldersData - userId OxfordShoulderScoreResultsDRF: type: object properties: OxfordShoulderScore: type: array items: $ref: '#/components/schemas/OxfordShoulderScoreDTODRF' OxygenSaturationDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double valueUnit: type: string originalValue: type: number format: double oxygenSupplement: $ref: '#/components/schemas/OxygenSupplementDRF' required: - deploymentId - deviceName - moduleId - userId - value OxygenSaturationResultsDRF: type: object properties: OxygenSaturation: type: array items: $ref: '#/components/schemas/OxygenSaturationDTODRF' OxygenSupplementDRF: type: object properties: value: type: number format: double startDateTime: type: string format: date-time endDateTime: type: string format: date-time PAMIntegrationConfigDRF: type: object properties: submitSurveyURI: type: string enrollUserURI: type: string clientExtID: type: string clientPassKeyEncrypted: type: string subgroupExtID: type: string required: - clientExtID - clientPassKeyEncrypted - enrollUserURI - subgroupExtID - submitSurveyURI PROMISGlobalHealthDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string global01: type: string global02: type: string global03: type: string global04: type: string global05: type: string global06: type: string global07rc: type: integer global08r: type: string global09r: type: string global10r: type: string mentalHealthValue: type: number format: double mentalHealthResult: $ref: '#/components/schemas/QuestionnaireAppResultDRF' physicalHealthValue: type: number format: double physicalHealthResult: $ref: '#/components/schemas/QuestionnaireAppResultDRF' metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - deploymentId - deviceName - global01 - global02 - global03 - global04 - global05 - global06 - global07rc - global08r - global09r - global10r - metadata - moduleId - userId PROMISGlobalHealthResultsDRF: type: object properties: PROMISGlobalHealth: type: array items: $ref: '#/components/schemas/PROMISGlobalHealthDTODRF' PaginatedRequestBodyDRF: type: object properties: skip: type: integer limit: type: integer PassedDueDateEventsAmountDRF: type: object properties: endDateTime: type: string format: date-time amount: type: integer PatchedChargeUnitRecordRequestObjectDRF: type: object properties: code: type: string units: type: integer dateOfService: type: string format: date-time extraDetails: type: string dependentUnitId: type: string PatchedUpdateBillingRecordRequestObjectDRF: type: object properties: deploymentId: type: string patientId: type: string provider: type: string diagnosisType: type: string deviceConnectionDate: type: string format: date-time primaryInsurance: type: string workFlow: type: string reportEndDate: type: string format: date-time isEligible: type: boolean monitoringMinutes: type: integer numberOfCalls: type: integer monthReading: type: integer consentDate: type: string format: date-time consentId: type: string deviceType: type: string deviceModel: type: string charges: type: array items: $ref: '#/components/schemas/ChargeUnitRecordRequestObjectDRF' id: type: string PatchedUpdateIsSubmittedRequestObjectDRF: type: object properties: id: type: string isSubmitted: type: boolean PatientInfoObjectDRF: type: object properties: id: type: string givenName: type: string familyName: type: string dateOfBirth: type: string required: - dateOfBirth - familyName - givenName PatientPersonalizationDRF: type: object properties: rag: type: boolean goal: type: boolean PatientRecordingDRF: type: object properties: id: type: string patientID: type: string heartRate: type: integer duration: type: integer recordedAt: type: string algorithmDetermination: type: string note: type: string PatientRecordingPageInfoDRF: type: object properties: startCursor: type: string endCursor: type: string hasNextPage: type: boolean PatientsResponseObjectDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/PatientInfoObjectDRF' total: type: integer skip: type: integer limit: type: integer allPatientsCount: type: integer required: - items PeakFlowDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer valuePercent: type: number format: double valueUnit: type: string required: - deploymentId - deviceName - moduleId - userId - value PeakFlowResultsDRF: type: object properties: PeakFlow: type: array items: $ref: '#/components/schemas/PeakFlowDTODRF' PerceivedStressScaleDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer required: - deploymentId - deviceName - moduleId - userId - value PerceivedStressScaleResultsDRF: type: object properties: PerceivedStressScale: type: array items: $ref: '#/components/schemas/PerceivedStressScaleDTODRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' PerformanceMonitoringOverviewResponseRowObjectDRF: type: object properties: clientId: type: string clientName: type: string status: type: string billableCapturePercent: type: integer billableCaptureCount: type: integer noMonitorNoCallCount: type: integer monitoredNoCallCount: type: integer noMonitorCalledCount: type: integer monitoredCalledCount: type: integer nonCompliantCount: type: integer PerformanceOverviewResponseObjectDRF: type: object properties: limit: type: integer skip: type: integer total: type: integer itemsReading: type: array items: $ref: '#/components/schemas/PerformanceReadingOverviewResponseRowObjectDRF' itemsMonitoring: type: array items: $ref: '#/components/schemas/PerformanceMonitoringOverviewResponseRowObjectDRF' PerformanceReadingOverviewResponseRowObjectDRF: type: object properties: clientId: type: string clientName: type: string status: type: string billableCapturePercent: type: integer noReadingCount: type: integer reading1to4Count: type: integer reading5to8Count: type: integer reading9to15Count: type: integer reading16PlusCount: type: integer nonCompliantCount: type: integer PeriodProgressDRF: type: object properties: taskCompliance: type: number format: double startDateTime: type: string format: date-time openQueriesAmount: type: integer passedDueDateFormsAmount: type: integer passedDatesCounter: type: array items: $ref: '#/components/schemas/PassedDueDateEventsAmountDRF' PeriodProgressResponseDRF: type: object properties: taskCompliance: type: number format: double startDateTime: type: string format: date-time openQueriesAmount: type: integer passedDueDateFormsAmount: type: integer PersonalDocumentDRF: type: object properties: id: type: string name: type: string fileType: type: string fileObject: $ref: '#/components/schemas/S3ObjectDRF' createDateTime: type: string format: date-time updateDateTime: type: string format: date-time required: - fileObject - fileType - name PhotoDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string s3Object: $ref: '#/components/schemas/S3ObjectDRF' s3Thumbnail: $ref: '#/components/schemas/S3ObjectDRF' note: type: string required: - deploymentId - deviceName - moduleId - s3Object - userId PhotoResultsDRF: type: object properties: Photo: type: array items: $ref: '#/components/schemas/PhotoDTODRF' PointDataFieldDRF: type: object properties: latitude: type: string format: decimal pattern: ^-?\d{0,15}(?:\.\d{0,4})?$ longitude: type: string format: decimal pattern: ^-?\d{0,15}(?:\.\d{0,4})?$ altitude: type: string format: decimal pattern: ^-?\d{0,15}(?:\.\d{0,4})?$ samplingDateTime: type: string format: date-time required: - latitude - longitude - samplingDateTime PollenDataDRF: type: object properties: date: type: string types: type: object additionalProperties: {} required: - date PostVaccinationDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string secondCOVIDVaccinationDose: type: string format: date-time isSecondDoseAZ: type: boolean secondDoseBrand: type: string batchNumberVaccine: type: string isBatchNumberValid: type: boolean isSamePlaceVaccine2As1: type: boolean vaccinationPlace: type: string vaccinationPlaceOther: type: string vaccinationPlaceLocation: type: string metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - deploymentId - deviceName - isSamePlaceVaccine2As1 - isSecondDoseAZ - metadata - moduleId - secondCOVIDVaccinationDose - userId PostVaccinationResultsDRF: type: object properties: PostVaccination: type: array items: $ref: '#/components/schemas/PostVaccinationDTODRF' PreEclampsiaRiskResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' PregnancyFollowUpDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string pregnantMedications: type: boolean prescriptionMedications: type: array items: type: string overCounterPregnantMedications: type: boolean overCounterMedications: type: array items: type: string babyCount: type: string currentBabyCount: type: integer babyInfo: type: array items: $ref: '#/components/schemas/BabyInfoDRF' metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - babyCount - babyInfo - deploymentId - deviceName - metadata - moduleId - overCounterPregnantMedications - pregnantMedications - userId PregnancyFollowUpResultsDRF: type: object properties: PregnancyFollowUp: type: array items: $ref: '#/components/schemas/PregnancyFollowUpDTODRF' PregnancyStatusDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string menstrualPeriod: type: boolean lastMenstrualPeriodDate: type: string format: date-time pregnancyStatus: type: string isExpectedDueDateAvailable: type: boolean expectedDueDate: type: string format: date-time pregnancyMoreThan1: type: string babyCount: type: integer hasMedicalFertilityProcedure: type: boolean medicalFertilityProcedureAnswer: type: array items: type: string hasOtherMedicalFertilityProcedure: type: boolean otherMedicalFertilityProcedureAnswer: type: string pregnantBefore: type: string pregnancyTimes: type: integer pastPregnancyLiveBirth: type: integer pastPregnancyStillBorn: type: integer pastPregnancyMiscarriage: type: integer pastPregnancyEctopic: type: integer pastPregnancyElectiveTermination: type: integer hasMedicalProfessionalVisit: type: boolean highRiskCondition: type: string highRiskConditionAnswers: type: array items: type: string familyHistoryDefects: type: string familyHistoryDefectsAnswers: type: array items: type: string hasPrenatalScreening: type: boolean prenatalScreeningAnswer: type: array items: type: string hasOtherPrenatalScreening: type: boolean otherPrenatalScreening: type: string hasOtherScreeningProblem: type: boolean otherScreeningProblem: type: string metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - deploymentId - deviceName - menstrualPeriod - metadata - moduleId - userId PregnancyStatusResultsDRF: type: object properties: PregnancyStatus: type: array items: $ref: '#/components/schemas/PregnancyStatusDTODRF' PregnancyUpdateDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string hasMenstrualPeriod: type: boolean lastMenstrualPeriodDateDay1: type: string format: date-time becamePregnant: type: boolean isPregnancyCurrent: type: boolean isExpectedDueDateAvailable: type: boolean expectedDueDate: type: string format: date-time pregnancyMoreThan1: type: string babyCount: type: integer pastPregnancyMoreThan1: type: string pastBabyCount: type: integer pregnancyResult: type: array items: type: string hasOtherPregnancyOutcome: type: boolean otherPregnancyResult: type: array items: type: string pastPregnancyWeeks: type: integer hasPastPregnancy: type: string pregnancyTimes: type: integer pastPregnancyLifeBirth: type: integer pastPregnancyStillBorn: type: integer pastPregnancyEctopic: type: integer pastPregnancyMiscarriage: type: integer pastPregnancyElectiveTermination: type: integer hasVisitMedicalProfessional: type: boolean highRiskCondition: type: string highRiskConditionAnswers: type: array items: type: string familyHistoryDefects: type: string familyHistoryDefectsAnswers: type: array items: type: string hasPrenatalScreening: type: boolean prenatalScreeningAnswers: type: array items: type: string hasOtherPrenatalScreening: type: boolean otherPrenatalScreening: type: string hasScreeningProblem: type: boolean screeningProblemText: type: string metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - deploymentId - deviceName - hasMenstrualPeriod - metadata - moduleId - userId PregnancyUpdateResultsDRF: type: object properties: PregnancyUpdate: type: array items: $ref: '#/components/schemas/PregnancyUpdateDTODRF' PrescriptionDTODRF: type: object properties: id: type: string userId: type: string carePlanId: type: string name: type: string dosage: type: string unit: type: string frequency: type: string startTime: type: string endTime: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time required: - carePlanId - dosage - frequency - name - startTime - unit - userId PrescriptionsResponseObjectDRF: type: object properties: prescriptions: type: array items: $ref: '#/components/schemas/PrescriptionDTODRF' PrimaryStepViewDRF: type: object properties: value: type: string unit: type: string startDateTime: type: string ProcessAudioResultRequestBodyDRF: type: object properties: moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string audioResult: $ref: '#/components/schemas/S3ObjectDRF' initialWords: type: array items: type: string required: - audioResult - deploymentId - deviceName - initialWords ProductDTODRF: type: object properties: id: type: string title: type: string image: type: string sku: type: string required: - image - sku - title ProductsResponseDRF: type: object properties: products: type: array items: $ref: '#/components/schemas/ProductDTODRF' ProfileDRF: type: object properties: fields: $ref: '#/components/schemas/ProfileFieldsDRF' clinicianOnlyFields: $ref: '#/components/schemas/ClinicianOnlyFieldsDRF' LocalizableFields: type: array items: type: string title: ' localizablefields' ProfileExtraIdsDRF: type: object properties: fenlandCohortId: type: boolean nhsId: type: boolean insuranceNumber: type: boolean wechatId: type: boolean aliveCorId: type: boolean medicalRecordNumber: type: boolean mandatoryOnboardingIds: type: array items: type: string unEditableIds: type: array items: type: string ProfileFieldsDRF: type: object properties: givenName: type: boolean familyName: type: boolean dateOfBirth: type: boolean height: type: boolean gender: type: boolean biologicalSex: type: boolean race: type: boolean ethnicity: type: boolean ethnicityOptions: type: array items: $ref: '#/components/schemas/EthnicityOptionDRF' additionalContactDetails: $ref: '#/components/schemas/AdditionalContactDetailsItemDRF' mandatoryOnboardingFields: type: array items: type: string extraIds: $ref: '#/components/schemas/ProfileExtraIdsDRF' genderOptions: type: array items: $ref: '#/components/schemas/GenderOptionTypeDRF' bloodGroup: type: boolean phoneNumber: type: boolean email: type: boolean primaryAddress: type: boolean emergencyPhoneNumber: type: boolean familyMedicalHistory: type: boolean pastHistory: type: boolean presentSymptoms: type: boolean operationHistory: type: boolean chronicIllness: type: boolean allergyHistory: type: boolean pregnancy: type: boolean dateOfLastPhysicalExam: type: boolean unEditableFields: type: array items: type: string validators: type: object additionalProperties: {} ordering: type: array items: type: string LocalizableFields: type: array items: type: string title: ' localizablefields' ExcludedFromOrderingFields: type: array items: type: string title: ' excluded from ordering fields' ProfileIdentifiersResponseObjectDRF: type: object properties: userId: type: string deploymentId: type: string required: - deploymentId - userId ProxyDataDRF: type: object properties: givenName: type: string familyName: type: string phoneNumber: type: string email: type: string PtosisDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string recording: $ref: '#/components/schemas/S3ObjectDRF' severityLeft: type: integer severityRight: type: integer timeLeft: type: integer timeRight: type: integer isPrompted: type: boolean required: - deploymentId - deviceName - moduleId - recording - userId PtosisQualityCheckRequestObjectDRF: type: object properties: image: $ref: '#/components/schemas/S3ObjectDRF' language: type: string userId: type: string required: - image PtosisResultsDRF: type: object properties: Ptosis: type: array items: $ref: '#/components/schemas/PtosisDTODRF' PublicContentSearchResponseObjectDRF: type: object properties: total: type: integer limit: type: integer skip: type: integer items: type: array items: type: string PublishDeploymentRequestBodyDRF: type: object properties: name: type: string PulseOximetryDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double required: - deploymentId - deviceName - moduleId - userId - value PulseOximetryResultsDRF: type: object properties: PulseOximetry: type: array items: $ref: '#/components/schemas/PulseOximetryDTODRF' QualityCheckErrorResponseObjectDRF: type: object properties: error: type: string required: - error QualityCheckRequestObjectDRF: type: object properties: arm: type: string image: $ref: '#/components/schemas/S3ObjectDRF' language: type: string userId: type: string required: - arm - image QuestionLogicDRF: type: object properties: isEnabled: type: boolean QuestionResponseObjectDRF: type: object properties: id: type: string codeName: type: string format: type: string selectionCriteria: type: string required: type: boolean text: type: string additionalTexts: type: object additionalProperties: {} visibility: type: array items: $ref: '#/components/schemas/LimitationDRF' restrictions: type: array items: $ref: '#/components/schemas/LimitationDRF' options: type: array items: $ref: '#/components/schemas/OptionDRF' mediaType: type: array items: type: string multipleAnswers: $ref: '#/components/schemas/MultipleAnswerConfigDRF' logic: $ref: '#/components/schemas/QuestionLogicDRF' extra: type: object additionalProperties: {} questionnaireId: type: string responseId: type: string required: - codeName - questionnaireId - responseId QuestionnaireAnswerDRF: type: object properties: id: type: string answerText: type: string answersList: type: array items: type: string filesList: type: array items: $ref: '#/components/schemas/QuestionnaireAnswerMediaFileDRF' otherText: type: string value: type: string compositeAnswer: type: object additionalProperties: {} answerScore: type: integer questionId: type: string question: type: string format: type: string choices: type: array items: type: string selectedChoices: type: array items: type: string otherSelectedChoices: type: array items: type: string selectionCriteria: type: string lowerBound: type: number format: double upperBound: type: number format: double lists: type: array items: type: string units: type: array items: type: string selectedUnit: type: string recalledText: type: array items: type: string options: type: array items: type: object additionalProperties: {} required: - question QuestionnaireAnswerMediaFileDRF: type: object properties: file: type: string thumbnail: type: string mediaType: type: string required: - file - mediaType QuestionnaireAppResultDRF: type: object properties: appType: type: string values: type: array items: $ref: '#/components/schemas/QuestionnaireAppResultValueDRF' required: - appType - values QuestionnaireAppResultValueDRF: type: object properties: label: type: string valueType: type: string valueFloat: type: number format: double required: - label - valueFloat - valueType QuestionnaireDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string answers: type: array items: $ref: '#/components/schemas/QuestionnaireAnswerDRF' appResult: $ref: '#/components/schemas/QuestionnaireAppResultDRF' isForManager: type: boolean questionnaireId: type: string questionnaireName: type: string value: type: number format: double skipped: type: array items: $ref: '#/components/schemas/QuestionnaireAnswerDRF' updateDateTime: type: string format: date-time signOffDateTime: type: string format: date-time status: type: string revision: type: integer required: - answers - deploymentId - deviceName - moduleId - questionnaireId - questionnaireName - userId QuestionnaireMetadataDRF: type: object properties: answers: type: array items: $ref: '#/components/schemas/QuestionnaireAnswerDRF' required: - answers QuestionnaireResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' QuestionnaireWidgetResponseDRF: type: object properties: unit: type: array items: type: string data: type: array items: type: string value: type: array items: type: string description: type: string date: type: string format: date-time seen: type: boolean footer: type: array items: $ref: '#/components/schemas/FootnoteDRF' learnArticles: type: array items: $ref: '#/components/schemas/CMSLearnArticleDRF' required: - seen - unit QuickDashQuestionsDRF: type: object properties: jar: type: integer chores: type: integer shopping: type: integer washBack: type: integer knife: type: integer recreation: type: integer socialActivity: type: integer regularActivity: type: integer handPain: type: integer tingling: type: integer nightPain: type: integer required: - chores - handPain - jar - knife - nightPain - recreation - regularActivity - shopping - socialActivity - tingling - washBack RagThresholdDRF: type: object properties: type: type: string severity: type: integer thresholdRange: type: array items: $ref: '#/components/schemas/ThresholdRangeDRF' color: type: string fieldName: type: string enabled: type: boolean mealGroup: type: string LocalizableFields: type: array items: type: string title: ' localizablefields' required: - color - enabled - fieldName - severity - thresholdRange - type ReactionTimeDRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double required: - deploymentId - deviceName - moduleId - userId - value ReactivateUsersRequestDataDRF: type: object properties: userIds: type: array items: type: string required: - userIds ReactivateUsersResponseDRF: type: object properties: reactivatedUsers: type: integer ReasonDRF: type: object properties: order: type: integer displayName: type: string LocalizableFields: type: array items: type: string title: ' localizablefields' required: - displayName - order RecentFlagsDRF: type: object properties: red: type: integer amber: type: integer green: type: integer gray: type: integer RefreshTokenRequestObjectV1DRF: type: object properties: refreshToken: type: string password: type: string email: type: string deviceAgent: type: string deviceToken: type: string required: - refreshToken RefreshTokenResponseObjectDRF: type: object properties: authToken: type: string expiresIn: type: integer refreshToken: type: string refreshTokenExpiresIn: type: integer RegimenChangeDRF: type: object properties: frequency: $ref: '#/components/schemas/CaptureChangeDRF' required: - frequency RegisterDeviceRequestObjectDRF: type: object properties: devicePushId: type: string devicePushIdType: type: string deviceDetails: type: string required: - devicePushId - devicePushIdType ReleaseDRF: type: object properties: name: type: string version: type: integer submitter: type: string createDateTime: type: string format: date-time ReleasesResponseObjectDRF: type: object properties: releases: type: array items: $ref: '#/components/schemas/ReleaseDRF' ReminderResponseDataDRF: type: object properties: id: type: string userId: type: string title: type: string description: type: string model: type: string isRecurring: type: boolean instanceExpiresIn: type: string startDateTime: type: string endDateTime: type: string enabled: type: boolean parentId: type: string snoozing: type: array items: type: string hasCustomSchedule: type: boolean isSilent: type: boolean updateDateTime: type: string createDateTime: type: string completeDateTime: type: string durationIso: type: string specificWeekDays: type: array items: type: string specificMonthDays: type: array items: type: integer moduleId: type: string moduleConfigId: type: string required: - model - moduleConfigId - moduleId ReorderTabsRequestObjectDRF: type: object properties: tabOrders: type: array items: $ref: '#/components/schemas/TabOrderItemDRF' required: - tabOrders ReorderWidgetsRequestObjectDRF: type: object properties: tabId: type: string widgetOrders: type: array items: $ref: '#/components/schemas/TabOrderItemDRF' required: - tabId - widgetOrders ReportAxeDRF: type: object properties: axisId: type: string axisName: type: string axisType: type: string dataType: type: string axisDescription: type: string axisData: type: array items: $ref: '#/components/schemas/AxisDataDRF' axisSteps: $ref: '#/components/schemas/AxisStepsDRF' axisFromDate: type: string format: date-time axisToDate: type: string format: date-time axisFromInt: type: integer axisToInt: type: integer axisFromDouble: type: number format: double axisToDouble: type: number format: double required: - axisId - axisName - axisType - dataType ReportGroupDRF: type: object properties: groupId: type: string groupName: type: string groupElements: type: array items: $ref: '#/components/schemas/ReportGroupElementDRF' required: - groupElements - groupId ReportGroupElementDRF: type: object properties: elementName: type: string elementDescription: type: string elementSymbolChar: type: string elementSymbolSvgPath: type: string axes: type: array items: type: string required: - axes - elementName ReportInfoDRF: type: object properties: fev1Percentage: type: string fev1Raw: type: string fev1RawPef: type: string required: - fev1Percentage - fev1Raw - fev1RawPef ReportSeriesDRF: type: object properties: seriesId: type: string seriesData: type: array items: $ref: '#/components/schemas/DataPointDRF' required: - seriesId RequestPasswordResetRequestObjectDRF: type: object properties: language: type: string clientId: type: string projectId: type: string email: type: string required: - clientId - email - projectId RequestSignupCodeRequestObjectDRF: type: object properties: language: type: string clientId: type: string projectId: type: string email: type: string appName: type: string deploymentId: type: string expiresIn: type: string required: - clientId - projectId ResearchTeamActionsDRF: type: object properties: forms: type: array items: type: string ResendInvitationsListRequestObjectDRF: type: object properties: language: type: string clientId: type: string projectId: type: string invitationsList: type: array items: $ref: '#/components/schemas/InvitationItemDRF' required: - clientId - invitationsList - projectId ResendInvitationsListResponseDRF: type: object properties: resentInvitations: type: integer ResetPasswordRequestObjectDRF: type: object properties: email: type: string code: type: string newPassword: type: string required: - code - email - newPassword RespiratoryRateDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer valueUnit: type: string originalValue: type: number format: double required: - deploymentId - deviceName - moduleId - userId - value RespiratoryRateResultsDRF: type: object properties: RespiratoryRate: type: array items: $ref: '#/components/schemas/RespiratoryRateDTODRF' ResponseBillingMonitoringLogDTODRF: type: object properties: id: type: string originalLogId: type: string deploymentId: type: string createdById: type: string lastModifiedById: type: string userId: type: string timeTrackingId: type: string status: type: string action: type: string addendum: type: string timeSpent: type: number format: double startDateTime: type: string format: date-time endDateTime: type: string format: date-time initialCreateDateTime: type: string format: date-time createDateTime: type: string format: date-time updateDateTime: type: string format: date-time createdByName: type: string lastModifiedByName: type: string required: - action - createdByName - lastModifiedByName ResponseDRF: type: object properties: applinks: $ref: '#/components/schemas/AppleAppLinksDRF' RestingBreathingRateDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer required: - deploymentId - deviceName - moduleId - userId - value RestingBreathingRateResultsDRF: type: object properties: RestingBreathingRate: type: array items: $ref: '#/components/schemas/RestingBreathingRateDTODRF' RestingHeartRateResultsDRF: type: object properties: HeartRate: type: array items: $ref: '#/components/schemas/HeartRateDTODRF' ResultIdResponseObjectDRF: type: object properties: id: type: string ResultsDRF: type: object properties: Dysarthria: type: array items: $ref: '#/components/schemas/DysarthriaDTODRF' AHQ: type: array items: $ref: '#/components/schemas/AHQDTODRF' Temperature: type: array items: $ref: '#/components/schemas/TemperatureDTODRF' OACS: type: array items: $ref: '#/components/schemas/OACSDTODRF' HighFrequencyStep: type: array items: $ref: '#/components/schemas/HighFrequencyStepDTODRF' BreastFeedingStatus: type: array items: $ref: '#/components/schemas/BreastFeedingStatusDTODRF' WHQ: type: array items: $ref: '#/components/schemas/WHQDTODRF' Covid19RiskScoreCoreQuestions: type: array items: $ref: '#/components/schemas/Covid19RiskScoreCoreQuestionsDTODRF' PostVaccination: type: array items: $ref: '#/components/schemas/PostVaccinationDTODRF' Covid19RiskScore: type: array items: $ref: '#/components/schemas/Covid19RiskScoreDTODRF' ECGAliveCor: type: array items: $ref: '#/components/schemas/ECGAliveCorDTODRF' ODI: type: array items: $ref: '#/components/schemas/ODIDTODRF' Dysphonia: type: array items: $ref: '#/components/schemas/DysphoniaDTODRF' WOMAC: type: array items: $ref: '#/components/schemas/WOMACDTODRF' OxfordShoulderScore: type: array items: $ref: '#/components/schemas/OxfordShoulderScoreDTODRF' Height: type: array items: $ref: '#/components/schemas/HeightDTODRF' PROMISGlobalHealth: type: array items: $ref: '#/components/schemas/PROMISGlobalHealthDTODRF' FeverAndPainDrugs: type: array items: $ref: '#/components/schemas/FeverAndPainDrugsDTODRF' PeakFlow: type: array items: $ref: '#/components/schemas/PeakFlowDTODRF' VR12: type: array items: $ref: '#/components/schemas/VR_12DTODRF' BackgroundInformation: type: array items: $ref: '#/components/schemas/BackgroundInformationDTODRF' AsthmaControlTest: type: array items: $ref: '#/components/schemas/AsthmaControlTestDTODRF' Weight: type: array items: $ref: '#/components/schemas/WeightDTODRF' OxygenSaturation: type: array items: $ref: '#/components/schemas/OxygenSaturationDTODRF' ReactionTime: type: array items: $ref: '#/components/schemas/ReactionTimeDRF' HRV: type: array items: $ref: '#/components/schemas/HRVDTODRF' VirtualCare: type: array items: $ref: '#/components/schemas/VirtualCareDTODRF' Ptosis: type: array items: $ref: '#/components/schemas/PtosisDTODRF' KCCQ: type: array items: $ref: '#/components/schemas/KCCQDTODRF' Symptom: type: array items: $ref: '#/components/schemas/SymptomDTODRF' PregnancyUpdate: type: array items: $ref: '#/components/schemas/PregnancyUpdateDTODRF' Geolocation: type: array items: $ref: '#/components/schemas/GeolocationDTODRF' MedicalHistory: type: array items: $ref: '#/components/schemas/MedicalHistoryDTODRF' WaistToHeight: type: array items: $ref: '#/components/schemas/WaistToHeightDRF' SmokeQuestions: type: array items: $ref: '#/components/schemas/SmokeQuestionsDTODRF' OxfordKneeScore: type: array items: $ref: '#/components/schemas/OxfordKneeScoreDTODRF' HighFrequencyHeartRate: type: array items: $ref: '#/components/schemas/HighFrequencyHeartRateDTODRF' KOOS: type: array items: $ref: '#/components/schemas/KOOSDTODRF' Step: type: array items: $ref: '#/components/schemas/StepDTODRF' PerceivedStressScale: type: array items: $ref: '#/components/schemas/PerceivedStressScaleDTODRF' BodyPower: type: array items: $ref: '#/components/schemas/BodyPowerDTODRF' SRS: type: array items: $ref: '#/components/schemas/SRSDTODRF' BloodGlucose: type: array items: $ref: '#/components/schemas/BloodGlucoseDTODRF' IKDC: type: array items: $ref: '#/components/schemas/IKDCDTODRF' VaccinationDetails: type: array items: $ref: '#/components/schemas/VaccinationDetailsDTODRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' AlcoholConsumption: type: array items: $ref: '#/components/schemas/AlcoholConsumptionDTODRF' HScore: type: array items: $ref: '#/components/schemas/HScoreDTODRF' Sleep: type: array items: $ref: '#/components/schemas/SleepDTODRF' BloodPressure: type: array items: $ref: '#/components/schemas/BloodPressureDTODRF' DiabetesDistressScore: type: array items: $ref: '#/components/schemas/DiabetesDistressScoreDTODRF' HemophiliaJournal: type: array items: $ref: '#/components/schemas/HemophiliaJournalDTODRF' HealthStatus: type: array items: $ref: '#/components/schemas/HealthStatusDTODRF' AdditionalQoL: type: array items: $ref: '#/components/schemas/AdditionalQoLDTODRF' ArmFatigue: type: array items: $ref: '#/components/schemas/ArmFatigueDTODRF' BodyMeasurement: type: array items: $ref: '#/components/schemas/BodyMeasurementDTODRF' InfantFollowUp: type: array items: $ref: '#/components/schemas/InfantFollowUpDTODRF' Covid19DailyCheckIn: type: array items: $ref: '#/components/schemas/Covid19DailyCheckInDRF' RespiratoryRate: type: array items: $ref: '#/components/schemas/RespiratoryRateDTODRF' Journal: type: array items: $ref: '#/components/schemas/JournalDTODRF' SpatialSpaniOS: type: array items: $ref: '#/components/schemas/SpatialSpaniOSDTODRF' TakenMedication: type: array items: $ref: '#/components/schemas/TakenMedicationDTODRF' BreastFeedingUpdate: type: array items: $ref: '#/components/schemas/BreastFeedingUpdateDTODRF' AwarenessTraining: type: array items: $ref: '#/components/schemas/AwarenessTrainingDTODRF' BodyStress: type: array items: $ref: '#/components/schemas/BodyStressDTODRF' SleepQuestions: type: array items: $ref: '#/components/schemas/SleepQuestionsDTODRF' DashScore: type: array items: $ref: '#/components/schemas/DashScoreDTODRF' NumericMemory: type: array items: $ref: '#/components/schemas/NumericMemoryDTODRF' NDI: type: array items: $ref: '#/components/schemas/NDIDTODRF' AZScreeningQuestionnaire: type: array items: $ref: '#/components/schemas/AZScreeningQuestionnaireDTODRF' PregnancyFollowUp: type: array items: $ref: '#/components/schemas/PregnancyFollowUpDTODRF' SelfHealthRate: type: array items: $ref: '#/components/schemas/SelfHealthRateDTODRF' OxfordHipScore: type: array items: $ref: '#/components/schemas/OxfordHipScoreDTODRF' SensorCapture: type: array items: $ref: '#/components/schemas/SensorCaptureDTODRF' OARS: type: array items: $ref: '#/components/schemas/OARSDTODRF' AZGroupKeyActionTrigger: type: array items: $ref: '#/components/schemas/AZGroupKeyActionTriggerDTODRF' SF36: type: array items: $ref: '#/components/schemas/SF36DTODRF' BodyComposition: type: array items: $ref: '#/components/schemas/BodyCompositionDTODRF' EQ5D5L: type: array items: $ref: '#/components/schemas/EQ5D5LDTODRF' PulseOximetry: type: array items: $ref: '#/components/schemas/PulseOximetryDTODRF' BMI: type: array items: $ref: '#/components/schemas/BMIDTODRF' AirQualityIndex: type: array items: $ref: '#/components/schemas/AirQualityIndexDTODRF' OtherVaccine: type: array items: $ref: '#/components/schemas/OtherVaccineDTODRF' MG_ADL: type: array items: $ref: '#/components/schemas/MG_ADLDTODRF' PregnancyStatus: type: array items: $ref: '#/components/schemas/PregnancyStatusDTODRF' NORFOLK: type: array items: $ref: '#/components/schemas/NORFOLKDTODRF' Tegner: type: array items: $ref: '#/components/schemas/TegnerDTODRF' RestingBreathingRate: type: array items: $ref: '#/components/schemas/RestingBreathingRateDTODRF' ECG: type: array items: $ref: '#/components/schemas/ECGDTODRF' Spirometry: type: array items: $ref: '#/components/schemas/SpirometryDTODRF' CAT: type: array items: $ref: '#/components/schemas/CATDRF' Photo: type: array items: $ref: '#/components/schemas/PhotoDTODRF' Lysholm: type: array items: $ref: '#/components/schemas/LysholmDTODRF' CVDRiskScore: type: array items: $ref: '#/components/schemas/CVDRiskScoreDTODRF' AZFurtherPregnancyKeyActionTrigger: type: array items: $ref: '#/components/schemas/AZFurtherPregnancyKeyActionTriggerDTODRF' HeartRate: type: array items: $ref: '#/components/schemas/HeartRateDTODRF' ECGHealthKit: type: array items: $ref: '#/components/schemas/ECGHealthKitDTODRF' RevereTest: type: array items: $ref: '#/components/schemas/RevereTestDTODRF' FitbitHRV: type: array items: $ref: '#/components/schemas/FitbitHRVDTODRF' RetrieveAdminInvitesResponseObjectDRF: type: object properties: skip: type: integer limit: type: integer total: type: integer invites: type: array items: $ref: '#/components/schemas/DetailedInvitationDRF' required: - limit - skip - total RetrieveAllModuleConfigsRequestObjectDRF: type: object properties: deploymentIds: type: array items: type: string required: - deploymentIds RetrieveAllModuleConfigsResponseObjectDRF: type: object properties: moduleConfigs: type: object additionalProperties: {} required: - moduleConfigs RetrieveAnalyticsResponseDRF: type: object properties: iframeUrl: type: string RetrieveAnalyticsUrlRequestObjectDRF: type: object properties: deploymentIds: type: array items: type: string organizationIds: type: array items: type: string startDate: type: string endDate: type: string analyticsDashboard: type: string required: - endDate - startDate RetrieveAppointmentsRequestBodyDRF: type: object properties: fromDateTime: type: string format: date-time toDateTime: type: string format: date-time RetrieveAppointmentsResponseObjectDRF: type: object properties: appointments: type: array items: $ref: '#/components/schemas/AppointmentDTODRF' required: - appointments RetrieveAvailableMonthsRequestObjectDRF: type: object properties: before: type: string after: type: string search: type: string filters: type: object additionalProperties: {} skip: type: integer limit: type: integer clients: type: array items: type: string RetrieveAvailableMonthsResponseObjectDRF: type: object properties: months: type: array items: type: string limit: type: integer skip: type: integer total: type: integer RetrieveBillingMonitoringLogsRequestBodyDRF: type: object properties: skip: type: integer limit: type: integer RetrieveCallsPaginatedResponseObjectDRF: type: object properties: calls: type: array items: $ref: '#/components/schemas/OfflineVideoCallDTODRF' total: type: integer skip: type: integer limit: type: integer required: - calls - limit - skip - total RetrieveClientsInvoicesResponseObjectDRF: type: object properties: limit: type: integer skip: type: integer total: type: integer items: type: array items: $ref: '#/components/schemas/ClientInvoiceDetailRowObjectDRF' RetrieveClientsRequestObjectDRF: type: object properties: skip: type: integer limit: type: integer ids: type: array items: type: string search: type: string RetrieveClientsResponseObjectDRF: type: object properties: skip: type: integer limit: type: integer results: type: array items: $ref: '#/components/schemas/ClientDTODRF' total: type: integer RetrieveCustomModuleConfigsRequestObjectDRF: type: object properties: userIds: type: array items: type: string deploymentId: type: string required: - deploymentId - userIds RetrieveCustomModuleConfigsResponseObjectDRF: type: object properties: configs: type: object additionalProperties: {} RetrieveDeploymentConfigResponseDRF: type: object properties: termAndConditionUrl: type: string privacyPolicyUrl: type: string eulaUrl: type: string privacyPolicyObject: $ref: '#/components/schemas/S3ObjectDRF' termAndConditionObject: $ref: '#/components/schemas/S3ObjectDRF' eulaObject: $ref: '#/components/schemas/S3ObjectDRF' authorisedRep: $ref: '#/components/schemas/AuthorisedRepDRF' roles: type: array items: $ref: '#/components/schemas/RoleDTODRF' sso: $ref: '#/components/schemas/SsoDRF' draftId: type: string name: type: string description: type: string status: type: string color: type: string icon: $ref: '#/components/schemas/S3ObjectDRF' iconFileId: type: string templateThumbnailFileId: type: string descriptionUrl: type: string isSaMD: type: boolean updateDateTime: type: string format: date-time createDateTime: type: string format: date-time moduleConfigs: type: array items: $ref: '#/components/schemas/ModuleConfigDRF' onboardingConfigs: type: array items: $ref: '#/components/schemas/OnboardingModuleConfigDTODRF' learn: $ref: '#/components/schemas/LearnDRF' consent: $ref: '#/components/schemas/ConsentDRF' econsent: $ref: '#/components/schemas/EConsentDRF' keyActions: type: array items: $ref: '#/components/schemas/KeyActionConfigDRF' keyActionsEnabled: type: boolean profile: $ref: '#/components/schemas/ProfileDRF' features: $ref: '#/components/schemas/FeaturesDRF' extraCustomFields: type: object additionalProperties: {} surgeryDetails: $ref: '#/components/schemas/SurgeryDetailsDRF' contactUsURL: type: string version: type: integer integration: $ref: '#/components/schemas/IntegrationConfigDRF' language: type: string duration: type: string security: $ref: '#/components/schemas/SecurityDRF' mfaRequired: type: boolean code: type: string enrollmentCounter: type: integer staticEventConfig: $ref: '#/components/schemas/StaticEventConfigDRF' stats: $ref: '#/components/schemas/DeploymentStatsDRF' country: type: string dashboardConfiguration: $ref: '#/components/schemas/DeploymentLevelConfigurationDRF' labels: type: array items: $ref: '#/components/schemas/RetrieveDeploymentLabelsResponseObjectDRF' tags: type: array items: type: string location: $ref: '#/components/schemas/LocationDRF' integrationDevices: type: array items: $ref: '#/components/schemas/IntegrationDeviceDRF' componentConfigs: type: object additionalProperties: {} defaultUnits: type: object additionalProperties: {} builder: $ref: '#/components/schemas/BuilderDRF' programId: type: integer LocalizableFields: type: array items: type: string title: ' localizablefields' deploymentId: type: string instructionsForUseUrl: type: string eLabelTemplateUrl: type: string RetrieveDeploymentConfigResponseObjectDRF: type: object properties: termAndConditionUrl: type: string privacyPolicyUrl: type: string eulaUrl: type: string privacyPolicyObject: $ref: '#/components/schemas/S3ObjectDRF' termAndConditionObject: $ref: '#/components/schemas/S3ObjectDRF' eulaObject: $ref: '#/components/schemas/S3ObjectDRF' authorisedRep: $ref: '#/components/schemas/AuthorisedRepDRF' roles: type: array items: $ref: '#/components/schemas/RoleDTODRF' sso: $ref: '#/components/schemas/SsoDRF' id: type: string draftId: type: string name: type: string description: type: string status: type: string color: type: string icon: $ref: '#/components/schemas/S3ObjectDRF' iconFileId: type: string templateThumbnailFileId: type: string descriptionUrl: type: string isSaMD: type: boolean updateDateTime: type: string format: date-time createDateTime: type: string format: date-time moduleConfigs: type: array items: $ref: '#/components/schemas/ModuleConfigDRF' onboardingConfigs: type: array items: $ref: '#/components/schemas/OnboardingModuleConfigDTODRF' learn: $ref: '#/components/schemas/LearnDRF' consent: $ref: '#/components/schemas/ConsentDRF' econsent: $ref: '#/components/schemas/EConsentDRF' keyActions: type: array items: $ref: '#/components/schemas/KeyActionConfigDRF' keyActionsEnabled: type: boolean profile: $ref: '#/components/schemas/ProfileDRF' features: $ref: '#/components/schemas/FeaturesDRF' extraCustomFields: type: object additionalProperties: {} surgeryDetails: $ref: '#/components/schemas/SurgeryDetailsDRF' contactUsURL: type: string version: type: integer integration: $ref: '#/components/schemas/IntegrationConfigDRF' language: type: string duration: type: string security: $ref: '#/components/schemas/SecurityDRF' mfaRequired: type: boolean code: type: string enrollmentCounter: type: integer staticEventConfig: $ref: '#/components/schemas/StaticEventConfigDRF' stats: $ref: '#/components/schemas/DeploymentStatsDRF' localizations: type: object additionalProperties: {} country: type: string dashboardConfiguration: $ref: '#/components/schemas/DeploymentLevelConfigurationDRF' labels: type: array items: $ref: '#/components/schemas/LabelDRF' tags: type: array items: type: string location: $ref: '#/components/schemas/LocationDRF' integrationDevices: type: array items: $ref: '#/components/schemas/IntegrationDeviceDRF' componentConfigs: type: object additionalProperties: {} defaultUnits: type: object additionalProperties: {} builder: $ref: '#/components/schemas/BuilderDRF' programId: type: integer LocalizableFields: type: array items: type: string title: ' localizablefields' deploymentId: type: string consentNeeded: type: boolean eConsentNeeded: type: boolean nextOnboardingTaskId: type: string isOffBoarded: type: boolean instructionsForUseUrl: type: string eLabelTemplateUrl: type: string deploymentLanguages: type: array items: type: object additionalProperties: {} RetrieveDeploymentKeyActionsRequestObjectBodyDRF: type: object properties: startDate: type: string format: date-time endDate: type: string format: date-time triggerTime: type: string format: date-time required: - endDate - startDate RetrieveDeploymentKeyActionsResponseObjectDRF: type: object properties: events: type: array items: $ref: '#/components/schemas/DeploymentEventDRF' RetrieveDeploymentLabelsResponseObjectDRF: type: object properties: id: type: string text: type: string authorId: type: string createDateTime: type: string format: date-time updatedBy: type: string updateDateTime: type: string format: date-time isStatic: type: boolean operations: type: array items: type: string count: type: integer required: - count RetrieveDeploymentTemplatesResponseObjectDRF: type: object properties: templates: type: array items: $ref: '#/components/schemas/DeploymentTemplateDTODRF' RetrieveDeploymentsContainsPatientRequestObjectDRF: type: object properties: sort: $ref: '#/components/schemas/SortParametersDRF' skip: type: integer limit: type: integer deploymentIds: type: array items: type: string organizationId: type: string patientName: type: string dob: type: string showDraftDeployments: type: boolean required: - patientName RetrieveDeploymentsRequestObjectDRF: type: object properties: skip: type: integer limit: type: integer searchCriteria: type: string search: type: string sort: type: array items: $ref: '#/components/schemas/SortFieldDRF' status: type: array items: type: string patientName: type: string patientId: type: string RetrieveDeploymentsResponseObjectDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/DeploymentResponseObjectDRF' total: type: integer limit: type: integer skip: type: integer totalPatientCount: type: integer RetrieveDiariesCountResponseObjectDRF: type: object properties: diaryDate: type: string format: date-time count: type: integer red: type: integer amber: type: integer gray: type: integer required: - amber - count - gray - red RetrieveDiariesRequestObjectDRF: type: object properties: userId: type: string skip: type: integer limit: type: integer fromDateTime: type: string format: date-time toDateTime: type: string format: date-time diaryType: type: array items: type: string context: type: string rawDiaries: type: boolean excludedDiaryTypes: type: array items: type: string required: - skip RetrieveDiariesResponseObjectDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/DiaryItemResponseDRF' total: type: integer skip: type: integer limit: type: integer required: - total RetrieveDiaryByIdResponseDRF: type: object properties: id: type: string userId: type: string diaryId: type: string diarySourceId: type: string moduleConfigId: type: string diaryType: type: string primitiveType: type: string title: type: string value: type: array items: type: string unit: type: array items: type: string diaryBG: type: string diarySidebar: type: string diaryChips: type: array items: $ref: '#/components/schemas/DiaryChipResponseDRF' mealEventType: type: string flags: type: object additionalProperties: {} detailsTitle: type: string details: type: array items: $ref: '#/components/schemas/DiaryDetailItemResponseDRF' buttons: type: array items: $ref: '#/components/schemas/DiaryButtonDRF' detailsPresentation: type: string visibility: type: array items: type: string localizationData: type: object additionalProperties: {} extraFields: type: object additionalProperties: {} updateDateTime: type: string format: date-time createDateTime: type: string format: date-time startDateTime: type: string format: date-time required: - createDateTime - details - diaryBG - diaryId - diarySidebar - diarySourceId - diaryType - id - startDateTime - title - updateDateTime - userId - visibility RetrieveEConsentsResponseObjectDRF: type: object properties: total: type: integer limit: type: integer skip: type: integer items: type: array items: $ref: '#/components/schemas/EConsentFormDRF' RetrieveEhrLogsRequestObjectDRF: type: object properties: skip: type: integer limit: type: integer userId: type: string deploymentId: type: string integrationId: type: string method: type: string statusCode: type: integer destinationFunc: type: string fromDateTime: type: string format: date-time toDateTime: type: string format: date-time searchText: type: string sortFields: type: array items: $ref: '#/components/schemas/SortFieldDRF' RetrieveEhrLogsResponseObjectDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/EhrLogDTODRF' total: type: integer skip: type: integer limit: type: integer RetrieveExportProcessesResponseObjectDRF: type: object properties: exportProcesses: type: array items: $ref: '#/components/schemas/ExportProcessDTODRF' RetrieveExportProfilesRequestObjectDRF: type: object properties: deploymentId: type: string organizationId: type: string nameContains: type: string RetrieveExportProfilesResponseObjectDRF: type: object properties: exportProfiles: type: array items: $ref: '#/components/schemas/ExportProfileDTODRF' RetrieveFeedbackResponseObjectDRF: type: object properties: currentValue: type: array items: type: string comparingValue: type: array items: type: string upperBound: type: integer lowerBound: type: integer currentValueSeverity: type: integer feedback: $ref: '#/components/schemas/FeedbackTextResponseDRF' ragThresholds: type: array items: $ref: '#/components/schemas/RagThresholdDRF' RetrieveFilesInLibraryResponseObjectDRF: type: object properties: files: type: array items: $ref: '#/components/schemas/LibraryFileObjectDRF' total: type: integer RetrieveFullConfigurationResponseObjectDRF: type: object properties: organizations: type: array items: $ref: '#/components/schemas/OrganizationDTODRF' deployments: type: array items: $ref: '#/components/schemas/DeploymentConfigDRF' roles: type: array items: $ref: '#/components/schemas/ConfigurationRoleDRF' required: - deployments - organizations RetrieveGadgetDataRequestObjectDRF: type: object properties: resourceType: type: string resourceId: type: string gadgetId: type: string deploymentIds: type: array items: type: string organizationId: type: string size: type: string required: - gadgetId - resourceId - resourceType RetrieveHealthScoreRequestObjectDRF: type: object properties: scoreDate: type: string format: date-time userId: type: string source: type: string healthTypes: type: array items: type: string required: - healthTypes - source - userId RetrieveHealthScoreResponseObjectDRF: type: object properties: metrics: type: array items: $ref: '#/components/schemas/HealthMetricDRF' errors: type: array items: type: string RetrieveIntegrationsRequestObjectDRF: type: object properties: skip: type: integer limit: type: integer required: - skip RetrieveIntegrationsResponseObjectDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/IntegrationDTODRF' total: type: integer skip: type: integer limit: type: integer RetrieveInvitationsRequestDataDRF: type: object properties: language: type: string clientId: type: string projectId: type: string email: type: string search: type: string userId: type: string roleType: type: string skip: type: integer limit: type: integer invitationType: type: string sortFields: type: array items: $ref: '#/components/schemas/SortFieldDRF' required: - clientId - limit - projectId - roleType - skip RetrieveInvitationsResponseObjectDRF: type: object properties: invitations: type: array items: $ref: '#/components/schemas/InvitationDTODRF' total: type: integer limit: type: integer skip: type: integer RetrieveInvitationsV1ResponseObjectDRF: type: object properties: invitations: type: array items: $ref: '#/components/schemas/InvitationResponseModelDRF' filtered: type: integer total: type: integer RetrieveInvoiceOverviewResponseObjectDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/InvoiceOverViewReportRowDTODRF' total: type: integer skip: type: integer limit: type: integer RetrieveLanguageDRF: type: object properties: code: type: string required: - code RetrieveLocalizableFieldsResponseObjectDRF: type: object properties: localizableFields: type: array items: type: string RetrieveLocalizationsRequestObjectDRF: type: object properties: deploymentId: type: string languages: type: array items: type: string required: - deploymentId RetrieveMedicationsRequestObjectDRF: type: object properties: userId: type: string skip: type: integer limit: type: integer startDateTime: type: string format: date-time onlyEnabled: type: boolean required: - limit - skip - userId RetrieveModuleResultsRequestObjectDRF: type: object properties: skip: type: integer limit: type: integer direction: type: string fromDateTime: type: string format: date-time toDateTime: type: string format: date-time filters: type: object additionalProperties: {} userId: type: string deploymentId: type: string role: type: string status: type: string useCreateDateTime: type: boolean moduleId: type: string moduleConfigId: type: string excludedFields: type: array items: type: string normalQuestionnaires: type: boolean excludeModuleIds: type: array items: type: string unseenOnly: type: boolean average: type: boolean pathUserTimeZone: type: string RetrieveMoveUserHistoryResponseObjectDRF: type: object properties: history: type: array items: $ref: '#/components/schemas/UserMoveHistoryDTODRF' RetrieveNaturalConditionsResponseDRF: type: object properties: airQuality: $ref: '#/components/schemas/AirQualityDRF' pollen: $ref: '#/components/schemas/PollenDataDRF' RetrieveOrganizationsRequestObjectDRF: type: object properties: skip: type: integer limit: type: integer sort: type: array items: $ref: '#/components/schemas/SortFieldDRF' nameContains: type: string searchCriteria: type: string status: type: array items: type: string required: - limit - skip RetrieveOrganizationsResponseObjectDRF: type: object properties: total: type: integer limit: type: integer skip: type: integer items: type: array items: $ref: '#/components/schemas/OrganizationDTODRF' RetrievePatientRecordingResponseDRF: type: object properties: totalCount: type: integer recordings: type: array items: $ref: '#/components/schemas/PatientRecordingDRF' pageInfo: $ref: '#/components/schemas/PatientRecordingPageInfoDRF' RetrievePatientsRequestObjectDRF: type: object properties: sort: $ref: '#/components/schemas/SortParametersDRF' skip: type: integer limit: type: integer deploymentIds: type: array items: type: string organizationId: type: string search: type: string userId: type: string role: type: string details: type: boolean RetrievePluginConfigResponseObjectDRF: type: object properties: title: type: string fields: type: array items: $ref: '#/components/schemas/ConfigUIDRF' RetrievePluginContainerResponseObjectDRF: type: object properties: componentsUI: type: array items: $ref: '#/components/schemas/ComponentUIDRF' required: - componentsUI RetrieveProfilesRequestDataDRF: type: object properties: sort: $ref: '#/components/schemas/SortParametersDRF' skip: type: integer limit: type: integer search: type: string role: type: string patientIdentifiersOnly: type: boolean patientDataOnly: type: boolean clean: type: boolean managerId: type: string filters: type: object additionalProperties: {} hash: type: string unassignedPatients: type: boolean deploymentIds: type: array items: type: string RetrieveProfilesResponseObjectDRF: type: object properties: users: type: array items: $ref: '#/components/schemas/MovedUserDRF' filtered: type: integer total: type: integer required: - filtered - total - users RetrieveProxyInvitationsResponseObjectDRF: type: object properties: status: type: string proxy: $ref: '#/components/schemas/ProxyDataDRF' invitationId: type: string required: - status RetrievePublicModuleConfigResponseObjectDRF: type: object properties: moduleConfig: $ref: '#/components/schemas/ModuleConfigDRF' deploymentId: type: string consentConfig: $ref: '#/components/schemas/ConsentConfigObjectDRF' isUserConsented: type: boolean RetrievePublicModuleResponseObjectDRF: type: object properties: isExpired: type: boolean isMaxFillOutReached: type: boolean givenName: type: string familyName: type: string RetrieveRemindersRequestObjectDRF: type: object properties: endDateTime: type: string enabled: type: boolean moduleId: type: string moduleConfigId: type: string RetrieveRemindersResponseDRF: type: object properties: reminders: type: array items: $ref: '#/components/schemas/ReminderResponseDataDRF' total: type: integer skip: type: integer limit: type: integer required: - limit - reminders - skip - total RetrieveSchemaResponseDRF: type: object properties: schema: type: object additionalProperties: {} required: - schema RetrieveSharedTemplateBankResponseDRF: type: object properties: templates: type: array items: $ref: '#/components/schemas/SharedTemplateFileResponseDRF' RetrieveStaffRequestDataDRF: type: object properties: sort: $ref: '#/components/schemas/SortParametersDRF' deploymentId: type: string nameContains: type: string limit: type: integer skip: type: integer organizationId: type: string RetrieveStaffRequestObjectDRF: type: object properties: sort: $ref: '#/components/schemas/SortParametersDRF' deploymentId: type: string nameContains: type: string limit: type: integer skip: type: integer organizationId: type: string RetrieveStaffResponseObjectDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/UserDTODRF' total: type: integer skip: type: integer limit: type: integer RetrieveStaffV2RequestObjectDRF: type: object properties: sort: $ref: '#/components/schemas/SortParametersDRF' skip: type: integer limit: type: integer deploymentId: type: string organizationId: type: string search: type: string role: type: string RetrieveThirdPartyAppsRequestDataDRF: type: object properties: type: type: string RetrieveToDoItemsResponseDRF: type: object properties: id: type: string userId: type: string title: type: string description: type: string model: type: string isRecurring: type: boolean instanceExpiresIn: type: string startDateTime: type: string endDateTime: type: string enabled: type: boolean parentId: type: string hasCustomSchedule: type: boolean isSilent: type: boolean updateDateTime: type: string createDateTime: type: string completeDateTime: type: string appointmentDateTime: type: string format: date-time appointmentStatus: type: string appointmentId: type: string keyActionConfigId: type: string learnArticleId: type: string moduleId: type: string moduleConfigId: type: string deploymentId: type: string required: - keyActionConfigId - model RetrieveUnseenMedicationResultsResponseDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/UnseenResultDTODRF' required: - items RetrieveUserNotesV2ResponseDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/UserNoteDTODRF' total: type: integer skip: type: integer limit: type: integer RetrieveUserResourcesResponseObjectDRF: type: object properties: organizations: type: array items: $ref: '#/components/schemas/OrganizationDTODRF' deployments: type: array items: $ref: '#/components/schemas/DeploymentDTODRF' RevereTestDTODRF: type: object properties: id: type: string userId: type: string startDateTime: type: string format: date-time endDateTime: type: string format: date-time results: type: array items: $ref: '#/components/schemas/RevereTestResultDTODRF' status: type: string moduleId: type: string deploymentId: type: string required: - deploymentId - moduleId RevereTestResultDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string initialWords: type: array items: type: string audioResult: $ref: '#/components/schemas/S3ObjectDRF' wordsResult: type: array items: type: string inputLanguageIETFTag: type: string buildNumber: type: string required: - deploymentId - deviceName - initialWords - moduleId - userId RevereTestResultsDRF: type: object properties: RevereTest: type: array items: $ref: '#/components/schemas/RevereTestDTODRF' RevereTestWordObjectDRF: type: object properties: id: type: string initialWords: type: array items: type: string required: - id RiskFactorDRF: type: object properties: name: type: string colorHex: type: string contribution: type: number format: double required: - name RiskTrajectoryDRF: type: object properties: riskPercentage: type: number format: double daysCount: type: number format: double required: - daysCount - riskPercentage RoleAssignmentDTODRF: type: object properties: roleId: type: string resource: type: string userType: type: string isActive: type: boolean required: - resource - roleId RoleDTODRF: type: object properties: id: type: string name: type: string permissions: type: array items: type: string userType: type: string isThirdParty: type: boolean RollbackRequestBodyDRF: type: object properties: version: type: string required: - version RuleConditionDRF: type: object properties: key: type: string value: type: string required: - key - value RunExportDeploymentTaskResponseObjectDRF: type: object properties: exportProcessId: type: string RunExportTaskRequestDataDRF: type: object properties: fromDate: type: string format: date-time toDate: type: string format: date-time moduleNames: type: array items: type: string excludedModuleNames: type: array items: type: string userIds: type: array items: type: string deIdentified: type: boolean maskFreeText: type: boolean includeNullFields: type: boolean includeUserMetaData: type: boolean useFlatStructure: type: boolean extraQuestionIds: type: object additionalProperties: {} view: type: string format: type: string binaryOption: type: string layer: type: string quantity: type: string questionnairePerName: type: boolean splitMultipleChoice: type: boolean splitSymptoms: type: boolean translatePrimitives: type: boolean organizationId: type: string deploymentIds: type: array items: type: string singleFileResponse: type: boolean translationShortCodesObject: $ref: '#/components/schemas/S3ObjectDRF' translationShortCodesObjectFormat: type: string includeFields: type: array items: type: string excludeFields: type: array items: type: string deIdentifyHashFields: type: array items: type: string deIdentifyRemoveFields: type: array items: type: string exportBucket: type: string onboardingModuleNames: type: array items: type: string preferShortCode: type: boolean useCreationTime: type: boolean bucketing: type: array items: $ref: '#/components/schemas/FieldBucketingDRF' excludeMinors: type: boolean useExportProfile: type: boolean baseProfile: type: string doTranslate: type: boolean managerId: type: string RunWorkflowRequestObjectDRF: type: object properties: params: type: object additionalProperties: {} resource: type: string workflowId: type: string required: - params S3ObjectDRF: type: object properties: bucket: type: string key: type: string region: type: string required: - bucket - key SAMLCallbackObjectDRF: type: object properties: language: type: string clientId: type: string projectId: type: string method: type: integer email: type: string contactEmail: type: string phoneNumber: type: string password: type: string displayName: type: string validationData: type: object additionalProperties: {} userAttributes: type: object additionalProperties: {} timezone: type: string ssoEnabled: type: boolean userId: type: string deviceAgent: type: string ipAddress: type: string refreshToken: type: string confirmationCode: type: string authStage: type: string callbackData: type: object additionalProperties: {} required: - clientId - ipAddress - projectId SF36DTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string physicalFunctioningScore: type: number format: double limitationsPhysicalHealthScore: type: number format: double limitationsEmotionalProblemsScore: type: number format: double energyFatigueScore: type: number format: double emotionalWellBeingScore: type: number format: double socialFunctioningScore: type: number format: double painScore: type: number format: double generalHealthScore: type: number format: double required: - deploymentId - deviceName - moduleId - userId SF36ResultsDRF: type: object properties: SF36: type: array items: $ref: '#/components/schemas/SF36DTODRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' SRSDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string function: type: number format: double pain: type: number format: double selfImage: type: number format: double mentalHealth: type: number format: double satisfactionWithManagement: type: number format: double subTotal: type: number format: double total: type: number format: double value: type: number format: double required: - deploymentId - deviceName - function - mentalHealth - moduleId - pain - satisfactionWithManagement - selfImage - subTotal - total - userId - value SRSResultsDRF: type: object properties: SRS: type: array items: $ref: '#/components/schemas/SRSDTODRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' ScoreDRF: type: object properties: value: type: integer level: type: string required: - level - value ScoreHistoryItemDRF: type: object properties: value: type: integer timestamp: type: integer rank: type: string required: - rank - timestamp - value ScoreItemDRF: type: object properties: value: type: integer date: type: string required: - date - value ScoreTableDRF: type: object properties: title: type: string data: type: array items: $ref: '#/components/schemas/ScoreItemDRF' required: - data - title SdkConfigDRF: type: object properties: sdkApiUrl: type: string accessKey: type: string secretKey: type: string teamId: type: string partnerId: type: string SearchAdminStaffResponseObjectDRF: type: object properties: skip: type: integer limit: type: integer total: type: integer staff: type: array items: $ref: '#/components/schemas/UserDTODRF' required: - limit - skip - staff - total SearchArticleRatingRequestObjectDRF: type: object properties: id: type: string userId: type: string deploymentId: type: string createDateTime: type: string format: date-time updateDateTime: type: string format: date-time articleType: type: string articleId: type: string required: - articleId - articleType - userId SearchCMSArticlesResponseDRF: type: object properties: total: type: integer filtered: type: integer result: type: array items: $ref: '#/components/schemas/SearchResultDRF' required: - filtered - result - total SearchContentRequestObjectDRF: type: object properties: collection: type: string search: type: string filters: type: object additionalProperties: {} sort: type: array items: $ref: '#/components/schemas/SortFieldDRF' skip: type: integer limit: type: integer unpublished: type: boolean required: - collection SearchContentResponseObjectDRF: type: object properties: total: type: integer limit: type: integer skip: type: integer items: type: array items: $ref: '#/components/schemas/CMSContentDTODRF' SearchModuleResultsRequestObjectDRF: type: object properties: skip: type: integer limit: type: integer direction: type: string fromDateTime: type: string format: date-time toDateTime: type: string format: date-time filters: type: object additionalProperties: {} userId: type: string deploymentId: type: string role: type: string status: type: string useCreateDateTime: type: boolean modules: type: array items: type: string required: - modules SearchResultDRF: type: object properties: id: type: string slug: type: string therapeutic: type: array items: type: string title: type: string titleImage: type: string readTimeInMinutes: type: integer required: - id SearchVirtualVisitResponseObjectDRF: type: object properties: skip: type: integer limit: type: integer total: type: integer items: type: array items: $ref: '#/components/schemas/VirtualVisitResponseDRF' required: - limit - skip - total SecurityDRF: type: object properties: mfaRequired: type: boolean appLockRequired: type: boolean required: - appLockRequired - mfaRequired SeenResultDataDRF: type: object properties: primitiveName: type: string primitiveId: type: string moduleConfigId: type: string seenFrom: type: string format: date-time seenTo: type: string format: date-time SelfHealthRateDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: string required: - deploymentId - deviceName - moduleId - userId - value SelfRatedHealthResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' SendAdminInvitationsRequestDataDRF: type: object properties: language: type: string clientId: type: string projectId: type: string emails: type: array items: type: string roleId: type: string organizationId: type: string expiresIn: type: string required: - clientId - emails - projectId - roleId SendEmailToPatientsRequestObjectDRF: type: object properties: message: type: string subject: type: string users: type: array items: $ref: '#/components/schemas/UsersInfoDRF' includeCalendarLink: type: boolean required: - message - users SendInvitationsRequestDataDRF: type: object properties: language: type: string clientId: type: string projectId: type: string roleId: type: string organizationId: type: string deploymentIds: type: array items: type: string emails: type: array items: type: string patientId: type: string expiresIn: type: string ssoEnabled: type: boolean required: - clientId - emails - projectId - roleId SendInvitationsRequestDataV1DRF: type: object properties: language: type: string clientId: type: string projectId: type: string roleId: type: string organizationId: type: string deploymentIds: type: array items: type: string type: type: string text: type: string patientId: type: string invitees: type: array items: $ref: '#/components/schemas/InviteeDRF' expiresIn: type: string required: - clientId - projectId - roleId - type SendInvitationsResponseObjectDRF: type: object properties: alreadySignedUpEmails: type: array items: type: string ids: type: array items: type: string ok: type: boolean SendInvitationsResponseObjectV1DRF: type: object properties: alreadySignedUpEmails: type: array items: type: string alreadySignedUpPhoneNumbers: type: array items: type: string alreadyInvitedPhoneNumbers: type: array items: type: string ids: type: array items: type: string failedSendInvitePhoneNumbers: type: array items: type: string ok: type: boolean SendMessageToPatientListRequestObjectBodyDRF: type: object properties: text: type: string custom: type: boolean userIds: type: array items: type: string allUsers: type: boolean required: - text - userIds SendMessageToUserListResponseObjectDRF: type: object properties: SentMessages: type: integer SendPublicModuleResponseObjectDRF: type: object properties: ok: type: boolean id: type: string link: type: string SendUserSpecificInvitationRequestObjectDRF: type: object properties: language: type: string clientId: type: string projectId: type: string expiresIn: type: string linkExpiresIn: type: string invitationType: type: string text: type: string email: type: string phoneNumber: type: string required: - clientId - invitationType - projectId SendVerificationTokenRequestObjectDRF: type: object properties: language: type: string clientId: type: string projectId: type: string method: type: string email: type: string phoneNumber: type: string refreshToken: type: string required: - clientId - method - projectId SendVerificationTokenResponseObjectDRF: type: object properties: ok: type: boolean to: type: string SensorCaptureDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string s3Object: $ref: '#/components/schemas/S3ObjectDRF' sanityCheck: type: boolean sanityCheckMessage: type: string measurementLocation: type: string sensorDataTypes: type: array items: type: string value: type: number format: double required: - deploymentId - deviceName - moduleId - s3Object - userId ServerDRF: type: object properties: hostUrl: type: string server: type: string api: type: string required: - api - hostUrl - server SetAuthAttributesRequestObjectDRF: type: object properties: language: type: string clientId: type: string projectId: type: string email: type: string phoneNumber: type: string password: type: string authToken: type: string tokenType: type: string confirmationToken: type: string mfaEnabled: type: boolean oldPassword: type: string confirmationCode: type: string deviceToken: type: string contactEmail: type: string required: - clientId - projectId SetAuthAttributesResponseObjectDRF: type: object properties: uid: type: string refreshToken: type: string SetModuleResultMealTypeRequestObjectDRF: type: object properties: meal: type: string userNote: type: string primitiveName: type: string primitiveId: type: string moduleConfigId: type: string user: $ref: '#/components/schemas/UserDTODRF' deployment: $ref: '#/components/schemas/DeploymentDTODRF' moduleId: type: string required: - meal - moduleConfigId - primitiveId - primitiveName SeverityFilterDRF: type: object properties: severity: type: integer tags: type: array items: type: string required: - severity - tags SharedTemplateFileDRF: type: object properties: id: type: string deploymentName: type: string title: type: string description: type: string descriptionUrl: type: string templateFile: type: string sortingIndex: type: integer meta: type: object additionalProperties: {} thumbnail: $ref: '#/components/schemas/S3ObjectDRF' test: type: boolean required: - deploymentName - id - meta - sortingIndex - templateFile - thumbnail - title SharedTemplateFileResponseDRF: type: object properties: id: type: string deploymentName: type: string title: type: string description: type: string descriptionUrl: type: string sortingIndex: type: integer meta: type: object additionalProperties: {} thumbnail: type: string test: type: boolean version: type: string required: - deploymentName - id - meta - sortingIndex - thumbnail - title - version ShortPrimitiveDataDRF: type: object properties: primitiveId: type: string primitiveName: type: string moduleId: type: string moduleConfigId: type: string required: - moduleConfigId - moduleId - primitiveId - primitiveName ShoulderDataDRF: type: object properties: score: type: integer shoulderAffected: type: string shoulderQuestions: $ref: '#/components/schemas/ShoulderQuestionsDRF' required: - shoulderQuestions ShoulderQuestionsDRF: type: object properties: worstPain: type: integer dressing: type: integer transport: type: integer knifeFork: type: integer shopping: type: integer foodTray: type: integer combHair: type: integer usualPain: type: integer hangCloth: type: integer washDry: type: integer workPain: type: integer nightPain: type: integer required: - combHair - dressing - foodTray - hangCloth - knifeFork - nightPain - shopping - transport - usualPain - washDry - workPain - worstPain SignConsentRequestDataDRF: type: object properties: givenName: type: string middleName: type: string familyName: type: string signature: $ref: '#/components/schemas/S3ObjectDRF' sharingOption: type: string privacy: type: boolean feedback: type: boolean agreement: type: boolean additionalConsentAnswers: type: object additionalProperties: {} SignEConsentRequestDataDRF: type: object properties: givenName: type: string middleName: type: string familyName: type: string signature: $ref: '#/components/schemas/S3ObjectDRF' sharingOption: type: string privacy: type: boolean feedback: type: boolean agreement: type: boolean additionalConsentAnswers: type: object additionalProperties: {} consentOption: type: string SignInRequestObjectDRF: type: object properties: language: type: string clientId: type: string projectId: type: string method: type: string email: type: string refreshToken: type: string phoneNumber: type: string confirmationCode: type: string password: type: string deviceAgent: type: string authStage: type: string required: - clientId - method - projectId SignInResponseObjectDRF: type: object properties: authToken: type: string refreshToken: type: string expiresIn: type: integer uid: type: string authTokenExpiresIn: type: integer SignOutRequestObjectV1DRF: type: object properties: id: type: string userId: type: string refreshToken: type: string deviceAgent: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time isActive: type: boolean devicePushId: type: string deviceToken: type: string voipDevicePushId: type: string required: - deviceAgent SignUpRequestObjectDRF: type: object properties: language: type: string clientId: type: string projectId: type: string method: type: string email: type: string contactEmail: type: string phoneNumber: type: string password: type: string displayName: type: string validationData: type: object additionalProperties: {} userAttributes: type: object additionalProperties: {} timezone: type: string ssoEnabled: type: boolean userId: type: string deviceAgent: type: string ipAddress: type: string required: - clientId - ipAddress - method - projectId SleepDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/SleepFeedbackDRF' meal: type: string userNote: type: string awake: type: integer awakeCount: type: integer sleep: type: integer outOfBed: type: integer lightSleep: type: integer deepSleep: type: integer remSleep: type: integer duration: type: integer summary: type: array items: $ref: '#/components/schemas/SleepSummaryObjectDRF' dateOfSleep: type: string format: date-time uwake: type: integer score: type: integer required: - deploymentId - deviceName - duration - moduleId - userId - uwake SleepFeedbackDRF: type: object properties: criteria: type: object additionalProperties: {} text: $ref: '#/components/schemas/FeedbackTextDRF' moduleData: $ref: '#/components/schemas/SleepFeedbackDataDRF' language: type: string notificationData: $ref: '#/components/schemas/FeedbackNotificationDataDRF' SleepFeedbackDataDRF: type: object properties: value: type: integer direction: type: string daysUntilRecommendationReady: type: integer timeStamp: type: string format: date-time average: $ref: '#/components/schemas/NDayAverageDRF' required: - daysUntilRecommendationReady - direction - timeStamp - value SleepQuestionsDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string sleepQualityScore: type: string tiredScore: type: string hoursSleep: type: integer minutesSleep: type: integer required: - deploymentId - deviceName - hoursSleep - minutesSleep - moduleId - sleepQualityScore - tiredScore - userId SleepResultsDRF: type: object properties: Sleep: type: array items: $ref: '#/components/schemas/SleepDTODRF' SleepScoreDRF: type: object properties: total: $ref: '#/components/schemas/ScoreDRF' duration: $ref: '#/components/schemas/ScoreDRF' remSleep: $ref: '#/components/schemas/ScoreDRF' deepSleep: $ref: '#/components/schemas/ScoreDRF' lightSleep: $ref: '#/components/schemas/ScoreDRF' uwake: $ref: '#/components/schemas/ScoreDRF' heartRateDip: $ref: '#/components/schemas/ScoreDRF' submittedTotal: $ref: '#/components/schemas/ScoreDRF' SleepSummaryObjectDRF: type: object properties: dateTime: type: string format: date-time seconds: type: integer SmokeQuestionsDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string smokeStatus: type: string smokerType: type: string smokingPeriod: type: string numberOfCigarettesPerDay: type: integer numberOfCigarettesPerMonth: type: integer vapeStatus: type: string vapePeriodic: type: string required: - deploymentId - deviceName - moduleId - smokeStatus - userId - vapeStatus SnomedMedDataDRF: type: object properties: name: type: string code: type: string system: type: string required: - name SortFieldDRF: type: object properties: field: type: string direction: type: string required: - direction - field SortParametersDRF: type: object properties: status: type: array items: type: string fields: type: array items: type: string extra: $ref: '#/components/schemas/ExtraDRF' order: type: string SpatialSpaniOSDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer required: - deploymentId - deviceName - moduleId - userId - value SpatialSpaniOSResultsDRF: type: object properties: SpatialSpaniOS: type: array items: $ref: '#/components/schemas/SpatialSpaniOSDTODRF' SpirometryDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string pefr: type: number format: double fvc: type: number format: double fev1: type: number format: double fev1pp: type: integer fef2575: type: number format: double ev: type: number format: double height: type: integer sampleRate: type: number format: double forceData: $ref: '#/components/schemas/ForceDataDRF' zeroFlow: type: array items: type: integer rawData: type: array items: type: integer spirometryDevice: $ref: '#/components/schemas/DeviceInfoDRF' acceptability: $ref: '#/components/schemas/AcceptabilityDRF' technicalAcceptability: $ref: '#/components/schemas/TechnicalAcceptabilityDRF' environment: $ref: '#/components/schemas/EnvironmentDRF' location: $ref: '#/components/schemas/LocationDRF' isGood: type: boolean baseline: type: integer required: - deploymentId - deviceName - fev1pp - forceData - moduleId - rawData - sampleRate - spirometryDevice - userId - zeroFlow SpirometryReportDTODRF: type: object properties: id: type: integer userId: type: string reportVersion: type: integer reportCode: type: string name: type: string axes: type: array items: $ref: '#/components/schemas/ReportAxeDRF' series: type: array items: $ref: '#/components/schemas/ReportSeriesDRF' groups: type: array items: $ref: '#/components/schemas/ReportGroupDRF' info: $ref: '#/components/schemas/ReportInfoDRF' startDateTime: type: string format: date-time createDateTime: type: string format: date-time updateDateTime: type: string format: date-time required: - userId SpirometryResultsDRF: type: object properties: Spirometry: type: array items: $ref: '#/components/schemas/SpirometryDTODRF' SportArtQuestionsDRF: type: object properties: technique: type: integer usualActivity: type: integer doingWell: type: integer timeAmount: type: integer required: - doingWell - technique - timeAmount - usualActivity SportsActivityDRF: type: object properties: highestLevel: type: number format: double stairsUp: type: number format: double stairsDown: type: number format: double kneel: type: number format: double squat: type: number format: double sit: type: number format: double rise: type: number format: double run: type: number format: double jumpAndLand: type: number format: double stopAndStart: type: number format: double SsoDRF: type: object properties: name: type: string org: type: string info: $ref: '#/components/schemas/SsoInfoDRF' SsoDTODRF: type: object properties: id: type: string name: type: string org: type: string info: $ref: '#/components/schemas/SsoInfoDRF' SsoInfoDRF: type: object properties: clientId: type: string clientSecret: type: string discoveryUrl: type: string redirectUri: type: string xmlsecBinary: type: string entityid: type: string service: type: object additionalProperties: {} metadata: type: object additionalProperties: {} keyFile: type: string certFile: type: string encryptionKeypairs: type: array items: type: object additionalProperties: {} organization: type: object additionalProperties: {} contactPerson: type: object additionalProperties: {} certificateCrt: type: string samlMetadataXml: type: string privateKey: type: string required: - clientId - clientSecret - discoveryUrl - redirectUri SsoRequestObjectDRF: type: object properties: ssoConfig: $ref: '#/components/schemas/SsoDTODRF' tokens: type: object additionalProperties: {} email: type: string clientId: type: string projectId: type: string required: - clientId - email - projectId StaffDetailsResponseObjectDRF: type: object properties: items: type: array items: $ref: '#/components/schemas/UserDTODRF' required: - items StartRevereTestResponseDRF: type: object properties: id: type: string wordLists: type: array items: $ref: '#/components/schemas/RevereTestWordObjectDRF' required: - id StatDRF: type: object properties: value: type: integer unit: type: string required: - value StaticEventConfigDRF: type: object properties: title: type: string description: type: string preview: type: string required: - description - title StaticEventDRF: type: object properties: enabled: type: boolean isoDuration: type: string title: type: string description: type: string required: - description - enabled - title StatusDetailsDRF: type: object properties: status: type: string StatusResponseObjectDRF: type: object properties: cache: $ref: '#/components/schemas/StatusDetailsDRF' StepDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer weeklyTotal: type: integer multipleValues: type: array items: $ref: '#/components/schemas/MultipleHourValuesDataDRF' rawDataObject: $ref: '#/components/schemas/FlatBufferS3ObjectDRF' dataType: type: string required: - deploymentId - deviceName - moduleId - userId - value StepResultsDRF: type: object properties: Step: type: array items: $ref: '#/components/schemas/StepDTODRF' StudyProgressDRF: type: object properties: currentPeriod: type: integer totalPeriods: type: integer totalCompliance: type: number format: double periodProgress: type: array items: $ref: '#/components/schemas/PeriodProgressDRF' totalOpenQueriesAmount: type: integer SummaryReportDRF: type: object properties: enabled: type: boolean SurgeryChecklistWidgetResponseDRF: type: object properties: checklists: type: array items: $ref: '#/components/schemas/ChecklistDRF' surgeryDate: type: string SurgeryDateRuleDRF: type: object properties: maxPastRange: type: string maxFutureRange: type: string SurgeryDetailDRF: type: object properties: displayString: type: string placeHolder: type: string order: type: integer items: type: array items: $ref: '#/components/schemas/SurgeryDetailItemDRF' required: - displayString - placeHolder SurgeryDetailItemDRF: type: object properties: key: type: string value: type: string order: type: integer required: - key - value SurgeryDetailsDRF: type: object properties: operationType: $ref: '#/components/schemas/SurgeryDetailDRF' implantType: $ref: '#/components/schemas/SurgeryDetailDRF' roboticAssistance: $ref: '#/components/schemas/SurgeryDetailDRF' SurgeryDetailsResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' SurgicalFormDataDRF: type: object properties: id: type: string title: type: string draft: type: boolean dueDateTime: type: string format: date-time userId: type: string submitterId: type: string submitterName: type: string status: type: string questionnaire: type: object additionalProperties: {} moduleConfigId: type: string required: - dueDateTime - moduleConfigId - title - userId SurgicalFormDetailDRF: type: object properties: status: type: string event: $ref: '#/components/schemas/KeyActionEventDRF' result: $ref: '#/components/schemas/QuestionnaireDTODRF' required: - result SymptomDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: array items: type: string complexValues: type: array items: $ref: '#/components/schemas/ComplexSymptomValueDRF' followUpQuestionIds: type: array items: type: string required: - deploymentId - deviceName - moduleId - userId SymptomResultsDRF: type: object properties: Symptom: type: array items: $ref: '#/components/schemas/SymptomDTODRF' SymptomV2ResultsDRF: type: object properties: Symptom: type: array items: $ref: '#/components/schemas/SymptomDTODRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' SymptomsAutocompleteResponseDRF: type: object properties: limit: type: integer skip: type: integer values: type: array items: type: string required: - limit - skip - values SymptomsDRF: type: object properties: painActivity: type: number format: double painHistory: type: number format: double painSeverity: type: number format: double stiffnessHistory: type: number format: double swellingActivity: type: number format: double giveWayLock: type: number format: double giveWayActivity: type: number format: double SymptomsListItemDRF: type: object properties: name: type: string intensity: type: string startDate: type: string format: date-time isResolved: type: boolean endDate: type: string format: date-time required: - intensity - isResolved - name TabOrderItemDRF: type: object properties: id: type: string order: type: integer required: - id - order TabularExportDataDictionaryResponseObjectDRF: type: object properties: fileId: type: string required: - fileId TabularExportUsersRequestObjectDRF: type: object properties: userList: type: array items: type: string fromDateTime: type: string toDateTime: type: string deploymentId: type: string language: type: string machineReadable: type: boolean required: - deploymentId - userList TabularExportUsersResponseObjectDRF: type: object properties: fileId: type: string required: - fileId TagsListResponseDRF: type: object properties: tags: type: array items: type: string required: - tags TakenMedicationDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string medicationName: type: string required: - deploymentId - deviceName - moduleId - userId TakenMedicationResultsDRF: type: object properties: TakenMedication: type: array items: $ref: '#/components/schemas/TakenMedicationDTODRF' TaskComplianceDRF: type: object properties: current: type: integer total: type: integer due: type: integer updateDateTime: type: string format: date-time percentage: type: integer TaskDTODRF: type: object properties: id: type: string nodeName: type: string params: type: object additionalProperties: {} output: type: object additionalProperties: {} nextTaskIds: type: array items: type: string description: type: string required: - id - nodeName TechnicalAcceptabilityDRF: type: object properties: invalidSampleRate: type: boolean invalidFEV1: type: boolean invalidFVC: type: boolean invalidPEFR: type: boolean invalidFEF2575: type: boolean invalidRawFlow: type: boolean invalidForce: type: boolean invalidBackExtrapolation: type: boolean invalidHighFEV1: type: boolean invalidTemperatureChange: type: boolean TegnerDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string activityLevelBefore: type: number format: double activityLevelCurrent: type: number format: double required: - activityLevelBefore - activityLevelCurrent - deploymentId - deviceName - moduleId - userId TemperatureDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double valueUnit: type: string originalValue: type: number format: double originalUnit: type: string required: - deploymentId - deviceName - moduleId - userId - value TemperatureResultsDRF: type: object properties: Temperature: type: array items: $ref: '#/components/schemas/TemperatureDTODRF' TemplateDeploymentOverrideObjectDRF: type: object properties: name: type: string isSaMD: type: boolean TemplateIdRequestObjectDRF: type: object properties: userId: type: string templateId: type: string required: - templateId - userId TemplateImportDeploymentConfigRequestObjectDRF: type: object properties: userId: type: string templateId: type: string organizationId: type: string deploymentOverride: $ref: '#/components/schemas/TemplateDeploymentOverrideObjectDRF' required: - organizationId - templateId - userId ThirdPartyAppDTODRF: type: object properties: id: type: string type: type: string userId: type: string appUserId: type: string accessToken: type: string refreshToken: type: string permissions: type: array items: type: string status: type: string createDateTime: type: string format: date-time updateDateTime: type: string format: date-time lastSyncDateTime: type: string format: date-time required: - accessToken - appUserId - refreshToken - status - type - userId ThirdPartyAppLogDTODRF: type: object properties: id: type: string type: type: string userId: type: string appUserId: type: string moduleLogs: type: array items: type: object additionalProperties: {} createDateTime: type: string format: date-time updateDateTime: type: string format: date-time required: - type - userId ThirdPartyAppStatusResponseDRF: type: object properties: status: type: string ThresholdRangeDRF: type: object properties: minValue: type: number format: double maxValue: type: number format: double exactValueStr: type: string TimeDurationDRF: type: object properties: startTime: type: string endTime: type: string required: - endTime - startTime TimePeriodDRF: type: object properties: year: type: integer month: type: integer week: type: integer day: type: integer hour: type: integer required: - month - year ToDoItemsResponseDRF: type: object properties: id: type: string userId: type: string title: type: string description: type: string model: type: string isRecurring: type: boolean instanceExpiresIn: type: string startDateTime: type: string endDateTime: type: string enabled: type: boolean parentId: type: string hasCustomSchedule: type: boolean isSilent: type: boolean updateDateTime: type: string createDateTime: type: string completeDateTime: type: string appointmentDateTime: type: string format: date-time appointmentStatus: type: string appointmentId: type: string keyActionConfigId: type: string learnArticleId: type: string moduleId: type: string moduleConfigId: type: string deploymentId: type: string learnArticle: $ref: '#/components/schemas/CMSLearnArticleDRF' required: - keyActionConfigId - model ToDoWidgetResponseDRF: type: object properties: events: type: array items: $ref: '#/components/schemas/ToDoItemsResponseDRF' total: type: integer required: - total TreatmentWidgetResponseDRF: type: object properties: title: type: string totalCount: type: integer completedCount: type: integer TriggerTaskRequestObjectDRF: type: object properties: includeUsers: type: array items: type: string dryRun: type: boolean TriggerTaskResponseObjectDRF: type: object properties: result: type: string UITabDRF: type: object properties: order: type: integer id: type: string screenId: type: string name: type: string type: type: string description: type: string icon: type: string status: type: string background: $ref: '#/components/schemas/BackgroundDRF' widgets: type: array items: $ref: '#/components/schemas/UIWidgetDRF' extras: type: object additionalProperties: {} updateDateTime: type: string format: date-time createDateTime: type: string format: date-time required: - background - icon - name - order - status UIWidgetDRF: type: object properties: order: type: integer enabled: type: boolean config: type: object additionalProperties: {} type: type: string id: type: string required: - config - order - type UnlinkProxyRequestDataDRF: type: object properties: proxyId: type: string required: - proxyId UnreadMessagesCountDRF: type: object properties: manager: type: integer user: type: integer UnseenFlagsDRF: type: object properties: red: type: integer amber: type: integer green: type: integer gray: type: integer UnseenModuleResultDRF: type: object properties: moduleId: type: string moduleConfigId: type: string flags: $ref: '#/components/schemas/FlagsDRF' UnseenModulesResponseDRF: type: object properties: flags: type: array items: $ref: '#/components/schemas/UnseenModuleResultDRF' lastManagerNote: type: string format: date-time UnseenResultDTODRF: type: object properties: id: type: string userId: type: string deploymentId: type: string moduleId: type: string moduleConfigId: type: string primitiveName: type: string extra: type: object additionalProperties: {} flags: $ref: '#/components/schemas/UnseenFlagsDRF' source: type: string startDateTime: type: string format: date-time createDateTime: type: string format: date-time required: - deploymentId - flags - moduleId - primitiveName - userId UpdateAutoCompleteSearchMetadataRequestObjectDRF: type: object properties: metadata: type: array items: $ref: '#/components/schemas/AutocompleteMetadataDTODRF' required: - metadata UpdateChargeUnitRequestObjectDRF: type: object properties: billId: type: string chargeId: type: string charge: $ref: '#/components/schemas/ChargeUnitRecordRequestObjectDRF' required: - billId - charge - chargeId UpdateClientDeploymentRequestObjectDRF: type: object properties: clientId: type: string deploymentId: type: string UpdateContentRequestObjectDRF: type: object properties: id: type: string status: type: string data: type: object additionalProperties: {} draftData: type: object additionalProperties: {} schema: type: string tags: type: array items: type: string resources: type: array items: type: string owner: type: string editors: type: array items: type: string viewers: type: array items: type: string version: type: integer updateDateTime: type: string format: date-time publishDateTime: type: string format: date-time createDateTime: type: string format: date-time required: - schema - status UpdateDeploymentPluginConfigRequestObjectDRF: type: object properties: deploymentId: type: string configContents: type: object additionalProperties: {} configName: type: string required: - configContents - configName - deploymentId UpdateDeploymentRequestBodyDRF: type: object properties: termAndConditionUrl: type: string privacyPolicyUrl: type: string eulaUrl: type: string privacyPolicyObject: $ref: '#/components/schemas/S3ObjectDRF' termAndConditionObject: $ref: '#/components/schemas/S3ObjectDRF' eulaObject: $ref: '#/components/schemas/S3ObjectDRF' authorisedRep: $ref: '#/components/schemas/AuthorisedRepDRF' roles: type: array items: $ref: '#/components/schemas/RoleDTODRF' sso: $ref: '#/components/schemas/SsoDRF' id: type: string draftId: type: string name: type: string description: type: string status: type: string color: type: string icon: $ref: '#/components/schemas/S3ObjectDRF' iconFileId: type: string templateThumbnailFileId: type: string descriptionUrl: type: string isSaMD: type: boolean updateDateTime: type: string format: date-time createDateTime: type: string format: date-time moduleConfigs: type: array items: $ref: '#/components/schemas/ModuleConfigDRF' onboardingConfigs: type: array items: $ref: '#/components/schemas/OnboardingModuleConfigDTODRF' learn: $ref: '#/components/schemas/LearnDRF' consent: $ref: '#/components/schemas/ConsentDRF' econsent: $ref: '#/components/schemas/EConsentDRF' keyActions: type: array items: $ref: '#/components/schemas/KeyActionConfigDRF' keyActionsEnabled: type: boolean profile: $ref: '#/components/schemas/ProfileDRF' features: $ref: '#/components/schemas/FeaturesDRF' extraCustomFields: type: object additionalProperties: {} surgeryDetails: $ref: '#/components/schemas/SurgeryDetailsDRF' contactUsURL: type: string integration: $ref: '#/components/schemas/IntegrationConfigDRF' language: type: string duration: type: string security: $ref: '#/components/schemas/SecurityDRF' mfaRequired: type: boolean code: type: string enrollmentCounter: type: integer staticEventConfig: $ref: '#/components/schemas/StaticEventConfigDRF' stats: $ref: '#/components/schemas/DeploymentStatsDRF' localizations: type: object additionalProperties: {} country: type: string dashboardConfiguration: $ref: '#/components/schemas/DeploymentLevelConfigurationDRF' labels: type: array items: $ref: '#/components/schemas/LabelDRF' tags: type: array items: type: string location: $ref: '#/components/schemas/LocationDRF' integrationDevices: type: array items: $ref: '#/components/schemas/IntegrationDeviceDRF' componentConfigs: type: object additionalProperties: {} defaultUnits: type: object additionalProperties: {} builder: $ref: '#/components/schemas/BuilderDRF' programId: type: integer LocalizableFields: type: array items: type: string title: ' localizablefields' UpdateHistoryRequestObjectDRF: type: object properties: userId: type: string gameId: type: string score: type: integer updatedHistory: type: array items: $ref: '#/components/schemas/ScoreHistoryItemDRF' previousRank: type: string updatedRank: type: string required: - gameId - previousRank - score - updatedHistory - updatedRank - userId UpdateInstructionsShownHistoryRequestObjectDRF: type: object properties: userId: type: string keys: type: array items: type: string required: - keys - userId UpdateIntegrationRequestDataDRF: type: object properties: organizationIds: type: array items: type: string deploymentIds: type: array items: type: string moduleNames: type: array items: type: string excludedModuleNames: type: array items: type: string integrationType: type: string webhook: $ref: '#/components/schemas/WebhookDTODRF' kafka: $ref: '#/components/schemas/KafkaDRF' gcpFhir: $ref: '#/components/schemas/GCPFhirDTODRF' genericEhr: $ref: '#/components/schemas/GenericEHRDTODRF' name: type: string enabled: type: boolean required: - deploymentIds - integrationType - name - organizationIds UpdateIsSubmittedResponseObjectDRF: type: object properties: id: type: string isSubmitted: type: boolean UpdateLabelRequestObjectBodyDRF: type: object properties: text: type: string required: - text UpdateMedicationRequestObjectDRF: type: object properties: id: type: string prn: type: boolean enabled: type: boolean userId: type: string deploymentId: type: string moduleId: type: string name: type: string doseQuantity: type: number format: double doseUnits: type: string schedule: $ref: '#/components/schemas/MedicationScheduleDRF' extraProperties: type: object additionalProperties: {} updateDateTime: type: string format: date-time createDateTime: type: string format: date-time changeHistory: type: array items: $ref: '#/components/schemas/MedicationHistoryDRF' required: - userId UpdateMedicationRequestObjectV2DRF: type: object properties: id: type: string enabled: type: boolean userId: type: string deploymentId: type: string moduleId: type: string moduleConfigId: type: string coding: type: array items: $ref: '#/components/schemas/CodingDRF' dosage: type: number format: double unit: type: string customUnit: type: string indication: $ref: '#/components/schemas/IndicationDRF' isNotificationEnabled: type: boolean maxDosage: type: number format: double schedule: $ref: '#/components/schemas/MedicationV2ScheduleDRF' submitterId: type: string reason: type: string submitterUserType: type: string startDate: type: string format: date-time endDate: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time additionalFields: $ref: '#/components/schemas/AdditionalFieldsDRF' mealSchedule: type: array items: $ref: '#/components/schemas/MedicationMealScheduleDRF' connectedModules: type: array items: type: string groupId: type: string user: $ref: '#/components/schemas/UserDTODRF' deployment: $ref: '#/components/schemas/DeploymentDTODRF' submitter: $ref: '#/components/schemas/UserDTODRF' moduleConfig: $ref: '#/components/schemas/ModuleConfigDRF' required: - enabled UpdateModuleConfigRequestObjectDRF: type: object properties: id: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time moduleId: type: string moduleName: type: string shortModuleName: type: string status: type: string order: type: integer configBody: type: object additionalProperties: {} about: type: string footnote: $ref: '#/components/schemas/FootnoteDRF' schedule: $ref: '#/components/schemas/ModuleScheduleDRF' ragThresholds: type: array items: $ref: '#/components/schemas/RagThresholdDRF' learnArticleIds: type: array items: type: string version: type: integer staticEvent: $ref: '#/components/schemas/StaticEventDRF' notificationData: $ref: '#/components/schemas/NotificationDataDRF' localizationPrefix: type: string goal: $ref: '#/components/schemas/ModuleGoalDTODRF' goalEnabled: type: boolean feedback: $ref: '#/components/schemas/FeedbackConfigDRF' feedbackTexts: type: array items: $ref: '#/components/schemas/FeedbackTextsDRF' readOnly: type: boolean LocalizableFields: type: array items: type: string title: ' localizablefields' required: - moduleId UpdateModuleResultFailureResponseDRF: type: object properties: id: type: string errors: type: array items: type: string required: - errors UpdateModuleResultStatusResponseObjectDRF: type: object properties: modifiedFormsCount: type: integer required: - modifiedFormsCount UpdateOrderRequestObjectDRF: type: object properties: userId: type: string orderId: type: string status: type: string cart: type: array items: $ref: '#/components/schemas/OrderItemDRF' UpdateOrganizationDTORequestBodyDRF: type: object properties: termAndConditionUrl: type: string privacyPolicyUrl: type: string eulaUrl: type: string privacyPolicyObject: $ref: '#/components/schemas/S3ObjectDRF' termAndConditionObject: $ref: '#/components/schemas/S3ObjectDRF' eulaObject: $ref: '#/components/schemas/S3ObjectDRF' authorisedRep: $ref: '#/components/schemas/AuthorisedRepDRF' id: type: string name: type: string status: type: string enrollmentTarget: type: integer studyCompletionTarget: type: integer viewType: type: string targetConsented: type: integer dashboardId: type: string features: $ref: '#/components/schemas/FeaturesDRF' intercom: $ref: '#/components/schemas/IntercomSettingsDRF' security: type: object additionalProperties: {} pluginConfigContainerId: type: string sso: $ref: '#/components/schemas/SsoDRF' UpdateOrganizationPluginConfigRequestObjectDRF: type: object properties: organizationId: type: string configContents: type: object additionalProperties: {} configName: type: string required: - configContents - configName - organizationId UpdatePersonalReminderRequestDataDRF: type: object properties: title: type: string description: type: string isRecurring: type: boolean instanceExpiresIn: type: string startDateTime: type: string endDateTime: type: string enabled: type: boolean extraFields: type: object additionalProperties: {} parentId: type: string snoozing: type: array items: type: string hasCustomSchedule: type: boolean isSilent: type: boolean completeDateTime: type: string durationIso: type: string specificWeekDays: type: array items: type: string specificMonthDays: type: array items: type: integer oldReminder: $ref: '#/components/schemas/CalendarEventDTODRF' UpdatePluginConfigResponseObjectDRF: type: object properties: configName: type: string required: - configName UpdatePregnancyRequestObjectDRF: type: object properties: userId: type: string dueDate: type: string required: - dueDate UpdateQuestionnaireObjectDRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string answers: type: array items: $ref: '#/components/schemas/QuestionnaireAnswerDRF' appResult: $ref: '#/components/schemas/QuestionnaireAppResultDRF' isForManager: type: boolean questionnaireId: type: string questionnaireName: type: string value: type: number format: double skipped: type: array items: $ref: '#/components/schemas/QuestionnaireAnswerDRF' updateDateTime: type: string format: date-time signOffDateTime: type: string format: date-time status: type: string revision: type: integer type: type: string required: - answers - deploymentId - deviceName - moduleId - questionnaireId - questionnaireName - type - userId UpdateTabRequestDataDRF: type: object properties: order: type: integer screenId: type: string name: type: string type: type: string description: type: string icon: type: string status: type: string background: $ref: '#/components/schemas/BackgroundDRF' extras: type: object additionalProperties: {} updateDateTime: type: string format: date-time createDateTime: type: string format: date-time required: - background - icon - name - order - status UpdateUserModuleReminderRequestDataDRF: type: object properties: title: type: string description: type: string isRecurring: type: boolean instanceExpiresIn: type: string startDateTime: type: string endDateTime: type: string enabled: type: boolean extraFields: type: object additionalProperties: {} parentId: type: string snoozing: type: array items: type: string hasCustomSchedule: type: boolean isSilent: type: boolean completeDateTime: type: string durationIso: type: string specificWeekDays: type: array items: type: string specificMonthDays: type: array items: type: integer oldReminder: $ref: '#/components/schemas/CalendarEventDTODRF' moduleId: type: string moduleConfigId: type: string required: - moduleConfigId - moduleId UpdateUserProfileRequestDataDRF: type: object properties: givenName: type: string familyName: type: string gender: type: string biologicalSex: type: string ethnicity: type: string dateOfBirth: type: string format: date-time calendarLink: type: string primaryAddress: type: string race: type: string bloodGroup: type: string emergencyPhoneNumber: type: string height: type: number format: double additionalContactDetails: $ref: '#/components/schemas/AdditionalContactDetailsDRF' familyMedicalHistory: type: string pastHistory: type: string presentSymptoms: type: string operationHistory: type: string chronicIllness: type: string allergyHistory: type: string pregnancy: type: string dateOfLastPhysicalExam: type: string format: date-time extraCustomFields: type: object additionalProperties: {} surgeryDetails: $ref: '#/components/schemas/UserSurgeryDetailsDRF' fenlandCohortId: type: string nhsId: type: string insuranceNumber: type: string wechatId: type: string kardiaId: type: string pamThirdPartyIdentifier: type: string medicalRecordNumber: type: string timezone: type: string labels: type: array items: $ref: '#/components/schemas/UserLabelDRF' tagsAuthorId: type: string surgeryDateTime: type: string format: date-time preferences: type: object additionalProperties: {} preferredUnits: type: object additionalProperties: {} addressComponent: $ref: '#/components/schemas/AddressObjectDRF' language: type: string finishedOnboarding: type: boolean onboardingConfigs: type: array items: $ref: '#/components/schemas/OnboardingModuleConfigDTODRF' componentsData: type: object additionalProperties: {} intercomHash: type: string managerNotifications: $ref: '#/components/schemas/ManagerNotificationsDRF' profilePicture: $ref: '#/components/schemas/FileFieldDRF' createdByManager: type: boolean unreadMessagesCount: $ref: '#/components/schemas/UnreadMessagesCountDRF' deviceName: type: string UpdateUserRatingRequestObjectDRF: type: object properties: id: type: string userId: type: string deploymentId: type: string createDateTime: type: string format: date-time updateDateTime: type: string format: date-time rating: type: string required: - rating - userId UpdateWorkflowRequestObjectDRF: type: object properties: id: type: string name: type: string tasks: type: array items: $ref: '#/components/schemas/TaskDTODRF' resourceId: type: array items: type: string startNode: type: string schedule: type: string status: type: string createDateTime: type: string format: date-time updateDateTime: type: string format: date-time publishedWorkflowId: type: string isDraft: type: boolean workflowId: type: string required: - name - tasks UploadFileRequestObjectV1DRF: type: object properties: file: type: string fileData: type: string fileName: type: string fileSize: type: integer contentType: type: string userId: type: string required: - file UploadFileResponseObjectV1DRF: type: object properties: id: type: string UploadFirmwareRequestObjectDRF: type: object properties: make: type: string model: type: string file: type: string version: type: string releaseNotes: type: string overwrite: type: boolean required: - file - make - model - version UploadFirmwareResponseObjectDRF: type: object properties: make: type: string model: type: string fileURL: type: string metadata: $ref: '#/components/schemas/FirmwareMetadataDRF' required: - fileURL - make - metadata - model UpsertBillingRecordRequestObjectDRF: type: object properties: deploymentId: type: string patientId: type: string provider: type: string diagnosisType: type: string deviceConnectionDate: type: string format: date-time primaryInsurance: type: string workFlow: type: string reportEndDate: type: string format: date-time isEligible: type: boolean monitoringMinutes: type: integer numberOfCalls: type: integer monthReading: type: integer consentDate: type: string format: date-time consentId: type: string deviceType: type: string deviceModel: type: string charges: type: array items: $ref: '#/components/schemas/ChargeUnitRecordRequestObjectDRF' required: - consentDate - reportEndDate UpsertBillingRecordResponseObjectDRF: type: object properties: id: type: string chargeIds: type: array items: type: string UrlResponseDRF: type: object properties: noDataUrl: type: string withDataUrl: type: string UserAgentDRF: type: object properties: product: type: string version: type: string softwareName: type: string softwareVersion: type: string bundleId: type: string build: type: string hardware: type: string component: type: string language: type: string clientType: type: string required: - product - softwareName - softwareVersion - version UserDTODRF: type: object properties: id: type: string updateDateTime: type: string format: date-time createDateTime: type: string format: date-time lastSubmitDateTime: type: string format: date-time givenName: type: string familyName: type: string gender: type: string biologicalSex: type: string ethnicity: type: string dateOfBirth: type: string format: date-time email: type: string calendarLink: type: string phoneNumber: type: string primaryAddress: type: string race: type: string bloodGroup: type: string emergencyPhoneNumber: type: string height: type: number format: double additionalContactDetails: $ref: '#/components/schemas/AdditionalContactDetailsDRF' familyMedicalHistory: type: string pastHistory: type: string presentSymptoms: type: string operationHistory: type: string chronicIllness: type: string allergyHistory: type: string pregnancy: type: string dateOfLastPhysicalExam: type: string format: date-time extraCustomFields: type: object additionalProperties: {} surgeryDetails: $ref: '#/components/schemas/UserSurgeryDetailsDRF' fenlandCohortId: type: string nhsId: type: string insuranceNumber: type: string wechatId: type: string kardiaId: type: string pamThirdPartyIdentifier: type: string medicalRecordNumber: type: string roles: type: array items: $ref: '#/components/schemas/RoleAssignmentDTODRF' timezone: type: string recentModuleResults: type: object additionalProperties: {} tags: type: object additionalProperties: {} labels: type: array items: $ref: '#/components/schemas/UserLabelDRF' tagsAuthorId: type: string surgeryDateTime: type: string format: date-time preferences: type: object additionalProperties: {} preferredUnits: type: object additionalProperties: {} addressComponent: $ref: '#/components/schemas/AddressObjectDRF' personalDocuments: type: array items: $ref: '#/components/schemas/PersonalDocumentDRF' enrollmentId: type: integer enrollmentNumber: type: string deployments: type: array items: type: string deploymentsInfo: type: array items: $ref: '#/components/schemas/DeploymentInfoDRF' boardingStatus: $ref: '#/components/schemas/BoardingStatusDRF' language: type: string finishedOnboarding: type: boolean stats: $ref: '#/components/schemas/UserStatsDRF' ragScore: type: array items: type: integer flags: $ref: '#/components/schemas/UnseenFlagsDRF' unseenFlags: $ref: '#/components/schemas/UnseenFlagsDRF' recentFlags: $ref: '#/components/schemas/RecentFlagsDRF' lastLoginDateTime: type: string format: date-time badges: type: object additionalProperties: {} onboardingConfigs: type: array items: $ref: '#/components/schemas/OnboardingModuleConfigDTODRF' researchTeamActions: $ref: '#/components/schemas/ResearchTeamActionsDRF' hasAssignedManagers: type: boolean componentsData: type: object additionalProperties: {} contactEmail: type: string assignedManagers: type: array items: type: string assignedProxies: type: array items: type: object additionalProperties: {} assignedParticipants: type: array items: type: object additionalProperties: {} assignedUsersCount: type: integer proxyStatus: type: string status: type: string ragThresholds: type: object additionalProperties: {} intercomHash: type: string managerNotifications: $ref: '#/components/schemas/ManagerNotificationsDRF' profilePicture: $ref: '#/components/schemas/FileFieldDRF' createdByManager: type: boolean unreadMessagesCount: $ref: '#/components/schemas/UnreadMessagesCountDRF' userId: type: string UserDataResponseDRF: type: object properties: userId: type: string scoreHistory: type: object additionalProperties: {} rank: type: object additionalProperties: {} instructionsShownHistory: type: object additionalProperties: {} required: - instructionsShownHistory - rank - scoreHistory - userId UserLabelDRF: type: object properties: labelId: type: string assignedBy: type: string assignDateTime: type: string format: date-time UserMoveHistoryDTODRF: type: object properties: id: type: string createDateTime: type: string format: date-time startDateTime: type: string format: date-time submitterId: type: string submitterName: type: string surgeryDate: type: string format: date-time userId: type: string resourceId: type: string resourceName: type: string targetResourceId: type: string details: $ref: '#/components/schemas/MoveUserDetailsDRF' offBoardingDetails: $ref: '#/components/schemas/BoardingStatusDRF' isAcknowledged: type: boolean required: - details UserNoteDTODRF: type: object properties: id: type: string type: type: string userId: type: string deploymentId: type: string submitterId: type: string submitterName: type: string note: type: string moduleConfigId: type: string answers: type: array items: $ref: '#/components/schemas/QuestionnaireAnswerDRF' questionnaireId: type: string createDateTime: type: string format: date-time seenResults: type: array items: $ref: '#/components/schemas/SeenResultDataDRF' resultsSeenFrom: type: string format: date-time resultsSeenTo: type: string format: date-time UserStatsDRF: type: object properties: taskCompliance: $ref: '#/components/schemas/TaskComplianceDRF' studyProgress: $ref: '#/components/schemas/StudyProgressDRF' UserSurgeryDetailsDRF: type: object properties: operationType: type: string implantType: type: string roboticAssistance: type: string UsersInfoDRF: type: object properties: userId: type: string email: type: string required: - userId VAChartConfigDRF: type: object properties: legends: type: array items: type: string yMinValue: type: integer yMaxValue: type: integer yMinLabel: type: string yMaxLabel: type: string backgroundLinesNumber: type: integer required: - backgroundLinesNumber - legends - yMaxLabel - yMaxValue - yMinLabel - yMinValue VADataResponseObjectDRF: type: object properties: unit: type: array items: type: string data: type: array items: $ref: '#/components/schemas/VitalsDataFieldDRF' value: type: array items: type: string description: type: string date: type: string format: date-time seen: type: boolean footer: type: array items: $ref: '#/components/schemas/FootnoteDRF' learnArticles: type: array items: $ref: '#/components/schemas/CMSLearnArticleDRF' chartConfig: $ref: '#/components/schemas/VAChartConfigDRF' required: - chartConfig - seen - unit VR_12DTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string physicalScore: type: number format: double mentalScore: type: number format: double required: - deploymentId - deviceName - mentalScore - moduleId - physicalScore - userId VR_12ResultsDRF: type: object properties: VR12: type: array items: $ref: '#/components/schemas/VR_12DTODRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' VaccinationDetailsDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string skipped: type: array items: type: string vaccinatedPlace: type: string vaccinationLocation: type: string vaccinationCity: type: string batchNumber: type: string isBatchNumberValid: type: boolean isSecondDoseVacc: type: string secondVacScheduleDate: type: string format: date-time isSeasonFluVac: type: boolean seasonFluVacDate: type: string format: date-time isOtherSpecifiedVacc: type: boolean otherSpecifiedVacc: type: array items: type: string otherVaccCategory: type: array items: $ref: '#/components/schemas/OtherVaccCategoryItemDRF' isAllergicReactionVacc: type: string allergicReactionVacc: type: array items: type: string allergicReaction: type: array items: type: string metadata: $ref: '#/components/schemas/QuestionnaireMetadataDRF' required: - batchNumber - deploymentId - deviceName - isAllergicReactionVacc - isOtherSpecifiedVacc - isSeasonFluVac - isSecondDoseVacc - moduleId - userId - vaccinatedPlace - vaccinationCity VaccinationDetailsResultsDRF: type: object properties: VaccinationDetails: type: array items: $ref: '#/components/schemas/VaccinationDetailsDTODRF' VaccineListItemDRF: type: object properties: name: type: string vaccinatedDate: type: string format: date-time required: - name ValidatePhoneNumberTypeRequestObjectDRF: type: object properties: phoneNumber: type: string required: - phoneNumber ValidateQuestionnaireDimensionsRequestObjectDRF: type: object properties: configBody: type: object additionalProperties: {} required: - configBody ValidateWidgetRequestDataDRF: type: object properties: order: type: integer enabled: type: boolean config: type: object additionalProperties: {} type: type: string id: type: string required: - config - type VariabilityFilterDRF: type: object properties: increased: type: array items: type: string decreased: type: array items: type: string noChange: type: array items: type: string unavailable: type: array items: type: string VerifyCredentialsRequestObjectDRF: type: object properties: language: type: string clientId: type: string projectId: type: string authToken: type: string password: type: string confirmationCode: type: string phoneNumber: type: string type: type: string required: - authToken - clientId - projectId - type VerifyPublicModuleRequestObjectDRF: type: object properties: dateOfBirth: type: string format: date-time clientId: type: string projectId: type: string required: - clientId - dateOfBirth - projectId VerifyPublicModuleResponseObjectDRF: type: object properties: ok: type: boolean authToken: type: string VersionDRF: type: object properties: server: type: string api: type: string build: type: string sdk: $ref: '#/components/schemas/BaseVersionDRF' plugins: type: array items: $ref: '#/components/schemas/NamedVersionDRF' required: - api - sdk - server VersionsResponseObjectDRF: type: object properties: versions: type: array items: type: string VideoCallLogDTODRF: type: object properties: id: type: string event: type: string identity: type: string createDateTime: type: string format: date-time required: - event VirtualCareDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string deploymentVersion: type: integer required: - deploymentId - deviceName - moduleId - userId VirtualCareResultsDRF: type: object properties: VirtualCare: type: array items: $ref: '#/components/schemas/VirtualCareDTODRF' VirtualCareWidgetResponseDRF: type: object properties: recommendations: type: array items: $ref: '#/components/schemas/CMSRecommendationDTODRF' value: type: array items: type: string units: type: array items: type: string date: type: string format: date-time greeting: type: string title: type: string VirtualVisitResponseDRF: type: object properties: moduleResultId: type: string startDateTime: type: string format: date-time primaryStepSummary: $ref: '#/components/schemas/PrimaryStepViewDRF' stepsSummary: type: array items: type: string VitalsDataFieldDRF: type: object properties: x: type: integer y: type: array items: type: number format: double t: type: string required: - t - x - y VitalsDataResponseObjectDRF: type: object properties: unit: type: array items: type: string data: type: array items: $ref: '#/components/schemas/VitalsDataFieldDRF' value: type: array items: type: string description: type: string date: type: string format: date-time seen: type: boolean footer: type: array items: $ref: '#/components/schemas/FootnoteDRF' learnArticles: type: array items: $ref: '#/components/schemas/CMSLearnArticleDRF' required: - seen - unit VoiceAssessmentsResultsDRF: type: object properties: Dysphonia: type: array items: $ref: '#/components/schemas/DysphoniaDTODRF' Dysarthria: type: array items: $ref: '#/components/schemas/DysarthriaDTODRF' WHOResultsDRF: type: object properties: Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' WHOWidgetResponseDRF: type: object properties: unit: type: array items: type: string data: type: array items: type: string value: type: array items: type: string description: type: string date: type: string format: date-time seen: type: boolean footer: type: array items: $ref: '#/components/schemas/FootnoteDRF' learnArticles: type: array items: $ref: '#/components/schemas/CMSLearnArticleDRF' required: - unit WHQDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: integer required: - deploymentId - deviceName - moduleId - userId - value WHQResultsDRF: type: object properties: WHQ: type: array items: $ref: '#/components/schemas/WHQDTODRF' Questionnaire: type: array items: $ref: '#/components/schemas/QuestionnaireDTODRF' WOMACDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string painScore: type: number format: double symptomsScore: type: number format: double adlScore: type: number format: double totalScore: type: number format: double required: - adlScore - deploymentId - deviceName - moduleId - painScore - symptomsScore - totalScore - userId WaistToHeightDRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string height: type: number format: double waist: type: number format: double value: type: number format: double required: - deploymentId - deviceName - height - moduleId - userId WaistToHeightResultsDRF: type: object properties: WaistToHeight: type: array items: $ref: '#/components/schemas/WaistToHeightDRF' WebhookDTODRF: type: object properties: endpoint: type: string authType: type: string username: type: string password: type: string retry: type: integer token: type: string required: - authType - endpoint WeightDTODRF: type: object properties: id: type: string userId: type: string moduleId: type: string moduleConfigId: type: string moduleResultId: type: string deploymentId: type: string version: type: integer deviceName: type: string isAggregated: type: boolean startDateTime: type: string format: date-time endDateTime: type: string format: date-time createDateTime: type: string format: date-time submitterId: type: string correlationStartDateTime: type: string format: date-time client: $ref: '#/components/schemas/UserAgentDRF' server: $ref: '#/components/schemas/ServerDRF' ragThreshold: type: object additionalProperties: {} flags: type: object additionalProperties: {} eventLogId: type: string device: $ref: '#/components/schemas/DeviceDetailsDRF' source: type: string isAverage: type: boolean noteId: type: string feedback: $ref: '#/components/schemas/ModuleFeedbackDRF' meal: type: string userNote: type: string value: type: number format: double valueUnit: type: string originalValue: type: number format: double originalUnit: type: string required: - deploymentId - deviceName - moduleId - userId - value WeightResultsDRF: type: object properties: Weight: type: array items: $ref: '#/components/schemas/WeightDTODRF' WelcomeWidgetResponseObjectDRF: type: object properties: completed: type: boolean sections: type: array items: $ref: '#/components/schemas/AppSectionDRF' required: - completed WithdrawEConsentRequestBodyDRF: type: object properties: logId: type: string required: - logId WorkQuestionsDRF: type: object properties: technique: type: integer usualActivity: type: integer doingWell: type: integer timeAmount: type: integer required: - doingWell - technique - timeAmount - usualActivity WorkflowDTODRF: type: object properties: id: type: string name: type: string tasks: type: array items: $ref: '#/components/schemas/TaskDTODRF' resourceId: type: array items: type: string startNode: type: string schedule: type: string submitterId: type: string status: type: string createDateTime: type: string format: date-time updateDateTime: type: string format: date-time publishedWorkflowId: type: string isDraft: type: boolean required: - name - tasks _CDSCardMessageDRF: type: object properties: type: type: string text: type: string securitySchemes: Hawk Auth: type: apiKey in: header name: Authorization description: |- Hawk MAC authentication. Paste a full Authorization header value. Example: Authorization: Hawk id="userId:clientId", ts="", nonce="", mac=""[, hash=""][, ext=""] Note: Swagger UI cannot generate Hawk headers. Use your client to compute the MAC (e.g., with mohawk), then paste the full value here. JWT Auth: type: http scheme: bearer in: header bearerFormat: JWT description: |- Use HTTP Bearer auth with a JWT. Send the token in the Authorization header: Authorization: Bearer The token should contain standard claims plus projectId and clientId in user claims. jwtAuth: type: http scheme: bearer bearerFormat: JWT