Medical Certificate Scanner UI Components | iOS Document Scanner

The Scanbot SDK provides the ability to recognize medical certificates in a UIImage or CMSampleBufferRef. The result is encapsulated in SBSDKMedicalCertificateRecognizerResult instance.

The Medical Certificates Recognizer is based on the OCR feature and thus requires the proper installation of the OCR language file eng.traineddata (aka. blob file). For more details on how to set up the OCR language files please refer to the OCR section.

Medical Certificate Scanner UI

There are two ways to integrate the component into the application:

Ready to use UI component (more about RTU UI)
Classic UI component (more about Classic components)

danger

Please be aware that processing really large images may lead to out-of-memory crashes on iOS. Since this limit is highly dynamic and untransparent in iOS, depending on the device, your app's current memory usage, the other running apps, the iOS version, the system configuration and many other unknown variables, we did not add a hard limit for image sizes.

As a general rule of thumb, it is quite safe to assume that processing images of the resolution the camera can shoot will most likely not crash your app. On most modern iOS devices this currently translates to 12 megapixels. But even much larger images may work without crashing as well.

Thus we cannot take responsibility for out-of-memory crashes when dealing with very high-resolution images. It is your responsibility, as an app developer, to properly manage the handling of large images and keep the memory footprint of your app as small as possible.

In case you have any questions on this topic, please reach out to our support team.

caution

Please do not use multiple scanners at the same time. For example, do not combine generic document scanner, health insurance scanner, text data scanner, etc. at the same time! Each scanner instance requires a lot of memory, GPU, and processor resources. Using multiple scanners will lead to performance issues for the entire application.

Ready-To-Use UI Component

alt text

The main class of the Ready-To-Use UI (RTU UI) component is SBSDKUIMedicalCertificateScannerViewController.

Usually this view controller is used as a separate screen for scanning Medical certificates in a UIImage or CMSampleBufferRef. It returns the recognition results in a delegate method.

While you don't have direct control of the actual scanner view controller you can use the SBSDKUIMedicalCertificateScannerConfiguration to customize it in a variety of ways, such as colors, texts and behavior.

Swift
Objective-C

import UIKit
import ScanbotSDK

class MedicalCertificateScannerUISwiftViewController: UIViewController {

    override func viewDidAppear(_ animated: Bool) {
        super.viewDidAppear(animated)

        // Start scanning here. Usually this is an action triggered by some button or menu.
        self.startScanning()
    }

    private func startScanning() {

        // Create the default configuration object.
        let configuration = SBSDKUIMedicalCertificateScannerConfiguration.defaultConfiguration

        // Behavior configuration:
        // e.g. disable recognition of patient's personal information.
        configuration.behaviorConfiguration.isPatientInfoExtracted = false

        // UI configuration:
        // e.g. configure various colors.
        configuration.uiConfiguration.topBarBackgroundColor = UIColor.red
        configuration.uiConfiguration.topBarButtonsColor = UIColor.white

        // Text configuration:
        // e.g. customize UI element's text.
        configuration.textConfiguration.cancelButtonTitle = "Cancel"

        // Present the recognizer view controller modally on this view controller.
        SBSDKUIMedicalCertificateScannerViewController.present(on: self,
                                                               configuration: configuration,
                                                               delegate: self)
    }
}

extension MedicalCertificateScannerUISwiftViewController: SBSDKUIMedicalCertificateScannerViewControllerDelegate {
    func medicalScannerViewController(_ viewController: SBSDKUIMedicalCertificateScannerViewController,
                                      didFinishWith result: SBSDKMedicalCertificateRecognizerResult) {
        // Process the scanned result.
    }

    func medicalScannerViewControllerDidCancel(_ viewController: SBSDKUIMedicalCertificateScannerViewController) {
        // Handle canceling the scanner screen.
    }
}

#import "MedicalCertificateScannerUIObjcViewController.h"
@import ScanbotSDK;

@interface MedicalCertificateScannerUIObjcViewController () <SBSDKUIMedicalCertificateScannerViewControllerDelegate>

@end

