Settings

Platform API is designed to provide accurate and efficient medical guidance. Its performance and behavior can be tailored to meet specific needs through a variety of workflows and configuration settings. The settings described on this page will help you configure the platform according to your business and operational requirements.

Feature Flags

Feature flags are used to enhance the functionality of the Platform API by allowing specific requirements to be set. Below is a detailed description of each feature flag:

Pediatrics

The PEDIATRICS flag is a boolean value indicating whether the paid Pediatrics feature is enabled. When activated, the Platform API knowledge base is extended to include pediatric conditions, symptoms, and risk factors, allowing the service to be used for children. By default, this feature is set to false and requires the Infermedica team to explicitly activate it for it to be set to true.

The min_age flag, an integer, specifies the minimum age of a patient that can be assessed using Platform API. The default minimum age is 18, but it changes to 0 when the PEDIATRICS feature is enabled, allowing assessments for pediatric patients.

Conversely, the max_age flag is an integer that defines the maximum age of a patient that can be assessed using the Platform API. This value is set to 130 by default, providing a broad age range for patient assessments.

For more information about age, see Patients.

Patient Education

The PATIENT_EDUCATION flag is a boolean value that controls the paid Patient Education feature. When enabled, this feature enriches the response of the Platform API /evidence_assessment endpoint with Patient Education articles compiled by medical experts. By default, this feature is disabled (false) and needs to be explicitly enabled by contacting the Infermedica team.

Symptom duration

The SYMPTOM_DURATION flag, also a boolean, indicates whether the symptom duration feature is active. This feature adds extra questions to the interview regarding the persistence of symptoms. It is disabled (false) by default but can be enabled upon request.

Sensitive questions

The SENSITIVE_QUESTIONS flag is another boolean value that determines whether questions of a sensitive nature are included in the interview. This feature, which includes questions about intimate concepts such as sexual activity, is enabled by default (true). To exclude these questions from the interview, this flag must be explicitly set to false by contacting the Infermedica team.

Biological sex question

The BIOLOGICAL_SEX_QUESTION flag, a boolean, controls the phrasing of the biological_sex question. When set to false, the question is asked in its basic form, "What is your sex?". When set to true, the question is worded more specifically as, "What sex was originally listed on your birth certificate?".

These feature flags provide flexibility and configurability to better serve the diverse needs of the patients and healthcare providers that opt for Platform API.

Language Settings

The language settings can be used to configure the language in which Platform API conducts its interviews and responds to client requests. Here's a detailed explanation of each language setting:

The DEFAULT_LANGUAGE setting is controlled by a two-letter country code conforming to the ISO 3166-1 alpha-2 standard. This setting determines the default language of the questions that Platform API will use during the interview. By default, the language is set to English (en). The possible values for this setting are defined within the SUPPORTED_LANGUAGES list.

The SUPPORTED_LANGUAGES setting is a list of two-letter country codes (ISO 3166-1 alpha-2) that specifies the languages in which Platform API can respond during the interview. While the DEFAULT_LANGUAGE controls the language in the absence of a x-user-language HTTP request header, the API client can include this header to override the response language for a single HTTP request. If the language specified in the x-user-language header is not included in the SUPPORTED_LANGUAGES list, Platform API will default to the language set in DEFAULT_LANGUAGE.

Instance Settings

The instance settings for Platform API provide control over various aspects of the user experience, particularly regarding authentication and communication methods. Below is a detailed description of each instance setting:

The MAGIC_LINK_EXPIRATION_TIME_SECONDS setting is an integer value that defines the expiration time for the magic link used in authentication. After the specified number of seconds elapses, the magic link becomes invalid. By default, this value is set to 300 seconds, but it can be configured to any value between 0 and 2,147,483,647 seconds.

The SURVEY_TYPES setting is a list of strings indicating the modules that include interview types. By default, this list contains a single item: intake.

The SMS_SENDER_NAME setting specifies the alphanumeric name used as the Sender ID in SMS notifications sent to end users. This name, representing your company or brand, can be up to 11 characters long and may include upper- and lower-case ASCII letters, digits (0-9), and spaces. The default sender name is Infermedica.

The DEFAULT_CONTACT_METHOD setting determines the preferred method for sending verification codes to end users, either via sms or email. By default, the contact method is set to email.

These settings provide flexibility and control over authentication flows and communication preferences, ensuring a secure and user-friendly experience.