Paramètres de recherche sélectionnables (préversion)
Important
La fonctionnalité de paramètre de recherche sélectionnable est disponible en préversion. Les API et kits SDK en préversion sont fournis sans contrat de niveau de service (SLA). Nous vous recommandons de ne pas les utiliser pour les charges de travail de production. Certaines fonctionnalités peuvent être limitées ou non prises en charge. Pour plus d’informations, consultez Conditions d’Utilisation Supplémentaires relatives aux Évaluations Microsoft Azure.
La recherche de ressources est fondamentale pour le service FHIR®. Chaque ressource du service FHIR contient des informations sous la forme d’un ensemble d’éléments. Les paramètres de recherche fonctionnent pour interroger les informations de ces éléments. Lorsque le service FHIR est déployé, les paramètres de recherche intégrées sont activés par défaut. Le service FHIR effectue des recherches efficaces en extrayant et en indexant des propriétés spécifiques à partir de ressources FHIR pendant l’ingestion des données.
Les paramètres de recherche sélectionnables vous permettent d’activer ou de désactiver les paramètres de recherche intégrées. Cette fonctionnalité vous permet de stocker davantage de ressources dans l’espace de stockage alloué et d’améliorer les performances en activant uniquement les paramètres de recherche dont vous avez besoin.
Pour effectuer des mises à jour d’état sur les paramètres de recherche, procédez comme suit :
- Obtenez l’état des paramètres de recherche.
- Mettez à jour l’état des paramètres de recherche.
- Exécutez un travail de réindexation.
Dans cet article, nous montrons la syntaxe de recherche FHIR dans les exemples d’appels d’API avec l’espace réservé {{FHIR_URL}} pour représenter l’URL du serveur FHIR.
Obtenir l’état des paramètres de recherche
Un point de terminaison d’API ('$status') est fourni pour afficher l’état des paramètres de recherche. Il existe quatre états pour la réponse :
| Statut | Description |
|---|---|
| Prise en charge | Le paramètre de recherche est pris en charge par le service FHIR et vous avez envoyé des demandes pour activer le paramètre de recherche. Exécutez l’opération de réindexation à exécuter depuis prise en charge jusqu’à activée. |
| Enabled | Le paramètre de recherche est activé pour la recherche. Cet état est l’étape suivante après l’état pris en charge. |
| PendingDisable | La désactivation du paramètre de recherche est en attente après l’exécution de l’opération de réindexation. |
| Désactivé | Le paramètre de recherche est désactivé. |
Pour obtenir l’état sur tous les paramètres de recherche, utilisez la requête suivante. Cette requête retourne une liste de tous les paramètres de recherche et de leur état. Faites défiler la liste pour rechercher le paramètre de recherche dont vous avez besoin.
GET {{FHIR_URL}}/SearchParameter/$status
Pour identifier l’état d’une personne ou d’un sous-ensemble de paramètres de recherche, utilisez ces filtres :
- Nom. Pour identifier l’état du paramètre de recherche par nom, utilisez cette requête :
GET {{FHIR_URL}}/SearchParameter/$status?code=<name of search parameter/ sub string>
- URL. Pour identifier l’état du paramètre de recherche par son identificateur canonique, utilisez cette requête :
GET {{FHIR_URL}}/SearchParameter/$status?url=<SearchParameter url>
- Type de ressource. Dans FHIR, les paramètres de recherche sont activés au niveau de la ressource individuelle pour permettre le filtrage et la récupération d’un sous-ensemble spécifique de ressources. Pour identifier l’état de tous les paramètres de recherche mappés à une ressource, utilisez cette requête :
GET {{FHIR_URL}}/SearchParameter/$status?resourcetype=<ResourceType name>
En réponse à la requête GET pour $status point de terminaison, le type de ressource de paramètres est retourné avec l’état du paramètre de recherche. Consultez l’exemple de réponse :
{
"resourceType" : "Parameters",
"parameter" : [
"name" : "searchParameterStatus",
"part" : {
{
"name" : "url",
"valueString" : "http://hl7.org/fhir/SearchParameter/Account-identifier"
},
{
"name" : "status",
"valueString" : "supported"
}
}
]
}
Mettre à jour l’état des paramètres de recherche
Après avoir obtenu l’état des paramètres de recherche, mettez à jour l’état des paramètres de recherche vers Supported ou Disabled.
Remarque
Pour mettre à jour l’état des paramètres de recherche, vous avez besoin du rôle RBAC Azure Search Parameter Manager .
L’état des paramètres de recherche peut être mis à jour pour un paramètre de recherche unique ou en bloc.
Mettre à jour un état de paramètre de recherche unique
Pour mettre à jour l’état d’un paramètre de recherche unique, utilisez cette demande d’API :
PUT {{FHIR_URL}}/SearchParameter/$status
{
"resourceType": "Parameters",
"parameter": [
{
"name": "searchParameterStatus",
"part": [
{
"name": "url",
"valueUrl": "http://hl7.org/fhir/SearchParameter/Resource-test-id"
},
{
"name": "status",
"valueString": "Supported"
}
]
}
]
}
Selon votre cas d’usage, vous pouvez conserver la valeur d’état d’état sur « Supported » ou « Disabled » pour un paramètre de recherche. Lorsque vous envoyez l’état Disabled dans la requête, la réponse retourne comme étant donné qu’un PendingDisable travail de réindexation doit s’exécuter pour supprimer entièrement les associations.
Si vous recevez un code d’état HTTP 400 dans la réponse, cela signifie qu’il n’existe aucune correspondance unique pour le paramètre de recherche identifié. Vérifiez l’ID du paramètre de recherche.
Mettre à jour l’état des paramètres de recherche en bloc
Pour mettre à jour l’état des paramètres de recherche en bloc, la requête « PUT » doit avoir la liste des ressources « Paramètres » dans le corps de la requête. La liste doit contenir les paramètres de recherche individuels qui doivent être mis à jour.
PUT {{FHIR_URL}}/SearchParameter/$status
{
"resourceType" : "Parameters",
"parameter" : [
{
"name" : "searchParameterStatus",
"part" :{
"name" : "url",
"valueString" : "http://hl7.org/fhir/SearchParameter/Endpoint-name"
},
"part":{
"name" : "status",
"valueString" : "supported"
}
},
"name" : "searchParameterStatus",
"part" :{
"name" : "url",
"valueString" : "http://hl7.org/fhir/SearchParameter/HealthcareService-name"
},
"part":{
"name" : "status",
"valueString" : "supported"
}
},
...
]
}
Exécuter un travail de réindexation
Après avoir mis à jour l’état du paramètre de Supported recherche vers ou Disabled, l’étape suivante consiste à exécuter un travail de réindexation.
Tant que le paramètre de recherche n’est pas indexé, l’état et Disabled l’état Enabled des paramètres de recherche ne sont pas activés. Réindexer l’exécution du travail met à jour l’état de Supported vers Enabled ou PendingDisable vers Disabled.
Un travail de réindexation peut être exécuté sur l’ensemble de la base de données du service FHIR ou sur des paramètres de recherche spécifiques. Un travail de réindexation peut être gourmand en performances. Pour plus d’informations, consultez Exécuter un travail de réindexation.
Remarque
Un document d’instruction de capacité est un ensemble de comportements pour un serveur FHIR. Une instruction de fonctionnalité est disponible pour le point de terminaison /metadata. Enabled les paramètres de recherche sont répertoriés dans l’instruction de fonctionnalité de votre service FHIR.
Forums Aux Questions (FAQ)
Quel est le comportement si la requête inclut un paramètre de recherche avec l’état « Pris en charge » ?
Le paramètre de recherche dans l’état « Pris en charge » doit être réindexé. Jusqu’à ce moment, le paramètre de recherche n’est pas activé. Si une requête est exécutée sur un paramètre de recherche non actif, le service FHIR affiche une réponse sans tenir compte de ce paramètre de recherche. Dans la réponse, un message d’avertissement indique que le paramètre de recherche n’a pas été indexé et n’est donc pas utilisé dans la requête. Pour afficher une erreur dans de telles situations, utilisez l’en-tête « Prefer : handling » avec la valeur « strict ». En définissant cet en-tête, les avertissements sont signalés comme des erreurs.
Étapes suivantes
Définir des paramètres de recherche personnalisés
Remarque
FHIR® est une marque déposée de HL7 utilisé avec l’autorisation de HL7.