API de demande d’aide à distance
L’API de demande d’aide à distance fournit des points de terminaison permettant de créer, d’afficher et d’extraire des listes de demandes de service informatique et leurs détails à partir d’un système de dossier médical électronique (DME). Une demande de service informatique est associée à un type de tâche tel qu’un incident dans l’instance ServiceNow .
Vous ne pouvez utiliser cette API que lorsque le EMR Help L’application (sn_ind_rmt_help) est installée à partir du ServiceNow Store. Visitez le site Web ServiceNow Store pour découvrir toutes les applications disponibles et pour obtenir des informations sur la procédure à suivre pour soumettre des demandes à la boutique. Pour obtenir des informations sur les notes de publication cumulatives pour toutes les applications publiées, consultez les ServiceNow Storenotes de publication relatives à l'historique des versions.
Rôle requis pour accéder aux points de terminaison de cette API : sn_ind_rmt_help.requester.
Demande d’aide à distance - POST /remote_help_request/{req_defn_id}
Insère les données du système de dossiers médicaux électroniques (DME) dans les tables correspondantes ServiceNow .
Vous devez spécifier un ID de définition de demande en plus des paramètres de la tâche, et des données supplémentaires du système EMR ont persisté dans la table de données de la demande associée à la tâche. Vous transmettez deux types de données à ce point de terminaison. La première correspond aux données de demande, que le point de terminaison insère dans la table Données de demande distante [sn_ind_rmt_help_request_data] et ses tables enfants associées. Le second correspond aux paramètres de tâche de la demande de service informatique, que le point de terminaison insère dans la table Paramètre de demande distante [sn_ind_rmt_help_request_param]. Seules les données ou les champs qui sont définis dans les définitions de demandes sont traités par le point de terminaison. Pour plus d’informations sur ce modèle de données, consultez Modèle de données EMR Help.
Les enregistrements sont identifiés à l’aide de l’ID de définition de demande.
Format d'URL
URL versionnée : /api/sn_ind_rmt_help/{api_version}/remote_help_request/{req_defn_id}
URL par défaut : /api/sn_ind_rmt_help/remote_help_request/{req_defn_id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
| req_defn_id | ID unique de la définition de la demande. Cette valeur correspond à la colonne ID de la table Définition de demande distante [sn_ind_rmt_help_request_defn]. Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| request_data | Requis. Paires nom-valeur des données de demande du système EMR à ajouter à la table Données de demande distante [sn_ind_rmt_help_request_data] et à ses tables enfants. Par exemple : Remarque :
Ne transmettez que les paramètres configurés dans une définition de demande dans l’objet request_data . Tous les autres paramètres sont ignorés. Pour en savoir plus, reportez-vous à la rubrique Configurer les définitions de demandes pour les systèmes EMR. Type de données : objet |
| source | Requis. Nom du système EMR appelant le point de terminaison, tel que spécifié dans une définition de demande. Par exemple : Type de données : chaîne |
| task_parameters | Requis. Paires nom-valeur qui décrivent les paramètres de tâche de la demande de service informatique. Chaque élément de l’objet correspond à une colonne dans les tables de tâches correspondantes, telles que la table Incident [incident]. Par exemple : Remarque :
Ne transmettez que les paramètres configurés dans une définition de demande dans l’objet task_parameters . Tous les autres paramètres sont ignorés. Pour en savoir plus, reportez-vous à la rubrique Configurer les définitions de demandes pour les systèmes EMR. Type de données : objet |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| résultat | Objet de résultat.Type de données : objet |
| result.code | Code d’erreur de l’application lorsque le result.status est renvoyé comme échec. Type de données : chaîne |
| erreur.résultat | Message d’erreur inclus en cas result.status de défaillance. Ce message est en anglais uniquement. Type de données : chaîne |
| résultat.erreurtraduite | Message d’erreur localisé facultatif. Type de données : chaîne |
| résultat.état | État de la réponse. Valeurs valides :
Type de données : chaîne |
| result.task_id | Sys_id de la tâche créée. Type de données : chaîne |
| result.task_table | Nom de la table de tâches dans laquelle la tâche a été créée, tel que défini dans la définition de demande. Type de données : chaîne |
| résultat.avertissement | Message d’avertissement facultatif. Peut être inclus en cas de result.statusréussite. Ce message est en anglais uniquement. Type de données : chaîne |
| résultat.avertissementtraduit | Message d’avertissement localisé facultatif. Type de données : chaîne |
Demande cURL
Insérez des données à partir d’un système Cerner EMR.
curl "https://instance.servicenow.com/api/sn_ind_rmt_help/v1/remote_help_request/sn_it_request"
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{
"source":"Cerner",
"task_parameters":{
"short_description":"Unable to load patient data",
"caller_id":"82d4ecb4db40e8100e28aa594b96195c",
"impact":"2",
"contact_type":"email"
},
"request_data":{
"application":"Powerchart",
"server":"CTXCHSITN453",
"environment":"CTX24",
"issue_type":"Helpdesk",
"millennium_username":"JOHN JASON",
"position":"Lab Tech",
"session_recording_id":"s5ds34dd96491b959a35010651896k",
"user_is_physician":"Yes",
"work_station":"PC354FLR3STATION7",
"additional_info":"MRN 222333"
}
}" \
--user "username":"password"La sortie suivante affiche à la fois une réponse réussie et une réponse d’erreur.
// Successful response
{
"result": {
"task_id": "75b09061db2cac100e28aa594b9619fa",
"status": "success",
"task_table": "incident",
"warning": "Ignored invalid fields on table incident : test1",
"warningTranslated": "Ignored invalid fields on table incident : test1"
}
}
// Error response
{
"result": {
"status": "failure",
"code": "1001",
"error": "Invalid request definition: test_request1",
"errorTranslated": "Invalid request definition: test_request1"
}
}Demande d’aide à distance - PUT /remote_help_request/{req_defn_id/task/{task_id}
Met à jour un enregistrement dans la table de données de la demande distante spécifiée pour la tâche.
Vous permet de spécifier un ID de définition de demande en plus du sys_id de tâche pour mettre à jour une demande distante créée précédemment.
Format d'URL
URL versionnée : /api/sn_ind_rmt_help/{api_version}/remote_help_request/{req_defn_id/task/{task_id}
URL par défaut : /api/sn_ind_rmt_help/remote_help_request/{req_defn_id/task/{task_id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
| req_defn_id | ID unique de la définition de la demande. Cette valeur correspond à la colonne ID de la table Définition de demande distante [sn_ind_rmt_help_request_defn]. Type de données : chaîne |
| task_id | Sys_id de la tâche à mettre à jour. Ce champ est fourni par le système DME. Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| request_data | Requis. Paires nom-valeur des données de demande du système EMR pour mettre à jour la table Données de demande distante [sn_ind_rmt_help_request_data] ou sa table enfant. Par exemple : Remarque :
Ne transmettez que les paramètres configurés dans une définition de demande dans l’objet request_data . Tous les autres paramètres sont ignorés. Pour en savoir plus, reportez-vous à la rubrique Configurer les définitions de demandes pour les systèmes EMR. Type de données : objet |
| source | Requis. Nom du système EMR appelant le point de terminaison, tel que spécifié dans une définition de demande. Par exemple : Type de données : chaîne |
| task_parameters | Requis. Paires nom-valeur qui décrivent les paramètres de tâche de la demande de service informatique. Chaque élément de l’objet correspond à une colonne dans les tables de tâches correspondantes, telles que la table Incident [incident]. Par exemple : Remarque :
Ne transmettez que les paramètres configurés dans une définition de demande dans l’objet task_parameters . Tous les autres paramètres sont ignorés. Pour en savoir plus, reportez-vous à la rubrique Configurer les définitions de demandes pour les systèmes EMR. Type de données : objet |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| résultat | Objet de résultat.Type de données : objet |
| result.code | Code d’erreur de l’application lorsque le result.status est renvoyé comme échec. Type de données : chaîne |
| erreur.résultat | Message d’erreur inclus en cas result.status de défaillance. Ce message est en anglais uniquement. Type de données : chaîne |
| résultat.erreurtraduite | Message d’erreur localisé facultatif. Type de données : chaîne |
| résultat.état | État de la réponse. Valeurs valides :
Type de données : chaîne |
| résultat.avertissement | Message d’avertissement facultatif. Peut être inclus en cas de result.statusréussite. Ce message est en anglais uniquement. Type de données : chaîne |
| résultat.avertissementtraduit | Message d’avertissement localisé facultatif. Type de données : chaîne |
Demande cURL
Mettre à jour une demande de service informatique créée précédemment dans un système Cerner EMR
curl "https://instance.servicenow.com/api/sn_ind_rmt_help/v1/remote_help_request/sn_it_request/task/207e57c1db60a410f50fdc5b4b96192e"
--request PUT \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{
"source":"Cerner",
"task_parameters":{
"impact":"1",
"contact_type":"phone"
},
"request_data":{
"additional_info" : "Please contact my office for more information."
}
}" \
--user "username":"password"
La sortie suivante affiche à la fois une réponse réussie et une réponse d’erreur.
// Successful response
{
"result": {
"status": "success"
}
}
// Error response
{
{
"result": {
"status": "failure",
"code": "1018",
"error": "Record with sys_id 207e57js1db60a410f50fdc5b4b96192e does not exist in table incident",
"errorTranslated": "Record with sys_id 207e57js1db60a410f50fdc5b4b96192e incident does not exist in table incident"
}
}
}Demande d’aide à distance : GET /remote_help_request/{req_defn_id}
Récupère une liste de tâches qui correspondent à l’ID et au filtre de requête spécifiés.
- Les champs de type Référence et Choix sont toujours renvoyés sous forme d’objets JSON avec la valeur et le display_value.
- Les champs DateTime sont renvoyés sous forme de chaînes et toujours en UTC.
Format d'URL
URL versionnée : /api/sn_ind_rmt_help/{api_version}/remote_help_request/{req_defn_id}
URL par défaut : /api/sn_ind_rmt_help/remote_help_request/{req_defn_id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
| req_defn_id | ID unique de la définition de demande à mettre à jour. Cette valeur correspond à la colonne ID de la table Définition de demande distante [sn_ind_rmt_help_request_defn]. Type de données : chaîne |
| Nom | Description |
|---|---|
| query | Requis. Requête codée utilisée pour filtrer l’ensemble de résultats. Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| résultat | Résultats renvoyés.Type de données : objet |
| result.code | Code d’erreur de l’application lorsque le result.status est renvoyé comme échec. Type de données : chaîne |
| erreur.résultat | Message d’erreur inclus en cas result.status de défaillance. Ce message est en anglais uniquement. Type de données : chaîne |
| résultat.erreurtraduite | Message d’erreur localisé facultatif. Type de données : chaîne |
| résultat.état | État de la réponse. Valeurs possibles :
Type de données : chaîne |
| result.task_list | Liste des tâches. Type de données : tableau |
| résultat.avertissement | Message d’avertissement facultatif. Peut être inclus en cas de result.statusréussite. Ce message est en anglais uniquement. Type de données : chaîne |
| résultat.avertissementtraduit | Message d’avertissement localisé facultatif. Type de données : chaîne |
Demande cURL
Extraction des données d’un système Cerner EMR
curl "https://instance.servicenow.com/api/remote_help_request/v1/sn_it_request/?query=active=true" \
--header "Accept: application/json" \
--header "Content-Type: application/json"
{
"source":"Cerner",
} \
--user "username":"password"La sortie suivante affiche à la fois une réponse réussie et une réponse d’erreur.
// Successful response
{
"result": {
"status": "success",
"task_list": [
{
"number": "INC0010096",
"short_description": "Unable to load data - 1",
"assigned_to": {
"value": "7a381da2dbfb5410f50fdc5b4b9619f2",
"display_value": "Abel Tuter (IT agent)"
},
"opened_at": "2020-11-16 18:37:57",
"closed_at": "",
"closed_by": {},
"state": {
"value": "2",
"display_value": "In Progress"
},
"priority": {
"value": "5",
"display_value": "5 - Planning"
},
"resolved_at": "",
"resolved_by": {},
"task_id": "207e57c1db60a410f50fdc5b4b96192e"
},
{
"number": "INC0010095",
"short_description": "Application freezes intermittently 3",
"assigned_to": {},
"opened_at": "2020-11-16 18:32:05",
"closed_at": "",
"closed_by": {},
"state": {
"value": "1",
"display_value": "New"
},
"priority": {
"value": "5",
"display_value": "5 - Planning"
},
"resolved_at": "",
"resolved_by": {},
"task_id": "561d1f8ddb20a410f50fdc5b4b9619da"
}
]
}
}
// Error response
{
"result": {
"status": "failure",
"code": "1019",
"error": "Invalid query in the request for table incident",
"errorTranslated": "Invalid query in the request for table incident"
}Demande d’aide à distance : GET /remote_help_request/{req_defn_id}/task/{task_id}
Récupère une seule tâche comme spécifié dans le task_idfichier .
- Les champs de type Référence et Choix sont toujours renvoyés sous forme d’objets JSON avec la valeur et le display_value.
- Les champs DateTime sont renvoyés sous forme de chaînes et toujours en UTC.
- Seuls les commentaires supplémentaires sont pris en charge dans les champs de type journal.
- Les commentaires supplémentaires sont renvoyés sous forme de tableau JSON d’objets. Chaque objet représente un commentaire avec created_ondes champs , created_by, et value . Les commentaires les plus récents sont envoyés en premier.
Format d'URL
URL versionnée : /api/sn_ind_rmt_help/{api_version}/remote_help_request/{req_defn_id}/task/{task_id}
URL par défaut : /api/sn_ind_rmt_help/remote_help_request/{req_defn_id}/task/{task_id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
| req_defn_id | ID unique de la définition de la demande. Cette valeur correspond à la colonne ID de la table Définition de demande distante [sn_ind_rmt_help_request_defn]. Type de données : chaîne |
| task_id | Sys_id de la tâche à renvoyer. Ce champ est fourni par le système DME. Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| résultat | Résultats renvoyés.Type de données : objet |
| result.code | Code d’erreur de l’application lorsque le result.status est renvoyé comme échec. Type de données : chaîne |
| erreur.résultat | Message d’erreur inclus en cas result.status de défaillance. Ce message est en anglais uniquement. Type de données : chaîne |
| résultat.erreurtraduite | Message d’erreur localisé facultatif. Type de données : chaîne |
| résultat.état | État de la réponse. Valeurs possibles :
Type de données : chaîne |
| result.task_parameters | Requis. Paires nom-valeur qui décrivent les paramètres de tâche de la demande de service informatique. Chaque élément de l’objet correspond à une colonne dans les tables de tâches correspondantes, telles que la table Incident [incident]. Type de données : objet |
| résultat.avertissement | Message d’avertissement facultatif. Peut être inclus en cas de result.statusréussite. Ce message est en anglais uniquement. Type de données : chaîne |
| résultat.avertissementtraduit | Message d’avertissement localisé facultatif. Type de données : chaîne |
Demande cURL
Extraction des données d’un système Cerner EMR
curl "https://instance.servicenow.com/api/sn_ind_rmt_help/v1/remote_help_request/sn_it_request/task/207e57c1db60a410f50fdc5b4b96192e"\
--request GET \
--header "Accept: application/json"\
--user "username":"password"La sortie suivante affiche à la fois une réponse réussie et une réponse d’erreur.
// Successful response
{
"result": {
"status": "success",
"task_parameters": {
"number": "INC0010096",
"short_description": "Unable to load data - 1",
"state": {
"value": "2",
"display_value": "In Progress"
},
"assigned_to": {
"value": "7a381da2dbfb5410f50fdc5b4b9619f2",
"display_value": "Abel Tuter (IT agent)"
},
"priority": {
"value": "5",
"display_value": "5 - Planning"
},
"caller_id": {
"value": "82d4ecb4db40e8100e28aa594b96195c",
"display_value": "Abel Tuter Requester"
},
"opened_at": "2020-11-16 18:37:57",
"closed_at": "",
"closed_by": {},
"description": "",
"impact": {
"value": "1",
"display_value": "1 - High"
},
"opened_by": {
"value": "82d4ecb4db40e8100e28aa594b96195c",
"display_value": "Abel Tuter Requester"
},
"close_code": {},
"close_notes": "",
"urgency": {
"value": "3",
"display_value": "3 - Low"
},
"category": {
"value": "inquiry",
"display_value": "Inquiry / Help"
},
"resolved_at": "",
"resolved_by": {},
"comments": [
{
"created_on": "2020-11-17 18:20:04",
"created_by": "Abel Tuter Requester",
"value": "You can reach me during office hours."
},
{
"created_on": "2020-11-16 18:40:14",
"created_by": "Abel Tuter Requester",
"value": "You can reach me during office hours."
},
{
"created_on": "2020-11-16 18:38:29",
"created_by": "Abel Tuter",
"value": "Hello there\rName of app please"
}],
"task_id": "207e57c1db60a410f50fdc5b4b96192e"
}
}
}
// Error response
{
"result": {
"status": "failure",
"code": "1001",
"error": "Invalid request definition: test_request2",
"errorTranslated": "Invalid request definition: test_request2"
}
}