@implementation MedicalCertificateScannerUIObjcViewController

- (void)viewDidAppear:(BOOL)animated {
    [super viewDidAppear:animated];

    // Start scanning here. Usually this is an action triggered by some button or menu.
    [self startScanning];
}

- (void)startScanning {

    // Create the default configuration object.
    SBSDKUIMedicalCertificateScannerConfiguration *configuration = [SBSDKUIMedicalCertificateScannerConfiguration defaultConfiguration];

    // Behavior configuration:
    // e.g. disable recognition of patient's personal information.
    configuration.behaviorConfiguration.isPatientInfoExtracted = NO;

    // UI configuration:
    // e.g. configure various colors.
    configuration.uiConfiguration.topBarBackgroundColor = [UIColor redColor];
    configuration.uiConfiguration.topBarButtonsColor = [UIColor whiteColor];

    // Text configuration:
    // e.g. customize UI element's text.
    configuration.textConfiguration.cancelButtonTitle = @"Cancel";

    // Present the recognizer view controller modally on this view controller.
    [SBSDKUIMedicalCertificateScannerViewController presentOn:self
                                                configuration:configuration
                                                     delegate:self];
}

- (void)medicalScannerViewController:(SBSDKUIMedicalCertificateScannerViewController *)viewController
                 didFinishWithResult:(SBSDKMedicalCertificateRecognizerResult *)result {
    // Process the scanned result.
}


- (void)medicalScannerViewControllerDidCancel:(SBSDKUIMedicalCertificateScannerViewController *)viewController {
    // Handle canceling the scanner screen.
}

@end

Classic UI Component

The main class of the Classic UI component is SBSDKMedicalCertificateScannerViewController.

Usually this view controller is embedded as a child view controller into another view controller, the parent view controller. The parent view controller usually acts as the delegate and processes the recognition results. You still have full control over the UI elements and can add additional views and buttons to your view controller. The Classic component does not display results, instead it just forwards them to the delegate.

Swift
Objective-C

import UIKit
import ScanbotSDK

class MedicalCertificateScannerSwiftViewController: UIViewController {

    // The instance of the scanner view controller.
    var scannerViewController: SBSDKMedicalCertificateScannerViewController?

    override func viewDidLoad() {
        super.viewDidLoad()

        // Create the SBSDKMedicalCertificateScannerViewController instance.
        self.scannerViewController = SBSDKMedicalCertificateScannerViewController(parentViewController: self,
                                                                                  parentView: self.view,
                                                                                  delegate: self)
    }
}

extension MedicalCertificateScannerSwiftViewController: SBSDKMedicalCertificateScannerViewControllerDelegate {
    func medicalCertificateScannerViewController(_ controller: SBSDKMedicalCertificateScannerViewController,
                                                 didRecognizeMedicalCertificate result: SBSDKMedicalCertificateRecognizerResult) {
        // Process the recognized result.
    }
}

#import "MedicalCertificateScannerObjcViewController.h"
@import ScanbotSDK;

@interface MedicalCertificateScannerObjcViewController () <SBSDKMedicalCertificateScannerViewControllerDelegate>

// The instance of the scanner view controller.
@property (strong, nonatomic) SBSDKMedicalCertificateScannerViewController *scannerViewController;

@end

@implementation MedicalCertificateScannerObjcViewController

- (void)viewDidLoad {
    [super viewDidLoad];

    // Create the SBSDKMedicalCertificateScannerViewController instance.
    self.scannerViewController =
    [[SBSDKMedicalCertificateScannerViewController alloc] initWithParentViewController:self
                                                                            parentView:self.view
                                                                              delegate:self];
}

- (void)medicalCertificateScannerViewController:(SBSDKMedicalCertificateScannerViewController *)controller
                 didRecognizeMedicalCertificate:(SBSDKMedicalCertificateRecognizerResult *)result {
    // Process the recognized result.
}

@end

Want to scan longer than one minute?

Generate a free trial license to test the Scanbot SDK thoroughly.

Get your free Trial License

Medical Certificate Scanner UI Components | iOS Document Scanner