rs/socialite-healthcare-authenticator

Socialite Healthcare Authenticator

0.5 2025-09-30 09:14 UTC

Requires

• php: ^8.3
• socialiteproviders/manager: ^4.8

Requires (Dev)

• larastan/larastan: ^3.1
• laravel/pint: ^1.21
• orchestra/testbench: ^10.0
• phpstan/extension-installer: ^1.4
• phpstan/phpstan-deprecation-rules: ^2.0
• phpstan/phpstan-phpunit: ^2.0
• phpunit/phpunit: ^11.5

MIT

• Param Dhaliwal

• rs
• healthcare-authenticator

README

Allows for web portals for HCPs to seamlessly implement and maintain sign-on, authentication, and/or verification through integration with one of the world’s largest and most accurate sources of HCP data.

Installation

You can install the package via composer:

composer require rs/socialite-healthcare-authenticator

Installation & Basic Usage

Please see the Base Installation Guide, then follow the provider specific instructions below.

Add configuration to config/services.php

'hca' => [    
  'client_id' => env('HCA_CLIENT_ID'),  
  'client_secret' => env('HCA_CLIENT_SECRET'),  
  'redirect' => env('HCA_REDIRECT_URI'),
  'profile_extended'=>true // Set this to false if you dont have access to the full profile
  'api_key'=>env('HCA_API_KEY')
],

Add the API key for user consents and magic links.

Add provider event listener

Configure the package's listener to listen for SocialiteWasCalled events.

Add the event to your listen[] array in app/Providers/EventServiceProvider. See the Base Installation Guide for detailed instructions.

protected $listen = [
    \SocialiteProviders\Manager\SocialiteWasCalled::class => [
        // ... other providers
        \RedSnapper\SocialiteProviders\HealthCareAuthenticator\HealthCareAuthenticatorExtendSocialite::class
    ],
];

Usage

You should now be able to use the provider like you would regularly use Socialite (assuming you have the facade installed):

return Socialite::driver('hca')->redirect();

Can provide the locale using the with method.

return Socialite::driver('hca')->with(['locale'=>'it-IT'])->redirect();

Available methods for the returned user.

$user  = Socialite::driver('hca')->user();

$user->getId();
$user->getEmail();
$user->getName();
$user->getTitle();
$user->getFirstName();
$user->getLastName();
$user->getPhoneNumber();
$user->getWorkplaceAddress();
$user->getCity();
$user->getZipCode();
$user->getSpecialties(); // [Speciality]
$user->getProfessionalCode(); // ProfessionalCode
$user->getOneKeyId();
$user->getTrustLevel();

Professional Code

You can also retrieve the user's professional code using the getProfessionalCode method. This returns back a ProfessionalCode object. The professional code has a method for each professional code type.

$professionalCode = $user->getProfessionalCode();
$professionalCode->codeFiscale();

The code is sourced from Onekey data. If unavailable, it defaults to the code provided during the signup process.

Consents

You can also retrieve the user's consents using the consents method.

$user->consents()->all();

This returns back a Laravel collection.

$user->consents()->ids(); // [1,2,3]
$user->consents()->captions(); // ['Consent 1','Consent 2']

Handling errors

When calling the user method, the following exceptions may be thrown:

\RedSnapper\SocialiteProviders\HealthCareAuthenticator\UserNotFoundException

This exception is thrown when a user is not found in the Healthcare Authenticator system (404 response). It provides access to the user ID and response body.

\RedSnapper\SocialiteProviders\HealthCareAuthenticator\HealthCareAuthenticatorRequestException

This exception is thrown if the user cancels the sign-up process or fails to verify as an HCP.

\Laravel\Socialite\Two\InvalidStateException

This exception is thrown if the state returned by the HCA service does not match the state stored in the session.

\Illuminate\Http\Client\RequestException

This exception is thrown for other HTTP errors (500, 503, etc.).

Example exception handling:

use RedSnapper\SocialiteProviders\HealthCareAuthenticator\UserNotFoundException;
use RedSnapper\SocialiteProviders\HealthCareAuthenticator\HealthCareAuthenticatorRequestException;
use Illuminate\Http\Client\RequestException;

try {
    $user = Socialite::driver('hca')->user();
} catch (UserNotFoundException $e) {
    // Handle user not found
    Log::warning('User not found in HCA', [
        'user_id' => $e->getUserId(),
        'response' => $e->getResponseBody(),
    ]);
    return redirect()->route('login')
        ->with('error', 'Account not found in Healthcare Authenticator.');
} catch (HealthCareAuthenticatorRequestException $e) {
    // Handle user cancellation or verification failure
    return redirect()->route('login')
        ->with('error', 'Authentication failed: ' . $e->getMessage());
} catch (InvalidStateException $e) {
    // Handle state mismatch
    return redirect()->route('login')
        ->with('error', 'Authentication state mismatch. Please try again.');
} catch (RequestException $e) {
    // Handle other HTTP errors
    Log::error('HCA request failed', [
        'status' => $e->response->status(),
        'message' => $e->getMessage(),
    ]);
    return redirect()->route('login')
        ->with('error', 'An error occurred during authentication.');
}

Magic Links

Magic links are secure, one-time use URLs that allow Healthcare Professionals (HCPs) to quickly sign in or verify their identity without entering credentials. This package now supports generating magic links for HCPs using the Healthcare Authenticator (HCA) API.

To create magic links, use the MagicLink class by providing your client_id, api_key, and redirect URI. You then call the createLinks method with an array of recipients.

Each recipient must include the following fields:

• onekey_id (string): The OneKey identifier of the HCP.
• email (string): The email address of the HCP.
• locale (string): The locale/language code (e.g., 'en-US', 'it-IT').

You can also specify the expiry time for the links in minutes.

The createLinks method returns a MagicLinkResult object containing collections of successful and failed links.

Example usage:

use RedSnapper\SocialiteProviders\HealthCareAuthenticator\MagicLink;

$magicLink = new MagicLink(
    clientId: config('services.hca.client_id'),
    apiKey: config('services.hca.api_key'),
    redirect: config('services.hca.redirect'),
);

$recipients = [
    ['onekey_id' => '123456', 'email' => '[e-mail]', 'locale' => 'en-US'],
    ['onekey_id' => '789012', 'email' => '[e-mail]', 'locale' => 'it-IT'],
];

$result = $magicLink->createLinks($recipients, expiryMinutes: 60);

You can iterate over successful and failed links as follows:

foreach ($result->successful() as $link) {
    // $link is a GeneratedMagicLink DTO
    echo "Magic link for {$link->accountEmail}: {$link->url}\n";
}

foreach ($result->failed() as $failed) {
    // $failed is a FailedMagicLink DTO
    echo "Failed to create link for {$failed->requestEmail}: {$failed->error}\n";
}

Both successful and failed links are returned as lightweight Data Transfer Objects (DTOs):

• GeneratedMagicLink for successful links.
• FailedMagicLink for failed link creation attempts.

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Param Dhaliwal
• All Contributors

License

The MIT License (MIT). Please see License File for more information.