Accéder au service FHIR à l'aide de Postman

Cet article décrit les étapes à suivre pour accéder au service FHIR® dans Services de données de santé Azure avec Postman.

Prérequis

• Service FHIR déployé dans Azure. Pour plus d'informations, consultez Déployer un service FHIR.
• Postman installé localement. Pour plus d'informations, consultez Bien démarrer avec Postman.
• Rôle Administrateur de l’accès utilisateur pour les attributions de rôles sur le service FHIR.

Étapes de configuration

Pour accéder au service FHIR à partir de l’application Postman, vérifiez les étapes suivantes :

1. Inscrivez une application cliente (Inscription d’application) dans Microsoft Entra ID.

2. Attribuez un rôle Contributeur de données FHIR sous le service FHIR.

3. Configurez Postman – Créez un espace de travail, une collection et un environnement

Inscrire une application cliente dans Microsoft Entra ID

1. Dans le portail Azure, sélectionnez la mosaïque Microsoft Entra ID.

2. Sélectionnez Inscriptions d’applications dans la section Gérer.

3. Sélectionnez + Nouvelles inscriptions.

4. Entrez un nom dans l’inscription d’application. Sous Types de comptes pris en charge, sélectionnez Comptes dans cet annuaire d’organisation uniquement. sélectionnez Inscrire.

ID d’application (ID client)

Après avoir inscrit une nouvelle application, vous pouvez trouver l’ID de l’application (client) et l’ID de l’annuaire (locataire) dans la section Vue d’ensemble. Notez ces valeurs pour une utilisation ultérieure, car vous en aurez besoin lors de la configuration de votre environnementPostman.

Paramètre d’authentification : confidentiel ou public

• Sélectionnez Authentification pour examiner les paramètres. La valeur par défaut pour Autoriser les flux clients publics est « Non ».

• Si vous conservez cette valeur par défaut, l’inscription de l’application est une application cliente confidentielle et un certificat ou un secret est requis.

• Si vous remplacez la valeur par défaut par « Oui » pour l’option « Autoriser les flux clients publics » dans les paramètres avancés, l’inscription de l’application est une application cliente publique et un certificat ou un secret n’est pas nécessaire.
  

• La valeur « Oui » est utile lorsque vous souhaitez utiliser l’application cliente dans votre application mobile ou une application JavaScript où vous ne souhaitez pas stocker de secrets.

• Pour les outils qui nécessitent une URL de redirection, sélectionnez Ajouter une plateforme pour configurer la plateforme.

• Pour Postman, sélectionnez Applications de bureau et mobiles. Entrez « https://www.getpostman.com/oauth2/callback" » dans la section URI de redirection personnalisés. Sélectionnez le bouton Configurer pour enregistrer les paramètres.

Certificats et secrets

1. Cliquez sur Certificats et secrets. Cliquez sur + Nouveau secret client.

2. Sous Ajouter une clé secrète client, entrez un nom pour le secret dans le champ Description. L’aide apportée consiste à fixer à 6 mois la date d’expiration du secret. Cliquez sur Ajouter.

3. Il est important d’enregistrer la valeur secrète, et non l’ID du secret.

Remarque

Utilisez grant_type de client_credentials lors de la tentative d’obtention d’un jeton d’accès pour le service FHIR à l’aide d’outils tels que Postman ou le client REST.

Attribuez un rôle Contributeur de données FHIR dans le service FHIR

Cette section présente les étapes à suivre pour attribuer le rôle Contributeur de données FHIR à une application inscrite pour le service FHIR® dans Azure Health Data Services.

1. Dans le portail Azure, naviguez vers votre service FHIR.

2. Dans le menu de gauche, sélectionnez le panneau Contrôle d’accès (IAM). Cliquez sur + Ajouter, puis sélectionnez Ajouter une attribution de rôle. Si l’option d’ajout d’une attribution de rôle n’est pas disponible, demandez à votre administrateur Azure de vous attribuer l’autorisation d’effectuer cette étape.

3. Dans Ajouter une attribution de rôle sous l’onglet Rôle, faites défiler la liste vers le bas et sélectionnez Contributeur de données FHIR. Cliquez ensuite sur Suivant.

4. Sous l’onglet Membres, cliquez sur +Sélectionner des membres. Tapez le nom de votre application client de service Postman dans le champ Sélectionner à droite. Sélectionnez l’application.

5. De la même façon, tapez le nom de votre nom d’utilisateur dans le champ Sélectionner. Sélectionnez votre utilisateur pour qu'il soit ajouté à la liste, ainsi qu’à l’inscription de l’application, puis cliquez sur Sélectionner. Cliquez ensuite sur Suivant.

6. Sous l’onglet Vérifier + attribuer, cliquez sur Vérifier + attribuer.

