--- openapi: 3.0.0 info: title: Nimbo API version: 1.0.0 description: Nimbo API reference. Use the API host and integration access provided by Nimbo. servers: - url: https://api.example.test description: Reference only; confirm your integration host with Nimbo paths: "/custom_fields": get: summary: GET /custom_fields parameters: - name: applicable_model in: query schema: type: string - name: page in: query schema: type: integer - name: query in: query schema: type: string responses: '200': description: Successful response tags: - Patient Management - CustomFields operationId: legacy_nimbo_api_get__custom_fields post: summary: POST /custom_fields responses: '200': description: Successful response tags: - Patient Management - CustomFields requestBody: content: application/json: schema: type: object properties: custom_field: type: object properties: key: nullable: true name: type: string section_name: type: string default_options: type: object default_component: type: string applicable_model: type: string organization_id: nullable: true operationId: legacy_nimbo_api_post__custom_fields parameters: [] "/people/{people_id}/custom_form_response": get: summary: GET /people/{people_id}/custom_form_response responses: '200': description: Successful response tags: - Patient Management - CustomFields security: - BearerAuth: [] operationId: legacy_nimbo_api_get__people_people_id_custom_form_response parameters: - name: people_id in: path required: true schema: type: string "/custom_form_responses": post: summary: 'POST /custom_form_responses ' responses: '200': description: Successful response tags: - Patient Management - CustomFields requestBody: content: application/json: schema: type: object operationId: legacy_nimbo_api_post__custom_form_responses parameters: [] "/consultation_surveys/{consultation_survey_id}/custom_form_response": get: summary: GET /consultation_surveys/{consultation_survey_id}/custom_form_response responses: '200': description: Successful response tags: - Patient Management - CustomFields operationId: legacy_nimbo_api_get__consultation_surveys_consultation_survey_id_custom_form_response parameters: - name: consultation_survey_id in: path required: true schema: type: string "/people": post: summary: POST /people responses: '201': content: application/json: schema: type: object properties: person: type: object properties: id: type: integer first_name: type: string last_name: type: string links: type: object properties: consultations: type: string consultation_lab_test_results: type: string consultation_schedules: type: string vital_signs_sets: type: string medical_history: type: string deffers: type: string medical_notes: type: string insurance_coverage: type: string full_name: type: string telephone: nullable: true email: nullable: true born_at: type: string format: date gender: type: string avatar_url_small: type: string avatar_url_medium: type: string telephone2: type: string address_state_id: type: integer address_city: nullable: true address_street: nullable: true address_zipcode: nullable: true identity_number: nullable: true account_id: type: integer avatar_url_large: type: string notes: nullable: true person_attributes: type: object phone_country_id: type: integer is_migrated: type: boolean without_cellphone: type: boolean nimbochat_invitation_sent: type: boolean medical_record: nullable: true description: Successful response tags: - Patient Management security: - BearerAuth: [] requestBody: content: application/json: schema: type: object properties: person: type: object properties: first_name: type: string last_name: type: string born_at: type: string format: date gender: type: string description: Patient gender value; confirm the values supported by your integration. phone_country_id: type: string description: Country catalog ID for the mobile number; required unless without_cellphone is true. telephone2: type: string description: Mobile number; required unless without_cellphone is true. Validated for the selected phone country. email: type: string description: May be blank. A supplied email must be valid. account_id: type: string without_cellphone: type: boolean description: Set to true when the patient has no mobile phone. send_welcome_email: type: boolean description: Welcome-email option; this field does not establish delivery or consent. address_state_id: type: string description: State ID from the geography catalog. patient_group_ids: type: array items: type: integer description: Group IDs from the treating account patient-groups catalog. person_attributes: type: object properties: send_reminders: type: boolean description: Patient reminder preference. identity_number: type: string description: Patient identity value; country-specific validation applies. required: - first_name - last_name - gender - account_id required: - person required: true operationId: legacy_nimbo_api_post__people parameters: [] description: Creates a patient for an authorized treating account. A mobile number and phone country are required unless without_cellphone is true. Additional validation can depend on the organization country and patient configuration. "/people/{person_id}": put: summary: PUT /people/{person_id} responses: '200': content: application/json: schema: type: object properties: person: type: object properties: id: type: integer first_name: type: string last_name: type: string links: type: object properties: consultations: type: string consultation_lab_test_results: type: string consultation_schedules: type: string vital_signs_sets: type: string medical_history: type: string deffers: type: string medical_notes: type: string insurance_coverage: type: string full_name: type: string telephone: nullable: true email: nullable: true born_at: type: string format: date gender: type: string avatar_url_small: type: string avatar_url_medium: type: string telephone2: type: string address_state_id: type: integer address_city: nullable: true address_street: nullable: true address_zipcode: nullable: true identity_number: nullable: true account_id: type: integer avatar_url_large: type: string notes: nullable: true person_attributes: type: object phone_country_id: type: integer is_migrated: type: boolean without_cellphone: type: boolean nimbochat_invitation_sent: type: boolean medical_record: nullable: true cirrus_patient_id: nullable: true description: Successful response tags: - Patient Management security: - BearerAuth: [] requestBody: content: application/json: schema: type: object properties: person: type: object properties: first_name: type: string last_name: type: string born_at: type: string format: date gender: type: string phone_country_id: type: string format: color telephone2: type: string email: type: string format: email account_id: type: string person_attributes: type: object properties: send_reminders: type: boolean insurance_name: type: string insurance_file: type: string insurance_number: type: string insurance_plan: type: string insurance_type: type: string insurance_taxed: type: boolean insurance_claim_insured_name: type: string insurance_claim_birthplace: type: string insurance_claim_folio: type: string insurance_claim_number: type: string insurance_claim_movement: type: string insurance_claim_adjuster: type: string insurance_claim_risk: type: string insurance_claim_sinister_date: type: string format: date insurance_claim_issue_date: type: string format: date insurance_claim_initial_date: type: string format: date insurance_claim_admission_date: type: string format: date insurance_claim_departure_date: type: string format: date insurance_claim_institution_name: type: string insurance_claim_institution_address: type: string operationId: legacy_nimbo_api_put__people_person_id parameters: - name: person_id in: path required: true schema: type: string delete: summary: DELETE /people/{person_id} responses: '200': description: Successful response tags: - Patient Management security: - BearerAuth: [] operationId: legacy_nimbo_api_delete__people_person_id parameters: - name: person_id in: path required: true schema: type: string get: summary: GET /people/{person_id} responses: '200': content: application/json: schema: type: object properties: person: type: object properties: id: type: integer first_name: type: string last_name: type: string links: type: object properties: consultations: type: string consultation_lab_test_results: type: string consultation_schedules: type: string vital_signs_sets: type: string medical_history: type: string deffers: type: string medical_notes: type: string insurance_coverage: type: string full_name: type: string telephone: nullable: true email: nullable: true born_at: type: string format: date gender: type: string avatar_url_small: type: string avatar_url_medium: type: string telephone2: type: string address_state_id: nullable: true address_city: nullable: true address_street: nullable: true address_zipcode: nullable: true identity_number: type: string account_id: type: integer avatar_url_large: type: string notes: nullable: true person_attributes: type: object properties: tax_rfc: type: string identity_number: type: string phone_country_id: type: integer is_migrated: type: boolean without_cellphone: type: boolean nimbochat_invitation_sent: type: boolean medical_record: type: string cirrus_patient_id: nullable: true description: Successful response tags: - Patient Management security: - BearerAuth: [] operationId: legacy_nimbo_api_get__people_person_id parameters: - name: person_id in: path required: true schema: type: string "/accounts/{account_id}/people": get: summary: GET /accounts/{account_id}/people parameters: - name: telephone2 in: query schema: type: integer - name: born_at in: query schema: type: string - name: account_id in: path required: true schema: type: string responses: '200': content: application/json: schema: type: object properties: accounts: type: array items: type: object properties: id: type: integer full_name: type: string email_present: type: boolean validated_form: nullable: true tax_id: nullable: true phone_country_id: type: integer insurance_company_present: type: boolean patient_group_id: nullable: true description: Successful response tags: - Patient Management operationId: legacy_nimbo_api_get__accounts_account_id_people "/predictions/people": get: summary: GET /predictions/people parameters: - name: first_name in: query schema: type: string - name: last_name in: query schema: type: string - name: born_at in: query schema: type: string responses: '200': content: application/json: schema: type: object properties: people: type: array items: type: object properties: id: type: integer first_name: type: string last_name: type: string links: type: object properties: consultations: type: string consultation_lab_test_results: type: string consultation_schedules: type: string vital_signs_sets: type: string medical_history: type: string deffers: type: string medical_notes: type: string insurance_coverage: type: string full_name: type: string telephone: nullable: true email: nullable: true born_at: type: string format: date gender: type: string avatar_url_small: type: string avatar_url_medium: type: string telephone2: type: string address_state_id: type: integer address_city: nullable: true address_street: nullable: true address_zipcode: nullable: true identity_number: nullable: true account_id: type: integer avatar_url_large: type: string notes: nullable: true person_attributes: type: object phone_country_id: type: integer is_migrated: type: boolean without_cellphone: type: boolean nimbochat_invitation_sent: type: boolean medical_record: nullable: true meta: type: object properties: total_pages: type: integer description: Successful response tags: - Patient Management security: - BearerAuth: [] operationId: legacy_nimbo_api_get__predictions_people "/accounts/{account_id}/patient_groups": get: summary: GET /accounts/{account_id}/patient_groups responses: '200': content: application/json: schema: type: object properties: person: type: object properties: id: type: integer first_name: type: string last_name: type: string links: type: object properties: consultations: type: string consultation_lab_test_results: type: string consultation_schedules: type: string vital_signs_sets: type: string medical_history: type: string deffers: type: string medical_notes: type: string insurance_coverage: type: string full_name: type: string telephone: nullable: true email: nullable: true born_at: type: string format: date gender: type: string avatar_url_small: type: string avatar_url_medium: type: string telephone2: type: string address_state_id: nullable: true address_city: nullable: true address_street: nullable: true address_zipcode: nullable: true identity_number: type: string account_id: type: integer avatar_url_large: type: string notes: nullable: true person_attributes: type: object properties: tax_rfc: type: string identity_number: type: string phone_country_id: type: integer is_migrated: type: boolean without_cellphone: type: boolean nimbochat_invitation_sent: type: boolean medical_record: type: string cirrus_patient_id: nullable: true description: Successful response tags: - Patient Management security: - BearerAuth: [] operationId: legacy_nimbo_api_get__accounts_account_id_patient_groups parameters: - name: account_id in: path required: true schema: type: string "/organizations/current": get: summary: GET /organizations/current responses: '200': description: Successful response tags: - Account Management security: - BearerAuth: [] operationId: legacy_nimbo_api_get__organizations_current parameters: [] "/locations": get: summary: GET /locations responses: '200': description: Successful response tags: - Account Management security: - BearerAuth: [] operationId: legacy_nimbo_api_get__locations parameters: [] "/specialties/{specialty_id}": get: summary: GET /specialties/{specialty_id} responses: '200': description: Successful response tags: - Account Management operationId: legacy_nimbo_api_get__specialties_specialty_id parameters: - name: specialty_id in: path required: true schema: type: string "/invitations": post: summary: POST /invitations responses: '200': description: Successful response tags: - Account Management security: - BearerAuth: [] requestBody: content: application/json: schema: type: object properties: invitation: type: object properties: recipient_email: type: string format: email recipient_password: type: string recipient_name: type: string invitation_for: type: string assistant_patient_access: type: boolean send_email: type: boolean configuration: type: object properties: access_to_clinical: type: boolean access_to_charges: type: boolean custom_roles: type: object properties: administrator: type: boolean restricted_medic: type: boolean all_agendas: type: boolean access_control: type: boolean create_user: type: boolean organization_id: type: string location_id: type: string physician_specialty_id: type: string operationId: legacy_nimbo_api_post__invitations parameters: [] "/accounts/set_password": post: summary: POST /accounts/set_password responses: '200': description: Successful response tags: - Account Management security: - BearerAuth: [] operationId: legacy_nimbo_api_post__accounts_set_password parameters: [] "/account_profiles/{account_id}": put: summary: PUT /account_profiles/{account_id} responses: '200': description: Successful response tags: - Account Management security: - BearerAuth: [] requestBody: content: application/json: schema: type: object properties: account_profile: type: object properties: certified_information: type: boolean physician_institution: type: string physician_license: type: string role: type: string office_state_id: type: string physician_specialty_id: type: string operationId: legacy_nimbo_api_put__account_profiles_account_id parameters: - name: account_id in: path required: true schema: type: string "/accounts/{account_id}": put: summary: PUT /accounts/{account_id} responses: '200': description: Successful response tags: - Account Management security: - BearerAuth: [] requestBody: content: application/json: schema: type: object properties: account: type: object properties: account_setup_completed: type: boolean configuration: type: object properties: locale: type: string schedule: type: object properties: fri: type: array items: type: string format: style mon: type: array items: type: string thu: type: array items: type: string format: style tue: type: array items: type: string wed: type: array items: type: string format: style weeks_limit: type: object properties: id: type: integer time: type: integer interval: type: string consultation_duration: type: integer timezone: type: string consultation: type: object properties: odontogram: type: boolean physical_exam: type: boolean treatment_plan: type: boolean custom_forms: type: object properties: consultation: type: object properties: vital_signs_elements: type: object properties: height: type: boolean weight: type: boolean systole: type: boolean diastole: type: boolean body_mass: type: boolean heart_rate: type: boolean temperature: type: boolean respiratory_rate: type: boolean oxygen_saturation: type: boolean abdominal_perimeter: type: boolean lab_test_results_elements: type: object properties: glucose: type: boolean measurement_type: type: boolean result_obtained_through: type: boolean pregnant_without_diabetes: type: boolean medical_history: type: object properties: diet: type: boolean perinatal: type: boolean postnatal: type: boolean psychiatric: type: boolean vaccines_mx: type: boolean pathological: type: boolean heredo_familial: type: boolean non_pathological: type: boolean gineco_obstetrics: type: boolean custom_roles: type: object properties: all_agendas: type: boolean administrator: type: boolean restricted_medic: type: boolean weekly_email: type: boolean prescription_copy: type: boolean interface_language: type: string prescription_template: type: string assistant_has_charges_access: type: boolean assistant_has_clinical_access: type: boolean print_vital_signs: type: boolean print_diagnostics: type: boolean email: type: string format: email eprescription_enabled: type: boolean name: type: string pending_confirmation_email: type: string format: email physician_institution: type: string physician_license: type: string username: type: string cellphone: type: string organization_id: type: integer active: type: boolean bio: type: string office_state_id: type: string physician_specialty_id: type: string cellphone_country_id: type: string format: color operationId: legacy_nimbo_api_put__accounts_account_id parameters: - name: account_id in: path required: true schema: type: string get: summary: GET /accounts/{account_id} responses: '200': content: application/json: schema: type: object properties: account: type: object properties: certified_information: type: boolean consultations_count: type: integer email: type: string format: email eprescription_enabled: type: boolean account_setup_completed: type: boolean id: type: integer role: type: string links: type: object properties: response_templates: type: string physician_specialty: type: string location: type: string name: type: string username: type: string office_state_id: type: integer survey_answered: type: boolean physician_institution: type: string physician_license: type: string format: color physician_specialty_id: type: integer configuration: type: object properties: locale: type: string schedule: type: object properties: fri: type: array items: type: string format: style mon: type: array items: type: string sat: type: array items: type: string format: style thu: type: array items: type: string tue: type: array items: type: string format: style wed: type: array items: type: string weeks_limit: type: object properties: id: type: integer time: type: integer interval: type: string consultation_duration: type: integer timezone: type: string consultation: type: object properties: odontogram: type: boolean physical_exam: type: boolean physiotherapy: type: boolean treatment_plan: type: boolean disability_leave: type: boolean custom_forms: type: object properties: person: type: object properties: employee: type: boolean consultation: type: object properties: ketosis_elements: type: object properties: cramps: type: boolean hunger: type: boolean anxiety: type: boolean fatigue: type: boolean satiety: type: boolean diarrhea: type: boolean headache: type: boolean dizziness: type: boolean halitosis: type: boolean tolerance: type: boolean depression: type: boolean impatience: type: boolean constipation: type: boolean irritability: type: boolean concentration: type: boolean aggressiveness: type: boolean impulse_control: type: boolean stimulants_need: type: boolean sleeping_problems: type: boolean nutrition_elements: type: object properties: fat: type: boolean waist: type: boolean water: type: boolean muscle: type: boolean abdomen: type: boolean lost_weight: type: boolean vital_signs_elements: type: object properties: height: type: boolean weight: type: boolean systole: type: boolean diastole: type: boolean body_mass: type: boolean heart_rate: type: boolean temperature: type: boolean lean_body_mass: type: boolean respiratory_rate: type: boolean oxygen_saturation: type: boolean head_circumference: type: boolean body_fat_percentage: type: boolean lab_test_results_elements: type: object properties: co2: type: boolean sodium: type: boolean calcium: type: boolean glucose: type: boolean chloride: type: boolean platelet: type: boolean potassium: type: boolean creatinine: type: boolean hematocrit: type: boolean hemoglobin: type: boolean reticulocyte: type: boolean triglycerides: type: boolean red_blood_cells: type: boolean white_blood_cell: type: boolean total_cholesterol: type: boolean blood_urea_nitrogen: type: boolean low_density_lipoprotein: type: boolean high_density_lipoprotein: type: boolean very_low_density_lipoprotein: type: boolean medical_history: type: object properties: diet: type: boolean perinatal: type: boolean postnatal: type: boolean psychiatric: type: boolean vaccines_mx: type: boolean pathological: type: boolean work_history: type: boolean heredo_familial: type: boolean non_pathological: type: boolean gineco_obstetrics: type: boolean custom_roles: type: object properties: administrator: type: boolean weekly_email: type: boolean schedule_type: type: string feature_toggles: type: object properties: nimbo_chat: type: boolean section_nms: type: boolean physiotherapy: type: boolean cirrus_integration: type: boolean farhos_integration: type: boolean section_telehealth: type: boolean custom_catalogue: type: object properties: lab_tests: type: object properties: filters: type: string prescription_copy: type: boolean print_diagnostics: type: boolean print_vital_signs: type: boolean interface_language: type: string only_existing_patient: type: boolean prescription_template: type: string send_cancellation_information: type: boolean settings: type: object properties: reports: type: object properties: dashboard: type: boolean daily-sheet: type: boolean suive: type: boolean onboarding: type: boolean consultation: type: object properties: odontogram: type: boolean invoice-items: type: boolean disease-notes: type: object properties: vital-signs-graphs: type: boolean diagnostic-and-treatment: type: object properties: medispan: type: boolean custom-lab-tests: type: boolean custom-drugs: type: boolean inventories: type: boolean feature-toggle: type: object properties: items-importer: type: boolean frequent_consultation_causes: type: array items: type: string created_at: type: string format: date-time pending_confirmation_email: nullable: true cellphone: type: string cellphone_verified: type: boolean cellphone_country_id: type: integer affiliation_id: type: integer professional_standard: type: object sis_type_of_staff: nullable: true sis_specify_type_of_staff: nullable: true referral_token: nullable: true should_reset_password: type: boolean referral_token_meta: nullable: true metadata: type: object properties: cirrus: type: object properties: credentials: type: object properties: extra: type: object properties: role_id: type: string estServId: type: string password: type: string username: type: string temporary_schedules_expired: type: boolean new_patients_count: type: integer appointments_count: type: integer bio: type: string description: Successful response tags: - Account Management operationId: legacy_nimbo_api_get__accounts_account_id parameters: - name: account_id in: path required: true schema: type: string "/accounts/me": get: summary: GET /accounts/me responses: '200': content: application/json: schema: type: object properties: account: type: object properties: avatar_url_large: type: string avatar_url_medium: type: string avatar_url_small: type: string certified_information: type: boolean consultations_count: type: integer email: type: string format: email eprescription_enabled: type: boolean account_setup_completed: type: boolean id: type: integer role: type: string links: type: object properties: response_templates: type: string physician_specialty: type: string location: type: string logo_url_large: type: string logo_url_medium: type: string name: type: string username: type: string office_state_id: type: integer people_count: type: integer survey_answered: type: boolean physician_institution: nullable: true physician_license: nullable: true physician_specialty_id: type: integer configuration: type: object properties: locale: type: string schedule: type: object properties: fri: type: array items: type: string format: style mon: type: array items: type: string thu: type: array items: type: string format: style tue: type: array items: type: string wed: type: array items: type: string format: style weeks_limit: type: object properties: id: type: integer time: type: integer interval: type: string consultation_duration: type: integer timezone: type: string consultation: type: object properties: odontogram: type: boolean physical_exam: type: boolean physiotherapy: type: boolean treatment_plan: type: boolean custom_forms: type: object properties: consultation: type: object properties: vital_signs_elements: type: object properties: height: type: boolean weight: type: boolean systole: type: boolean diastole: type: boolean body_mass: type: boolean heart_rate: type: boolean temperature: type: boolean lean_body_mass: type: boolean respiratory_rate: type: boolean oxygen_saturation: type: boolean head_circumference: type: boolean body_fat_percentage: type: boolean medical_history: type: object properties: diet: type: boolean perinatal: type: boolean postnatal: type: boolean psychiatric: type: boolean vaccines_mx: type: boolean pathological: type: boolean heredo_familial: type: boolean non_pathological: type: boolean gineco_obstetrics: type: boolean custom_roles: type: object properties: administrator: type: boolean weekly_email: type: boolean prescription_copy: type: boolean interface_language: type: string prescription_template: type: string skip_cellphone_verification: type: boolean assistant_has_charges_access: type: boolean assistant_has_clinical_access: type: boolean settings: type: object frequent_consultation_causes: type: array items: {} created_at: type: string format: date-time pending_confirmation_email: type: string format: email cellphone: type: string cellphone_verified: type: boolean cellphone_country_id: type: integer affiliation_id: type: integer signature: type: string professional_standard: type: object sis_type_of_staff: nullable: true sis_specify_type_of_staff: nullable: true referral_token: type: string should_reset_password: type: boolean referral_token_meta: nullable: true metadata: type: object properties: campaign: type: object properties: utm_term: nullable: true utm_medium: nullable: true utm_source: nullable: true utm_content: nullable: true utm_campaign: nullable: true referral_token: nullable: true temporary_schedules_expired: nullable: true new_patients_count: type: integer appointments_count: type: integer bio: nullable: true tax_rfc: nullable: true description: Successful response tags: - Account Management security: - BearerAuth: [] operationId: legacy_nimbo_api_get__accounts_me parameters: [] "/organization_members": get: summary: GET /organization_members responses: '200': description: Successful response tags: - Account Management security: - BearerAuth: [] operationId: legacy_nimbo_api_get__organization_members parameters: [] "/invoice_items": post: summary: POST /invoice_items responses: '201': content: application/json: schema: type: object properties: invoice_item: type: object properties: id: type: integer value: type: integer organization_id: type: integer active: type: boolean stock_total: type: integer stockable: type: boolean sku: type: string on_locations: type: string links: type: object properties: invoice_item_locations: type: string invoice_item_locations_location_ids: type: array items: type: integer accounting_type: type: string tax_attributes: type: object description: Successful response tags: - Inventory Management security: - BearerAuth: [] requestBody: content: application/json: schema: type: object properties: invoice_item: type: object properties: value: type: integer active: type: boolean sku: type: string stockable: type: boolean invoice_item_locations_location_ids: type: array items: type: integer operationId: legacy_nimbo_api_post__invoice_items parameters: [] "/invoice_items/{invoice_item_id}": put: summary: PUT /invoice_items/{invoice_item_id} responses: '200': content: application/json: schema: type: object properties: invoice_item: type: object properties: id: type: integer value: type: integer organization_id: type: integer active: type: boolean stock_total: type: integer stockable: type: boolean sku: type: string on_locations: type: string links: type: object properties: invoice_item_locations: type: string invoice_item_locations_location_ids: type: array items: type: integer accounting_type: type: string tax_attributes: type: object properties: kop_id: type: integer uom_id: type: integer kop_key: type: string uom_key: type: string tax_rate: type: number tax_type: type: string format: color tax_amount: nullable: true factor_type: type: string rate_or_fee: type: string rate_or_fee_id: type: integer kop_description: type: string uom_description: type: string description: Successful response tags: - Inventory Management security: - BearerAuth: [] requestBody: content: application/json: schema: type: object properties: invoice_item: type: object properties: value: type: integer active: type: boolean sku: type: string stockable: type: boolean tax_attributes: type: object properties: kop_id: type: integer uom_id: type: integer kop_key: type: string uom_key: type: string tax_rate: type: number tax_type: type: string format: color tax_amount: nullable: true factor_type: type: string rate_or_fee: type: string rate_or_fee_id: type: integer kop_description: type: string uom_description: type: string invoice_item_locations_location_ids: type: array items: type: integer operationId: legacy_nimbo_api_put__invoice_items_invoice_item_id parameters: - name: invoice_item_id in: path required: true schema: type: string "/item_transactions": post: summary: POST /item_transactions responses: '201': content: application/json: schema: type: object properties: item_transaction: type: object properties: id: type: integer account_id: type: integer invoice_item_id: type: integer metadata: type: object properties: account_email: type: string format: email account_name: type: string invoice_item_description: type: string quantity: type: integer description: Successful response tags: - Inventory Management security: - BearerAuth: [] requestBody: content: application/json: schema: type: object properties: item_transaction: type: object properties: quantity: type: integer metadata: type: object properties: account_email: type: string format: email account_name: type: string invoice_item_description: type: string account_id: type: string location_id: type: string invoice_item_id: type: string operationId: legacy_nimbo_api_post__item_transactions parameters: [] "/consultations/{consultation_id}/consultation_lab_tests": get: summary: GET /consultations/{consultation_id}/consultation_lab_tests responses: '200': description: Successful response tags: - Consultations - Lab Test Orders security: - BearerAuth: [] operationId: legacy_nimbo_api_get__consultations_consultation_id_consultation_lab_tests parameters: - name: consultation_id in: path required: true schema: type: string "/lab_tests/{lab_test_id}": get: summary: GET /lab_tests/{lab_test_id} responses: '200': description: Successful response tags: - Consultations - Lab Test Orders security: - BearerAuth: [] operationId: legacy_nimbo_api_get__lab_tests_lab_test_id parameters: - name: lab_test_id in: path required: true schema: type: string "/consultations/{consultation_id}/consultation_procedures": get: summary: GET /consultations/{consultation_id}/consultation_procedures responses: '200': description: Successful response tags: - Consultations - Procedures Order security: - BearerAuth: [] operationId: legacy_nimbo_api_get__consultations_consultation_id_consultation_procedures parameters: - name: consultation_id in: path required: true schema: type: string "/procedures/{procedure_id}": get: summary: GET /procedures/{procedure_id} responses: '200': description: Successful response tags: - Consultations - Procedures Order security: - BearerAuth: [] operationId: legacy_nimbo_api_get__procedures_procedure_id parameters: - name: procedure_id in: path required: true schema: type: string "/prescriptions": post: summary: POST /prescriptions responses: '200': description: Successful response tags: - Consultations - Prescription security: - BearerAuth: [] requestBody: content: application/json: schema: type: object properties: prescription: type: object properties: medical_instructions: nullable: true created_at: nullable: true finished_at: nullable: true security_hash: nullable: true consultation_id: type: string account_id: type: string operationId: legacy_nimbo_api_post__prescriptions parameters: [] put: summary: PUT /prescriptions responses: '200': description: Successful response tags: - Consultations - Prescription security: - BearerAuth: [] requestBody: content: application/json: schema: type: object properties: prescription: type: object properties: medical_instructions: type: string finished_at: nullable: true consultation_id: type: string account_id: type: string operationId: legacy_nimbo_api_put__prescriptions parameters: [] "/consultation_prescription_drugs": post: summary: POST /consultation_prescription_drugs responses: '200': description: Successful response tags: - Consultations - Prescription security: - BearerAuth: [] requestBody: content: application/json: schema: type: object properties: consultation_prescription_drug: type: object properties: dose: type: string frequency: type: string duration: type: string consultation_id: type: string prescription_drug_id: type: string prescription_id: type: string account_id: type: string operationId: legacy_nimbo_api_post__consultation_prescription_drugs parameters: [] "/consultation_prescription_drugs/{consultation_prescription_drug_id}": delete: summary: DELETE /consultation_prescription_drugs/{consultation_prescription_drug_id} responses: '200': description: Successful response tags: - Consultations - Prescription security: - BearerAuth: [] operationId: legacy_nimbo_api_delete__consultation_prescription_drugs_consultation_prescription_drug_id parameters: - name: consultation_prescription_drug_id in: path required: true schema: type: string "/consultations": get: summary: GET /consultations parameters: - name: page in: query schema: type: integer - name: per_page in: query schema: type: integer - name: person_id in: query schema: type: integer responses: '200': content: application/json: schema: type: object properties: consultations: type: array items: type: object properties: id: type: integer cause: type: string created_at: type: string format: date-time links: type: object properties: person: type: string encounter: type: string physical_test_samples: type: string consultation_diagnostics: type: string consultation_procedures: type: string consultation_lab_tests: type: string consultation_lab_test_result: type: string consultation_prescription_drugs: type: string consultation_schedule: type: string disability_leave: type: string invoice: type: string vital_signs_set: type: string odontogram: type: string medical_note: type: string physiotherapy_records: type: string medical_history_attachments: type: string location: type: string medical_instructions: type: string physical_examination: nullable: true subjective_symptoms: nullable: true cause_extended: nullable: true account_id: type: integer finished_at: nullable: true encounter_id: type: integer treatment_plan: type: string starts_at: type: string format: date-time sis: type: object lab_test: type: object procedure: nullable: true encode_id: type: string meta: type: object properties: total_pages: type: integer description: Successful response tags: - Consultations operationId: legacy_nimbo_api_get__consultations post: summary: POST /consultations responses: '201': description: Successful response tags: - Consultations security: - BearerAuth: [] operationId: legacy_nimbo_api_post__consultations parameters: [] "/consultations/{consultation_id}/consultation_diagnostics": get: summary: GET /consultations/{consultation_id}/consultation_diagnostics responses: '200': content: application/json: schema: type: object properties: consultation_diagnostics: type: array items: type: object properties: id: type: integer consultation_id: type: integer diagnostic_id: type: integer custom_name: nullable: true name: type: string code: type: string metadata: type: object medical_information: type: object description: Successful response tags: - Consultations security: - BearerAuth: [] operationId: legacy_nimbo_api_get__consultations_consultation_id_consultation_diagnostics parameters: - name: consultation_id in: path required: true schema: type: string "/consultations/{consultation_id}/consultation_prescription_drugs": get: summary: GET /consultations/{consultation_id}/consultation_prescription_drugs responses: '200': content: application/json: schema: type: object properties: consultation_prescription_drugs: type: array items: type: object properties: id: type: integer consultation_id: type: integer prescription_drug_id: type: integer prescription_id: type: integer name: type: string metadata: type: object properties: prn: type: boolean locale: type: string dose_uom: type: string days_total: type: integer custom_name: nullable: true dose: type: string dose_uom: type: string frequency: type: string frequency_id: nullable: true duration: type: string via: type: string diagnosis1: nullable: true diagnosis2: nullable: true diagnosis3: nullable: true diagnosis1_code: nullable: true diagnosis2_code: nullable: true diagnosis3_code: nullable: true drug_value: nullable: true prn: type: boolean pending_prescription_delivery: nullable: true cirrus_sync_status: nullable: true account_id: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time initial_quantity: type: integer barcode: nullable: true description: Successful response tags: - Consultations security: - BearerAuth: [] operationId: legacy_nimbo_api_get__consultations_consultation_id_consultation_prescription_drugs parameters: - name: consultation_id in: path required: true schema: type: string "/consultation_lab_test_results": post: summary: POST /consultation_lab_test_results responses: '200': description: Successful response tags: - Consultations security: - BearerAuth: [] requestBody: content: application/json: schema: type: object properties: consultation_lab_test_result: type: object properties: consultation_id: type: string elements: type: array items: type: object properties: group: type: string name: type: string units: type: string value: nullable: true min: type: integer max: type: integer operationId: legacy_nimbo_api_post__consultation_lab_test_results parameters: [] "/consultations/{consultation_id}/physiotherapy_records": get: summary: GET /consultations/{consultation_id}/physiotherapy_records responses: '200': content: application/json: schema: type: object properties: physiotherapy_records: type: array items: type: object properties: id: type: integer consultation_id: type: integer part_number: type: integer part_name: type: string side: type: string body_part_id: type: integer description: Successful response tags: - Consultations operationId: legacy_nimbo_api_get__consultations_consultation_id_physiotherapy_records parameters: - name: consultation_id in: path required: true schema: type: string "/consultations/{consultation_id}/disability_leave": get: summary: GET /consultations/{consultation_id}/disability_leave responses: '200': description: Successful response tags: - Consultations security: - BearerAuth: [] operationId: legacy_nimbo_api_get__consultations_consultation_id_disability_leave parameters: - name: consultation_id in: path required: true schema: type: string "/consultation_schedules": post: summary: POST /consultation_schedules responses: '201': content: application/json: schema: type: object properties: consultation_schedule: type: object properties: cause: nullable: true created_at: type: string format: date-time ends_at: type: string format: date-time id: type: integer links: type: object properties: consultation: nullable: true encounter: nullable: true invoice: nullable: true person: nullable: true person_id: nullable: true starts_at: type: string format: date-time confirmed_at: nullable: true schedule_type: type: string encounter_id: nullable: true blocked_cause: type: string account_id: type: integer telehealth_url: nullable: true price: type: integer arrival_at: nullable: true account_confirmed: type: boolean organization_schedule_id: nullable: true account_username: type: string status: nullable: true description: Successful response tags: - Schedules requestBody: content: application/json: schema: type: object properties: consultation_schedule: type: object properties: cause: type: string starts_at: type: string format: date-time ends_at: type: string format: date-time reminder: type: boolean sms_reminder: type: boolean schedule_type: type: string price: type: integer metadata: type: object properties: share_payment_link: type: boolean send_payment_link: type: boolean person_id: type: string account_id: type: string operationId: legacy_nimbo_api_post__consultation_schedules parameters: [] "/consultation_schedules/{consultation_schedule_id}": get: summary: GET /consultation_schedules/{consultation_schedule_id} responses: '200': content: application/json: schema: anyOf: - type: object properties: consultation_schedule: type: object properties: cause: type: string created_at: type: string format: date-time ends_at: type: string format: date-time id: type: integer links: type: object properties: consultation: type: string encounter: type: string invoice: type: string person: type: string person_id: type: integer starts_at: type: string format: date-time confirmed_at: nullable: true schedule_type: type: string encounter_id: type: integer blocked_cause: nullable: true account_id: type: integer telehealth_url: nullable: true price: type: integer arrival_at: nullable: true account_confirmed: type: boolean organization_schedule_id: nullable: true account_username: type: string status: nullable: true metadata: type: object properties: share_payment_link: type: boolean send_payment_link: type: boolean showChargeOption: type: boolean charge_product: type: boolean sms_reminder: type: boolean subsequent_id: nullable: true source: type: string source_slug: type: string reason_for_cancellation: nullable: true comments_for_cancellation: nullable: true reminder: type: boolean deleted_at: nullable: true account_patient_id: nullable: true account_name: type: string location_name: type: string encounter_type_id: type: integer extra: type: object properties: person: type: object properties: id: type: integer first_name: type: string last_name: type: string telephone: nullable: true email: type: string format: email created_at: type: string format: date-time updated_at: type: string format: date-time born_at: type: string format: date gender: type: string avatar_file_name: nullable: true avatar_content_type: nullable: true avatar_file_size: nullable: true avatar_updated_at: nullable: true telephone2: type: string format: utc-millisec person_attributes: type: object account_id: type: integer address_state_id: type: integer organization_id: type: integer notes: nullable: true deleted_at: nullable: true phone_country_id: type: integer creator_id: type: integer updater_id: type: integer is_migrated: type: boolean without_cellphone: type: boolean nimbochat_invitation_date: nullable: true admission_form: type: boolean cirrus_patient_id: nullable: true person_token_id: nullable: true medical_record: nullable: true send_welcome_email: type: boolean patient_group_id: nullable: true consultation: nullable: true - type: object properties: consultation_schedule: type: object properties: cause: type: string created_at: type: string format: date-time ends_at: type: string format: date-time id: type: integer links: type: object properties: consultation: type: string encounter: type: string invoice: type: string person: type: string person_id: type: integer starts_at: type: string format: date-time confirmed_at: nullable: true schedule_type: type: string encounter_id: type: integer blocked_cause: nullable: true account_id: type: integer telehealth_url: nullable: true price: type: integer arrival_at: nullable: true account_confirmed: type: boolean organization_schedule_id: nullable: true account_username: type: string status: nullable: true metadata: type: object properties: share_payment_link: type: boolean send_payment_link: type: boolean showChargeOption: type: boolean charge_product: type: boolean sms_reminder: type: boolean subsequent_id: nullable: true source: type: string source_slug: type: string reason_for_cancellation: nullable: true comments_for_cancellation: nullable: true reminder: type: boolean deleted_at: nullable: true account_patient_id: nullable: true account_name: type: string location_name: type: string encounter_type_id: type: integer extra: type: object properties: person: type: object properties: id: type: integer first_name: type: string last_name: type: string telephone: nullable: true email: type: string format: email created_at: type: string format: date-time updated_at: type: string format: date-time born_at: type: string format: date gender: type: string avatar_file_name: nullable: true avatar_content_type: nullable: true avatar_file_size: nullable: true avatar_updated_at: nullable: true telephone2: type: string format: utc-millisec person_attributes: type: object properties: tax_id: type: string without_rut: type: boolean send_reminders: type: boolean welcome_email_sent: type: boolean cirrus_insurance_isPolicyHolder: type: boolean account_id: type: integer address_state_id: type: integer organization_id: type: integer notes: nullable: true deleted_at: nullable: true phone_country_id: type: integer creator_id: type: integer updater_id: type: integer is_migrated: type: boolean without_cellphone: type: boolean nimbochat_invitation_date: nullable: true admission_form: type: boolean cirrus_patient_id: nullable: true person_token_id: nullable: true medical_record: nullable: true send_welcome_email: type: boolean patient_group_id: nullable: true consultation: nullable: true description: Successful response tags: - Consultation Schedules requestBody: content: application/json: schema: type: object properties: consultation_schedule: type: object properties: blocked_cause: type: string starts_at: type: string format: date-time ends_at: type: string format: date-time reminder: type: boolean sms_reminder: type: boolean schedule_type: type: string overlaps_with: type: integer price: type: integer account_confirmed: type: boolean account_id: type: string operationId: legacy_nimbo_api_get__consultation_schedules_consultation_schedule_id parameters: - name: consultation_schedule_id in: path required: true schema: type: string put: summary: PUT /consultation_schedules/{consultation_schedule_id} responses: '200': description: Successful response tags: - Consultation Schedules requestBody: content: application/json: schema: type: object properties: consultation_request: type: object properties: cause: type: string starts_at: type: string format: date-time ends_at: type: string format: date-time confirmed_at: type: string format: date-time reminder: type: boolean sms_reminder: type: boolean schedule_type: type: string overlaps_with: type: integer price: type: integer account_confirmed: type: boolean person_id: type: integer account_id: type: integer operationId: legacy_nimbo_api_put__consultation_schedules_consultation_schedule_id parameters: - name: consultation_schedule_id in: path required: true schema: type: string delete: summary: DELETE /consultation_schedules/{consultation_schedule_id} responses: '200': content: application/json: schema: type: object properties: consultation_schedule: type: object properties: cause: nullable: true created_at: type: string format: date-time ends_at: type: string format: date-time id: type: integer links: type: object properties: consultation: nullable: true encounter: nullable: true invoice: nullable: true person: nullable: true person_id: nullable: true starts_at: type: string format: date-time confirmed_at: nullable: true schedule_type: type: string encounter_id: nullable: true blocked_cause: type: string account_id: type: integer telehealth_url: nullable: true price: type: integer arrival_at: nullable: true account_confirmed: type: boolean organization_schedule_id: nullable: true account_username: type: string status: nullable: true metadata: type: object properties: send_payment_link: type: boolean description: Successful response tags: - Consultation Schedules operationId: legacy_nimbo_api_delete__consultation_schedules_consultation_schedule_id parameters: - name: consultation_schedule_id in: path required: true schema: type: string "/consultation_schedule_notifications": get: summary: GET /consultation_schedule_notifications responses: '200': description: Successful response tags: - Consultation Schedules requestBody: content: application/json: schema: type: object properties: consultation_request: type: object properties: cause: type: string starts_at: type: string format: date-time ends_at: type: string format: date-time confirmed_at: type: string format: date-time reminder: type: boolean sms_reminder: type: boolean schedule_type: type: string overlaps_with: type: integer price: type: integer account_confirmed: type: boolean person_id: type: integer account_id: type: integer operationId: legacy_nimbo_api_get__consultation_schedule_notifications parameters: [] "/calendar/available_hours": get: summary: GET /calendar/available_hours parameters: - name: from in: query schema: type: string - name: to in: query schema: type: string - name: monthly in: query schema: type: boolean - name: account in: query schema: type: string responses: '200': content: application/json: schema: type: object properties: hours: type: array items: type: object properties: date: type: string format: date day: type: string available: type: boolean description: Successful response tags: - Consultation Schedules operationId: legacy_nimbo_api_get__calendar_available_hours "/api/v1/calendar/available_hours_organization": get: summary: GET /api/v1/calendar/available_hours_organization parameters: - name: from in: query schema: type: string - name: to in: query schema: type: string - name: monthly in: query schema: type: boolean - name: slug in: query schema: type: string responses: '200': content: application/json: schema: type: object properties: hours: type: array items: type: object properties: day: type: string date: type: string format: date schedules: type: array items: type: string format: style available: type: boolean description: Successful response tags: - Consultation Schedules operationId: legacy_nimbo_api_get__api_v1_calendar_available_hours_organization "/invoice_item_locations": get: summary: GET /invoice_item_locations responses: '200': description: Successful response tags: - Charges security: - BearerAuth: [] operationId: legacy_nimbo_api_get__invoice_item_locations parameters: [] "/invoice_items/invoice_items_payment": get: summary: GET /invoice_items/invoice_items_payment responses: '200': description: Successful response tags: - Charges security: - BearerAuth: [] requestBody: content: application/json: schema: type: object operationId: legacy_nimbo_api_get__invoice_items_invoice_items_payment parameters: [] "/invoices": post: summary: POST /invoices responses: '200': description: Successful response tags: - Charges security: - BearerAuth: [] requestBody: content: application/json: schema: type: object properties: invoice: type: object properties: encounter_id: type: string tax_attributes: type: object properties: use_cfdi: type: string payment_method: type: string payment_form: type: string consultation_id: nullable: true person_id: type: string operationId: legacy_nimbo_api_post__invoices parameters: [] "/consultation_invoice_items": post: summary: POST /consultation_invoice_items responses: '200': description: Successful response tags: - Charges security: - BearerAuth: [] requestBody: content: application/json: schema: type: object properties: consultation_invoice_item: type: object properties: quantity: type: string value: type: string accounting_type: type: string account_id: type: string invoice_id: type: string invoice_item_id: type: string operationId: legacy_nimbo_api_post__consultation_invoice_items parameters: [] "/people/{people_id}/vital_signs_sets": get: summary: GET /people/{people_id}/vital_signs_sets responses: '200': content: application/json: schema: type: object properties: vital_signs_sets: type: array items: type: object properties: id: type: integer consultation_id: type: integer person_id: type: integer account_id: type: integer elements: type: object properties: cramps: type: object properties: units: type: string value: nullable: true height: type: object properties: units: type: string value: type: string hunger: type: object properties: units: type: string value: nullable: true anxiety: type: object properties: units: type: string value: nullable: true fatigue: type: object properties: units: type: string value: nullable: true satiety: type: object properties: units: type: string value: nullable: true diarrhea: type: object properties: units: type: string value: nullable: true headache: type: object properties: units: type: string value: nullable: true dizziness: type: object properties: units: type: string value: nullable: true halitosis: type: object properties: units: type: string value: nullable: true tolerance: type: object properties: units: type: string value: nullable: true depression: type: object properties: units: type: string value: nullable: true impatience: type: object properties: units: type: string value: nullable: true constipation: type: object properties: units: type: string value: nullable: true irritability: type: object properties: units: type: string value: nullable: true concentration: type: object properties: units: type: string value: nullable: true aggressiveness: type: object properties: units: type: string value: nullable: true impulse_control: type: object properties: units: type: string value: nullable: true stimulants_need: type: object properties: units: type: string value: nullable: true sleeping_problems: type: object properties: units: type: string value: nullable: true created_at: type: string format: date-time description: Successful response tags: - Vital Signs operationId: legacy_nimbo_api_get__people_people_id_vital_signs_sets parameters: - name: people_id in: path required: true schema: type: string "/vital_signs_sets": post: summary: POST /vital_signs_sets responses: '201': content: application/json: schema: type: object properties: vital_signs_set: type: object properties: id: type: integer consultation_id: nullable: true person_id: type: integer account_id: type: integer elements: type: object properties: height: type: object properties: value: type: string units: type: string created_at: type: string format: date-time description: Successful response tags: - Vital Signs requestBody: content: application/json: schema: type: object properties: vital_signs_set: type: object properties: created_at: type: string format: date-time elements: type: object properties: height: type: object properties: value: type: string units: type: string weight: type: object properties: value: type: string units: type: string body_mass: type: object properties: value: type: string units: type: string temperature: type: object properties: value: type: string units: type: string respiratory_rate: type: object properties: value: type: string units: type: string systole: type: object properties: value: type: string units: type: string diastole: type: object properties: value: type: string units: type: string heart_rate: type: object properties: value: type: string units: type: string body_fat_percentage: type: object properties: value: type: string units: type: string lean_body_mass: type: object properties: value: type: string units: type: string head_circumference: type: object properties: value: type: string units: type: string oxygen_saturation: type: object properties: value: type: string units: type: string person_id: type: string format: color account_id: type: string operationId: legacy_nimbo_api_post__vital_signs_sets parameters: [] "/people/{people_id}/medical_history": get: summary: GET /people/{people_id}/medical_history responses: '200': content: application/json: schema: type: object properties: medical_history: type: object properties: id: type: integer person_id: type: integer allergies: nullable: true links: type: object properties: medical_history_prescription_drugs: type: string medical_history_attachments: type: string medical_history_allergies: type: string pathological_records: type: object properties: stds: type: object properties: text: nullable: true other: type: object properties: text: nullable: true cancer: type: object properties: text: nullable: true diabetes: type: object properties: text: nullable: true injuries: type: object properties: text: nullable: true respiratory: type: object properties: text: nullable: true hypertension: type: object properties: text: nullable: true transfusions: type: object properties: text: nullable: true tuberculosis: type: object properties: text: nullable: true heart_diseases: type: object properties: text: nullable: true prior_surgeries: type: object properties: text: nullable: true gastrointestinal: type: object properties: text: nullable: true thyroid_diseases: type: object properties: text: nullable: true prior_hospitalization: type: object properties: text: nullable: true nonpathological_records: type: object properties: other: type: object properties: text: nullable: true smoking: type: object properties: text: nullable: true alcoholism: type: object properties: text: nullable: true drugs_abuse: type: object properties: text: nullable: true physical_activity: type: object properties: text: nullable: true recent_immunization: type: object properties: text: nullable: true heredofamilial_records: type: object properties: other: type: object properties: text: nullable: true diabetes: type: object properties: text: nullable: true hypertension: type: object properties: text: nullable: true heart_diseases: type: object properties: text: nullable: true thyroid_diseases: type: object properties: text: nullable: true gineco_obstetrics_records: type: object properties: other: type: object properties: text: nullable: true pregnancies: type: object properties: text: nullable: true breast_cancer: type: object properties: text: nullable: true last_pap_smear: type: object properties: text: nullable: true uterine_cancer: type: object properties: text: nullable: true cervical_cancer: type: object properties: text: nullable: true sexual_activity: type: object properties: text: nullable: true last_mastography: type: object properties: text: nullable: true birth_control_method: type: object properties: text: nullable: true menstruation_last_date: type: object properties: text: nullable: true menstruation_first_date: type: object properties: text: nullable: true hormone_replacement_therapy: type: object properties: text: nullable: true menstruation_characteristics: type: object properties: text: nullable: true vaccines_mx: type: object properties: other: type: object properties: text: nullable: true month_2: nullable: true month_4: nullable: true month_6: nullable: true month_7: nullable: true newborn: nullable: true month_12: nullable: true month_18: nullable: true month_24: nullable: true month_36: nullable: true month_48: nullable: true month_60: nullable: true month_72: nullable: true month_120: nullable: true diet: type: object properties: lunch: type: object properties: text: nullable: true other: type: object properties: text: nullable: true dinner: type: object properties: text: nullable: true satiety: nullable: true breakfast: type: object properties: text: nullable: true past_diets: type: object properties: text: nullable: true supplements: type: object properties: text: nullable: true ideal_weight: type: object properties: text: nullable: true past_ailment: type: object properties: text: nullable: true food_diseases: type: object properties: text: nullable: true home_prepared: type: object properties: text: nullable: true liquid_intake: type: object properties: text: nullable: true appetite_level: nullable: true current_ailment: type: object properties: text: nullable: true food_preferences: type: object properties: text: nullable: true collation_morning: type: object properties: text: nullable: true glasses_water_day: nullable: true collation_afternoon: type: object properties: text: nullable: true nutritional_education: type: object properties: text: nullable: true psychiatric_records: type: object properties: work_life: type: object properties: text: nullable: true family_life: type: object properties: text: nullable: true social_life: type: object properties: text: nullable: true family_history: type: object properties: text: nullable: true impulse_control: type: object properties: text: nullable: true deals_with_stress: type: object properties: text: nullable: true illness_awareness: type: object properties: text: nullable: true affected_life_aspects: type: object properties: text: nullable: true family_and_friends_support: type: object properties: text: nullable: true past_and_present_treatments: type: object properties: text: nullable: true relationship_with_authority: type: object properties: text: nullable: true perinatal_records: type: object properties: final_edb: type: object properties: text: nullable: true cycle_length: type: object properties: text: nullable: true pregnancy_notes: type: object properties: text: nullable: true assisted_conception: type: object properties: text: nullable: true last_menstrual_period: type: object properties: text: nullable: true last_used_contraceptive_type: type: object properties: text: nullable: true estimated_date_of_birth_by_lmp: type: object properties: text: nullable: true postnatal_records: type: object properties: babys_health: type: object properties: text: nullable: true birth_review: type: object properties: text: nullable: true name_of_baby: type: object properties: text: nullable: true infant_feeding: nullable: true emotional_state: type: object properties: text: nullable: true weight_at_birth: type: object properties: text: nullable: true has_allergies: nullable: true updater_name: type: string description: Successful response tags: - Medical History operationId: legacy_nimbo_api_get__people_people_id_medical_history parameters: - name: people_id in: path required: true schema: type: string "/medical_histories": post: summary: POST /medical_histories responses: '200': description: Successful response tags: - Medical History security: - BearerAuth: [] requestBody: content: application/json: schema: type: object properties: medical_history: type: object properties: person_id: type: string work_history: type: object properties: past_employment: type: object properties: active: type: boolean text: type: string accident_caused_disabilities: type: object properties: active: type: boolean text: nullable: true sickness_caused_disabilities: type: object properties: active: type: boolean text: type: string contact_with_dust_particles: type: object properties: text: nullable: true exposure_to_loud_noises: type: object properties: text: nullable: true exposure_to_chemicals: type: object properties: text: nullable: true fractures_or_injuries: type: object properties: text: nullable: true accidents_or_illnesses: type: object properties: text: nullable: true fit_to_work: type: object properties: text: nullable: true others: type: object properties: text: nullable: true allergies: type: string pathological_records: type: object properties: prior_hospitalization: type: object properties: active: type: boolean text: type: string prior_surgeries: type: object properties: active: type: boolean text: nullable: true diabetes: type: object properties: text: nullable: true thyroid_diseases: type: object properties: text: nullable: true hypertension: type: object properties: text: nullable: true heart_diseases: type: object properties: text: nullable: true injuries: type: object properties: text: nullable: true cancer: type: object properties: text: nullable: true tuberculosis: type: object properties: text: nullable: true transfusions: type: object properties: text: nullable: true respiratory: type: object properties: text: nullable: true gastrointestinal: type: object properties: text: nullable: true stds: type: object properties: text: nullable: true other: type: object properties: text: nullable: true nonpathological_records: type: object properties: physical_activity: type: object properties: active: type: boolean text: type: string smoking: type: object properties: active: type: boolean text: nullable: true alcoholism: type: object properties: text: nullable: true drugs_abuse: type: object properties: text: nullable: true recent_immunization: type: object properties: text: nullable: true other: type: object properties: text: nullable: true heredofamilial_records: type: object properties: diabetes: type: object properties: active: type: boolean text: type: string heart_diseases: type: object properties: active: type: boolean text: nullable: true hypertension: type: object properties: text: nullable: true thyroid_diseases: type: object properties: text: nullable: true other: type: object properties: text: nullable: true operationId: legacy_nimbo_api_post__medical_histories parameters: [] "/medical_notes": post: summary: POST /medical_notes parameters: - name: Content-Transfer-Encoding in: header schema: type: string responses: '200': description: Successful response tags: - Medical Notes security: - BearerAuth: [] requestBody: content: application/json: schema: type: object properties: medical_note: type: object properties: person_id: type: string format: color consultation_id: nullable: true comment: type: string note_type: type: string created_at: nullable: true voice_note_url: nullable: true account_id: type: string operationId: legacy_nimbo_api_post__medical_notes get: summary: GET /medical_notes parameters: - name: consultation_id in: query schema: type: integer - name: note_type in: query schema: type: string - name: page in: query schema: type: integer - name: per_page in: query schema: type: integer responses: '200': description: Successful response tags: - Medical Notes security: - BearerAuth: [] operationId: legacy_nimbo_api_get__medical_notes "/oauth/token": post: summary: POST /oauth/token responses: '200': content: application/json: schema: type: object properties: access_token: type: string token_type: type: string expires_in: type: integer refresh_token: type: string created_at: type: integer description: Successful response '403': description: Authentication can require an additional verification step. A two-factor challenge includes token_type set to 2fa, expires_in, and otp. Confirm the supported account authentication flow with Nimbo. tags: - Authentication operationId: legacy_nimbo_api_post__oauth_token parameters: [] requestBody: required: true content: application/json: schema: oneOf: - type: object required: - grant_type - username - password properties: grant_type: type: string enum: - password username: type: string description: Account email address. password: type: string format: password - type: object required: - grant_type - refresh_token properties: grant_type: type: string enum: - refresh_token refresh_token: type: string description: Refresh token from a successful token response. multipart/form-data: schema: oneOf: - type: object required: - grant_type - username - password properties: grant_type: type: string enum: - password username: type: string description: Account email address. password: type: string format: password - type: object required: - grant_type - refresh_token properties: grant_type: type: string enum: - refresh_token refresh_token: type: string description: Refresh token from a successful token response. description: Exchanges approved account credentials or a refresh token for integration tokens. Use the returned expires_in value. Accounts requiring two-factor authentication can return a 403 challenge instead of access tokens. security: [] "/telehealth_waiting_rooms": post: summary: POST /telehealth_waiting_rooms responses: '200': description: Successful response tags: - Teleconsultation Waiting Room requestBody: content: application/json: schema: type: object properties: telehealth_waiting_room: type: object properties: person: type: object properties: waiting_room: type: boolean telephone2: type: string born_at: type: string format: date first_name: type: string last_name: type: string gender: type: string email: type: string format: email phone_country_id: type: string format: color person_attributes: type: object properties: is_under_age: type: boolean organization_id: type: integer cause: type: string waiting_room_id: type: integer custom_form_response: type: object properties: respondable_type: type: string organization_id: type: integer responses: type: object properties: cf_98_070e8aae224f: type: object properties: id: type: integer key: type: string default_component: type: string default_options: type: object properties: label: type: string name: type: string section_name: type: string custom_form_id: type: integer custom_field_id: type: integer applicable_model: type: string value: type: string format: color cf_98_fe56b688854b: type: object properties: id: type: integer key: type: string default_component: type: string default_options: type: object properties: label: type: string options: type: array items: type: object properties: label: type: string value: type: string name: type: string section_name: type: string custom_form_id: type: integer custom_field_id: type: integer applicable_model: type: string value: type: string cf_98_508008f65942: type: object properties: id: type: integer key: type: string default_component: type: string default_options: type: object properties: label: type: string name: type: string section_name: type: string custom_form_id: type: integer custom_field_id: type: integer applicable_model: type: string value: type: string format: date operationId: legacy_nimbo_api_post__telehealth_waiting_rooms parameters: [] "/waiting_rooms/{waiting_room_id}/custom_forms": get: summary: GET /waiting_rooms/{waiting_room_id}/custom_forms responses: '200': description: Successful response tags: - Teleconsultation Waiting Room operationId: legacy_nimbo_api_get__waiting_rooms_waiting_room_id_custom_forms parameters: - name: waiting_room_id in: path required: true schema: type: string "/telehealth_waiting_rooms/{waiting_room_encrypted_id}/check": get: summary: GET /telehealth_waiting_rooms/{waiting_room_encrypted_id}/check responses: '200': content: application/json: schema: type: object properties: telehealth_waiting_room: type: object properties: id: type: integer person_id: type: integer organization_id: type: integer account_id: type: integer waiting_room_url: type: string format: uri telehealth_url: type: string format: uri consent_policy_url: type: string format: uri cause: type: string status: type: string person: type: object properties: id: type: integer first_name: type: string last_name: type: string telephone: nullable: true email: type: string format: email created_at: type: string format: date-time updated_at: type: string format: date-time born_at: type: string format: date gender: type: string avatar_file_name: nullable: true avatar_content_type: nullable: true avatar_file_size: nullable: true avatar_updated_at: nullable: true telephone2: type: string person_attributes: type: object properties: is_under_age: type: boolean phone_number: type: string relationship: type: string patient_dependent: type: boolean person_responsible: type: string account_id: type: integer address_state_id: nullable: true organization_id: type: integer notes: nullable: true deleted_at: nullable: true phone_country_id: type: integer creator_id: nullable: true updater_id: nullable: true is_migrated: type: boolean without_cellphone: type: boolean nimbochat_invitation_date: nullable: true admission_form: type: boolean cirrus_patient_id: nullable: true person_token_id: nullable: true medical_record: type: string send_welcome_email: type: boolean patient_group_id: nullable: true patient_group_ids: type: array items: {} summary_ai: type: object waiting_room_id: nullable: true organization: type: object properties: id: type: integer name: type: string created_at: type: string format: date-time updated_at: type: string format: date-time owner_id: type: integer options: type: object properties: allow_patient_sharing: type: boolean telehealth: type: boolean consultation_needs_consent: type: boolean insurance: type: boolean employee: type: boolean hotel: type: boolean more_info: type: boolean share_medical_history: type: boolean allow_patient_edit: type: boolean enable_custom_record: type: boolean allow_consultation_edit: type: boolean last_patient_mrn: type: integer prefix_patient_mrn: type: string only_existing_patient: type: boolean payment_per_organization: type: boolean include_physician_section: type: boolean enable_ai_features: type: boolean signature: type: object properties: email: type: string format: email password: type: string format: color document_id: type: integer tax_attributes: type: object kind: type: string invoice_items_count: type: integer number_of_physicians_option: type: string slug: type: string landing_page_info: type: object integrations: type: object telehealth_request_slug: type: string custom_domain: nullable: true main_organization_schedule_id: nullable: true referral_token: type: string waiting_room_configuration: type: object onboarding_info: type: object properties: achievements: type: array items: type: object properties: id: type: string title: type: string organization_type: type: string configuration: type: object sensitive_information: type: object created_at: type: string format: date-time updated_at: type: string format: date-time people_in_front: type: integer metadata: type: object properties: person_created: type: boolean slug: nullable: true waiting_room: nullable: true consultation_form_url: nullable: true show_split_screen: type: boolean organizational_logo: type: string high_priority: type: boolean meta: type: object properties: people_in_front: type: integer waiting_time: type: integer description: Successful response tags: - Teleconsultation Waiting Room operationId: legacy_nimbo_api_get__telehealth_waiting_rooms_waiting_room_encrypted_id_check parameters: - name: waiting_room_encrypted_id in: path required: true schema: type: string "/waiting_rooms": get: summary: GET /waiting_rooms responses: '200': content: application/json: schema: type: object properties: waiting_rooms: type: array items: type: object properties: id: type: integer organization_id: type: integer name: type: string slug: type: string schedule_configuration: type: object properties: schedule: type: object properties: fri: type: array items: type: string format: style mon: type: array items: type: string sat: type: array items: type: string format: style sun: type: array items: type: string thu: type: array items: type: string format: style tue: type: array items: type: string wed: type: array items: type: string format: style weeks_limit: type: object properties: id: type: integer time: type: integer interval: type: string consultation_duration: type: integer timezone: type: string waiting_room_configuration: type: object properties: allow_guest: type: boolean created_at: type: string format: date-time updated_at: type: string format: date-time selected_accounts: type: array items: type: integer description: Successful response tags: - Teleconsultation Waiting Room operationId: legacy_nimbo_api_get__waiting_rooms parameters: [] "/waiting_rooms/{waiting_room_id}": get: summary: GET /waiting_rooms/{waiting_room_id} responses: '200': content: application/json: schema: type: object properties: waiting_room: type: object properties: id: type: integer organization_id: type: integer name: type: string slug: type: string schedule_configuration: type: object properties: schedule: type: object properties: fri: type: array items: type: string format: style mon: type: array items: type: string sat: type: array items: type: string format: style sun: type: array items: type: string thu: type: array items: type: string format: style tue: type: array items: type: string wed: type: array items: type: string format: style weeks_limit: type: object properties: id: type: integer time: type: integer interval: type: string consultation_duration: type: integer timezone: type: string waiting_room_configuration: type: object properties: allow_guest: type: boolean created_at: type: string format: date-time updated_at: type: string format: date-time selected_accounts: type: array items: type: integer description: Successful response tags: - Teleconsultation Waiting Room operationId: legacy_nimbo_api_get__waiting_rooms_waiting_room_id parameters: - name: waiting_room_id in: path required: true schema: type: string "/waiting_rooms/waiting_room_slug": get: summary: GET /waiting_rooms/waiting_room_slug parameters: - name: slug in: query schema: type: string responses: '200': content: application/json: schema: type: object properties: waiting_room: type: object properties: id: type: integer organization_id: type: integer name: type: string slug: type: string schedule_configuration: type: object properties: schedule: type: object properties: fri: type: array items: type: string format: style mon: type: array items: type: string sat: type: array items: type: string format: style sun: type: array items: type: string thu: type: array items: type: string format: style tue: type: array items: type: string wed: type: array items: type: string format: style weeks_limit: type: object properties: id: type: integer time: type: integer interval: type: string consultation_duration: type: integer timezone: type: string waiting_room_configuration: type: object created_at: type: string format: date-time updated_at: type: string format: date-time selected_accounts: type: array items: type: integer description: Successful response tags: - Teleconsultation Waiting Room operationId: legacy_nimbo_api_get__waiting_rooms_waiting_room_slug components: securitySchemes: BearerAuth: type: http scheme: bearer