Skip to main content

Medical Certificate Scanner | React Native Document Scanner

Medical Certificate Scanner

ScanbotSDK.UI.startMedicalCertificateScanner(configuration: MedicalCertificateScannerConfiguration)

Opens the Medical Certificate Scanner RTU-UI

alt

Options:
export interface MedicalCertificateScannerConfiguration {
/**
* The preferred camera module (default: BACK)
*/
cameraModule?: CameraModule;
/**
* Title of the cancel button.
*/
cancelButtonTitle?: string;
/**
* Title of the button that opens the screen where the user can allow
* the usage of the camera by the app.
*/
enableCameraButtonTitle?: string;
/**
* Text that will be displayed when the app
* is not allowed to use the camera, prompting the user
* to enable the usage of the camera.
*/
enableCameraExplanationText?: string;
/**
* Controls whether the flash should be initially enabled.
* The default value is FALSE.
*/
flashEnabled?: boolean;
/**
* UI Interface orientation lock mode (PORTRAIT, LANDSCAPE, ALL)
*/
interfaceOrientation?: InterfaceOrientation;
/**
* Background color of the top bar.
*/
topBarBackgroundColor?: string;
/**
* The color of all active toggle buttons in the toolbar.
*/
topBarButtonsActiveColor?: string;
/**
* Foreground color of the flash button when the flash is off.
*/
topBarButtonsInactiveColor?: string;
/**
* Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE.
* Android only.
*/
useButtonsAllCaps?: boolean;
/**
* The background color of the user guidance hints.
*/
userGuidanceBackgroundColor?: string;
/**
* The text color of the user guidance hints.
*/
userGuidanceTextColor?: string;
/*
* Whether the information of the patient (name, address) is extracted or not.
* The default value is true.
*/
extractPatientInfo?: boolean;
/**
* Whether the cancel button is hidden or not.
* The default value is false.
* iOS only.
*/
cancelButtonHidden?: boolean;

guidanceText?: {
/** String being displayed when capturing a photo of a medical certificate. */
capturing?: string;
/** String being displayed when recognizing a medical certificate. */
recognizing?: string;
/** String being displayed when searching for a medical certificate. */
searching?: string;
/** String being displayed when scanning starts for a medical certificate. */
scanningStarted?: string;
/**
* String being displayed when the detection is paused.
* iOS only
*/
paused?: string;
/**
* String being displayed when energy saving is active.
* iOS only
*/
energySaving?: string;
};

errorDialogText?: {
/** String being displayed as the button text in the error alert that may occur when the recognition fails on captured images. */
button?: string;
/** String being displayed as the title in the error alert that may occur when the recognition fails on captured images. */
title?: string;
/** String being displayed as the message in the error alert that may occur when the recognition fails on captured images. */
message?: string;
};
}

The result will be returned as below:

interface MedicalCertificateScannerResultData {
/**
* The Medical Certificate Form Type
*/
formType: MedicalCertificateFormType;
/**
* Image file uri of the captured Medical Certificate
*/
imageFileUri?: string;
/**
* The extracted patient data
*/
patientData: {
/**
* The health insurance provider.
*/
insuranceProvider?: string;
/**
* The patient's first name.
*/
firstName?: string;
/**
* The patient's last name.
*/
lastName?: string;
/**
* The patient's address 1.
*/
address1?: string;
/**
* The patient's address 2.
*/
address2?: string;
/**
* The patient's diagnosis.
*/
diagnose?: string;
/**
* The patient's health insurance number.
*/
healthInsuranceNumber?: string;
/**
* The patient's person number.
*/
insuredPersonNumber?: string;
/**
* The patient's status.
*/
status?: string;
/**
* The place of operation number.
*/
placeOfOperationNumber?: string;
/**
* The doctor's number.
*/
doctorNumber?: string;
/**
* An undefined field that was still recognized.
*/
unknown?: string;
};
/**
* The extracted dates data
*/
dates: {
/**
* The date since when the employee is incapable of work.
*/
incapableOfWorkSince?: MedicalCertificateDateField;
/**
* The date until when the employee is incapable of work.
*/
incapableOfWorkUntil?: MedicalCertificateDateField;
/**
* The date of the day of diagnosis.
*/
diagnosedOn?: MedicalCertificateDateField;
/**
* The date since when the child needs care.
*/
childNeedsCareFrom?: MedicalCertificateDateField;
/**
* The date until when the child needs care.
*/
childNeedsCareUntil?: MedicalCertificateDateField;
/**
* Patient's birth date.
*/
birthDate?: MedicalCertificateDateField;
/**
* Document date.
*/
documentDate?: MedicalCertificateDateField;
/**
* An unclassified date that was still recognized.
*/
unknown?: MedicalCertificateDateField;
};
/**
* The extracted checkboxes data.
* Contains information about the medical form checkboxes type
* and whether they are checked or not.
*/
checkboxes: {
/**
* This checkbox states if the certificate is an initial certificate.
*/
initialCertificate?: MedicalCertificateCheckboxField;
/**
* This checkbox states if the certificate is a renewed certificate.
*/
renewedCertificate?: MedicalCertificateCheckboxField;
/**
* This checkbox states if the certificate is about a work accident.
*/
workAccident?: MedicalCertificateCheckboxField;
/**
* This checkbox states if the certificate is assigned to an accident insurance doctor.
*/
assignedToAccidentInsuranceDoctor?: MedicalCertificateCheckboxField;
/**
* This checkbox states if the certificate is about an accident - checked yes.
*/
accident?: MedicalCertificateCheckboxField;
/**
* This checkbox states if the certificate is about an accident - checked no.
*/
accidentNo?: MedicalCertificateCheckboxField;
/**
* This checkbox states if the ill child requires care - checked yes.
*/
requiresCare?: MedicalCertificateCheckboxField;
/**
* The checkbox states if the ill child requires care - checked no.
*/
requiresCareNo?: MedicalCertificateCheckboxField;
/**
* This checkbox states if the insurance company has to pay for treatment.
*/
insuredPayCase?: MedicalCertificateCheckboxField;
/**
* This checkbox states if the certificate is final.
*/
finalCertificate?: MedicalCertificateCheckboxField;
/**
* This checkbox states if the certificate is assigned to an other accident.
*/
otherAccident?: MedicalCertificateCheckboxField;
/**
* This checkbox could not be classified but it was still recognized.
*/
unknown?: MedicalCertificateCheckboxField;
};
};

Want to scan longer than one minute?

Generate your free "no-strings-attached" Trial License and properly test the Scanbot SDK.

Get your free Trial License

What do you think of this documentation?


On this page

Scroll to top