Configurez Postman – Créez un espace de travail, une collection et un environnement.

Si vous découvrez Postman, procédez comme suit pour créer un espace de travail, une collection et un environnement.

Postman présente le concept d'espace de travail pour vous permettre, à vous et à votre équipe, de partager des API, des collections, des environnements et d'autres composants. Vous pouvez utiliser l'espace de travail par défaut Mon espace de travail ou Espace de travail de l'équipe, ou encore créer un espace de travail pour vous ou votre équipe.

Ensuite, créez une collection dans laquelle vous pouvez regrouper toutes les requêtes d'API REST associées. Dans l'espace de travail, sélectionnez Créer des collections. Vous pouvez conserver le nom par défaut Nouvelle collection ou le renommer. La modification est enregistrée automatiquement.

Vous pouvez également importer et exporter des collections Postman. Pour plus d'informations, consultez la documentation Postman.

Créer ou mettre à jour des variables d'environnement

Bien que vous puissiez utiliser l'URL complète dans la requête, nous vous recommandons de stocker l'URL ainsi que d'autres données dans des variables.

Pour accéder au service FHIR, vous devez créer ou mettre à jour les variables suivantes :

Variable	Description	Notes
tenantid	Abonné Azure à partir duquel le service FHIR est déployé	Situé dans la présentation de l'inscription d'application
subid	Abonnement Azure à partir duquel le service FHIR est déployé	Situé dans la présentation du service FHIR
clientid	ID d'inscription du client d'application
clientsecret	Secret d'inscription du client d'application
fhirurl	URL complète du service FHIR (par exemple, https://xxx.azurehealthcareapis.com)	Situé dans la présentation du service FHIR
bearerToken	Stocke le jeton d'accès Microsoft Entra dans le script	Laisser vide

Remarque

Vérifiez que vous avez configuré l'URL de redirection https://www.getpostman.com/oauth2/callback dans l'inscription d'application cliente.

Obtenir l'instruction de capacité

Entrez {{fhirurl}}/metadata dans la requête GET, puis choisissez Send. L'instruction de capacité du service FHIR s'affiche.

Obtenir un jeton d’accès Microsoft Entra

Obtenez un jeton d'accès Microsoft Entra en choisissant soit un principal de service, soit un compte d'utilisateur Microsoft Entra.

Utiliser un principal de service avec un type d'autorisation d'informations d'identification client

Le service FHIR est sécurisé par Microsoft Entra ID. L'authentification par défaut ne peut pas être désactivée. Pour accéder au service FHIR, vous devez d'abord obtenir un jeton d'accès Microsoft Entra. Pour plus d’informations, consultez Jetons d’accès de la plateforme d’identités Microsoft.

Créer une requête POST :

1. Entrer l'en-tête de demande : https://login.microsoftonline.com/{{tenantid}}/oauth2/token

2. Sélectionnez l'onglet Corps puis x-www-form-urlencoded. Entrez les valeurs suivantes dans la section clé et valeur :

   • grant_type : Client_Credentials
   • client_id : {{clientid}}
   • client_secret : {{clientsecret}}
   • ressource : {{fhirurl}}

Remarque

Dans les scénarios où le paramètre d'audience du service FHIR n'est pas mappé à l'URL du point de terminaison du service FHIR, la valeur du paramètre de ressource doit être mappée à la valeur d'audience sur le volet Authentication du service FHIR.

3. Sélectionnez l’onglet Test et entrez pm.environment.set("bearerToken", pm.response.json().access_token); dans la section texte. Pour rendre la valeur disponible pour la collection, utilisez la méthode pm.collectionVariables.set. Pour plus d'informations sur la méthode définie et son niveau d'étendue, consultez Utilisation de variables dans des scripts.
4. Sélectionnez Enregistrer pour enregistrer les paramètres.
5. Sélectionnez Envoyer. Vous verrez une réponse avec le jeton d'accès Microsoft Entra, qui est enregistré automatiquement dans la variable bearerToken. Vous pouvez ensuite l'utiliser dans toutes les requêtes d'API du service FHIR.

Vous pouvez examiner le jeton d'accès à l'aide d'outils en ligne comme https://jwt.ms. Sélectionnez l'onglet Revendications pour afficher des descriptions détaillées pour chaque revendication dans le jeton.

Utiliser un compte d'utilisateur avec le type d'autorisation de code d'autorisation

Vous pouvez obtenir le jeton d'accès Microsoft Entra à l'aide des informations d'identification de votre compte Microsoft Entra et suivre les étapes répertoriées.

1. Vérifiez que vous êtes membre de l'abonné Microsoft Entra et que vous disposez d'autorisations d'accès requises.

2. Vérifiez que vous avez configuré l'URL de redirection https://oauth.pstmn.io/v1/callback pour la plateforme Web dans l'inscription de l'application cliente.

3. Dans l'inscription d'application cliente sous Autorisations d'API, ajoutez la permission déléguée User_Impersonation pour Azure Healthcare APIS à partir des API que mon organisation utilise.

4. Dans Postman, sélectionnez l'onglet Autorisation d'une collection ou d'un appel REST spécifique, sélectionnez Type en tant qu'OAuth 2.0 et, sous la section Configurer un nouveau jeton, définissez les valeurs suivantes :

   • URL de rappel : https://oauth.pstmn.io/v1/callback

   • URL d'authentification : https://login.microsoftonline.com/{{tenantid}}/oauth2/v2.0/authorize

   • URL du jeton d'accès : https://login.microsoftonline.com/{{tenantid}}/oauth2/v2.0/token

   • ID client : ID d'inscription du client d'application

   • Clé secrète client : secret d'inscription du client d'application

   • Étendue : {{fhirurl}}/.default

   • Authentification du client : envoyer les informations d'identification du client dans le corps

5. Choisissez Obtenir un nouveau jeton d'accès au bas de la page.

6. Fournissez les informations d’identification de l’utilisateur pour la connexion.

7. Une fois le jeton reçu, choisissez Utiliser le jeton.

8. Vérifiez que le jeton se trouve dans l'en-tête d'autorisation de l'appel REST.

Examinez le jeton d'accès à l'aide d'outils en ligne comme https://jwt.ms. Sélectionnez l'onglet Revendications pour afficher des descriptions détaillées pour chaque revendication dans le jeton.

Se connecter au serveur FHIR

Ouvrez Postman, sélectionnez l'espace de travail, la collection et l'environnement que vous souhaitez utiliser. Sélectionnez l'icône + pour créer une requête.

Pour effectuer une vérification de l'intégrité du service FHIR, entrez {{fhirurl}}/health/check dans la requête GET, puis choisissez Envoyer. Vous devriez être en mesure de voir la réponse de code Status of FHIR service - HTTP Status avec 200 et OverallStatus comme Sain dans la réponse, ce qui signifie que votre vérification de l'intégrité est réussie.

Obtenir la ressource FHIR

Après avoir obtenu un jeton d'accès Microsoft Entra, vous pouvez accéder aux données FHIR. Dans une nouvelle requête GET, entrez {{fhirurl}}/Patient.

Sélectionnez Jeton du porteur comme type d'autorisation. Entrez {{bearerToken}} dans la section Jeton. Sélectionnez Envoyer. En réponse, vous devez voir une liste de patients dans votre ressource FHIR.

Créer ou mettre à jour la ressource FHIR

Après avoir obtenu un jeton d'accès Microsoft Entra, vous pouvez créer ou mettre à jour les données FHIR. Par exemple, vous pouvez créer un patient ou mettre à jour un patient existant.

Créez une requête, remplacez la méthode par Post, puis entrez la valeur dans la section de la requête.

{{fhirurl}}/Patient

Sélectionnez Jeton du porteur comme type d'autorisation. Entrez {{bearerToken}} dans la section Jeton. Sélectionnez l’onglet Corps . Sélectionnez l'option brute et JSON comme format de texte de corps. Copiez et collez le texte suivant dans la section corps.

{
    "resourceType": "Patient",
    "active": true,
    "name": [
        {
            "use": "official",
            "family": "Kirk",
            "given": [
                "James",
                "Tiberious"
            ]
        },
        {
            "use": "usual",
            "given": [
                "Jim"
            ]
        }
    ],
    "gender": "male",
    "birthDate": "1960-12-25"
}

Sélectionnez Envoyer. Un nouveau patient devrait apparaître dans la réponse JSON.

Exporter des données FHIR

Après avoir obtenu un jeton d'accès Microsoft Entra, vous pouvez exporter des données FHIR vers un compte de stockage Azure.

Pour configurer les paramètres d’exportation et créer un compte Data Lake Storage Gen2, reportez-vous à Configurer les paramètres pour l’exportation.

Créer une GETrequête : {{fhirurl}}/$export?_container=export

Sélectionnez Jeton du porteur comme type d'autorisation. Entrez {{bearerToken}} dans la section Jeton. Sélectionnez En-têtes pour ajouter deux nouveaux en-têtes :

• Accepter : application/fhir+json

• Préférer : respond-async

Sélectionnez Envoyer. Une réponse 202 Accepted s'affiche. Sélectionnez l'onglet En-têtes de la réponse et notez la valeur dans Content-Location. Vous pouvez utiliser cette valeur pour interroger l'état du travail d'exportation.

Étapes suivantes

Collection de démarrage d'exemples de requêtes Postman

Remarque

FHIR® est une marque déposée de HL7 utilisé avec l’autorisation de HL7.