$questionnaire-packageOpération FHIR pour HealthLake

L'$questionnaire-packageopération récupère un ensemble complet contenant un questionnaire FHIR et toutes ses dépendances nécessaires au rendu et au traitement du questionnaire. Cette opération met en œuvre le guide de mise en œuvre des modèles et règles de documentation Da Vinci (DTR), permettant le rendu dynamique des formulaires pour les exigences en matière de documentation dans les flux de travail du secteur de la santé.

Comment ça marche

Cas d'utilisation

Point de terminaison d’API

POST /datastore/{datastoreId}/r4/Questionnaire/$questionnaire-package  
Content-Type: application/fhir+json

Paramètres de demande

Paramètres d’entrée

Le corps de la demande doit contenir une ressource de paramètres FHIR avec les paramètres suivants :

Règles de validation des paramètres

Au moins UN des éléments suivants doit être fourni (en plus de ce qui est obligatoirecoverage) :

Combinaisons de demandes valides :

Exemple de demande

POST /datastore/example-datastore/r4/Questionnaire/$questionnaire-package  
Content-Type: application/fhir+json  
Authorization: Bearer <your-token>  
  
{  
  "resourceType": "Parameters",  
  "parameter": [  
    {  
      "name": "coverage",  
      "resource": {  
        "resourceType": "Coverage",  
        "id": "example-coverage",  
        "status": "active",  
        "beneficiary": {  
          "reference": "Patient/example-patient"  
        },  
        "payor": [{  
          "reference": "Organization/example-payer"  
        }],  
        "class": [{  
          "type": {  
            "coding": [{  
              "system": "http://terminology.hl7.org/CodeSystem/coverage-class",  
              "code": "group"  
            }]  
          },  
          "value": "12345"  
        }]  
      }  
    },  
    {  
      "name": "questionnaire",  
      "valueCanonical": "http://example.org/fhir/Questionnaire/home-oxygen-therapy|2.0"  
    },  
    {  
      "name": "order",  
      "resource": {  
        "resourceType": "ServiceRequest",  
        "id": "example-service-request",  
        "status": "active",  
        "intent": "order",  
        "code": {  
          "coding": [{  
            "system": "http://www.ama-assn.org/go/cpt",  
            "code": "94660",  
            "display": "Continuous positive airway pressure ventilation (CPAP)"  
          }]  
        },  
        "subject": {  
          "reference": "Patient/example-patient"  
        }  
      }  
    },  
    {  
      "name": "changedSince",  
      "valueDateTime": "2024-01-01T00:00:00Z"  
    }  
  ]  
}

Format de la réponse

Réponse positive (200 OK)

L'opération renvoie une ressource de paramètres FHIR contenant un ou plusieurs Package Bundles. Chaque Package Bundle inclut :

{  
  "resourceType": "Parameters",  
  "parameter": [  
    {  
      "name": "PackageBundle",  
      "resource": {  
        "resourceType": "Bundle",  
        "id": "questionnaire-package-example",  
        "meta": {  
          "profile": ["http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/DTR-QPackageBundle"]  
        },  
        "type": "collection",  
        "timestamp": "2024-03-15T10:30:00Z",  
        "entry": [  
          {  
            "fullUrl": "http://example.org/fhir/Questionnaire/home-oxygen-therapy",  
            "resource": {  
              "resourceType": "Questionnaire",  
              "id": "home-oxygen-therapy",  
              "url": "http://example.org/fhir/Questionnaire/home-oxygen-therapy",  
              "version": "2.0",  
              "status": "active",  
              "title": "Home Oxygen Therapy Documentation",  
              "item": [  
                {  
                  "linkId": "1",  
                  "text": "Patient diagnosis",  
                  "type": "choice",  
                  "answerValueSet": "http://example.org/fhir/ValueSet/oxygen-diagnoses"  
                }  
              ]  
            }  
          },  
          {  
            "fullUrl": "http://example.org/fhir/Library/oxygen-prepopulation",  
            "resource": {  
              "resourceType": "Library",  
              "id": "oxygen-prepopulation",  
              "url": "http://example.org/fhir/Library/oxygen-prepopulation",  
              "version": "1.0",  
              "type": {  
                "coding": [{  
                  "system": "http://terminology.hl7.org/CodeSystem/library-type",  
                  "code": "logic-library"  
                }]  
              },  
              "content": [{  
                "contentType": "text/cql",  
                "data": "bGlicmFyeSBPeHlnZW5QcmVwb3B1bGF0aW9u..."  
              }]  
            }  
          },  
          {  
            "fullUrl": "http://example.org/fhir/ValueSet/oxygen-diagnoses",  
            "resource": {  
              "resourceType": "ValueSet",  
              "id": "oxygen-diagnoses",  
              "url": "http://example.org/fhir/ValueSet/oxygen-diagnoses",  
              "status": "active",  
              "expansion": {  
                "timestamp": "2024-03-15T10:30:00Z",  
                "contains": [  
                  {  
                    "system": "http://hl7.org/fhir/sid/icd-10",  
                    "code": "J44.0",  
                    "display": "COPD with acute lower respiratory infection"  
                  },  
                  {  
                    "system": "http://hl7.org/fhir/sid/icd-10",  
                    "code": "J96.01",  
                    "display": "Acute respiratory failure with hypoxia"  
                  }  
                ]  
              }  
            }  
          },  
          {  
            "fullUrl": "http://example.org/fhir/QuestionnaireResponse/example-prepopulated",  
            "resource": {  
              "resourceType": "QuestionnaireResponse",  
              "id": "example-prepopulated",  
              "questionnaire": "http://example.org/fhir/Questionnaire/home-oxygen-therapy|2.0",  
              "status": "in-progress",  
              "subject": {  
                "reference": "Patient/example-patient"  
              },  
              "basedOn": [{  
                "reference": "ServiceRequest/example-service-request"  
              }],  
              "item": [  
                {  
                  "linkId": "1",  
                  "text": "Patient diagnosis",  
                  "answer": [{  
                    "valueCoding": {  
                      "system": "http://hl7.org/fhir/sid/icd-10",  
                      "code": "J44.0",  
                      "display": "COPD with acute lower respiratory infection"  
                    }  
                  }]  
                }  
              ]  
            }  
          }  
        ]  
      }  
    },  
    {  
      "name": "Outcome",  
      "resource": {  
        "resourceType": "OperationOutcome",  
        "issue": [{  
          "severity": "information",  
          "code": "informational",  
          "details": {  
            "text": "Successfully retrieved questionnaire package"  
          }  
        }]  
      }  
    }  
  ]  
}

Flux de travail des opérations

Comment HealthLake traite-t-on votre demande

Lorsque vous appelez$questionnaire-package, HealthLake exécute les étapes suivantes :

Résultat : un package complet et autonome prêt pour le rendu.

Réponses d'erreur

400 Requête erronée

Renvoyé en cas d'échec de la validation de la demande.

{  
  "resourceType": "OperationOutcome",  
  "issue": [{  
    "severity": "error",  
    "code": "required",  
    "details": {  
      "text": "At least one of 'questionnaire' or 'order' must be provided along with 'coverage'"  
    }  
  }]  
}

424 Dépendance défaillante

Renvoyé lorsqu'une ressource dépendante ne peut pas être récupérée.

{  
  "resourceType": "OperationOutcome",  
  "issue": [{  
    "severity": "warning",  
    "code": "not-found",  
    "details": {  
      "text": "Referenced Library 'http://example.org/fhir/Library/missing-library' could not be retrieved"  
    }  
  }]  
}

401 Accès non autorisé

Renvoyé lorsque les informations d'authentification sont manquantes ou non valides.

403 Forbidden

Renvoyé lorsque l'utilisateur authentifié n'est pas autorisé à accéder aux ressources demandées.

406 Non acceptable

Renvoyé lorsque le type de contenu demandé ne peut pas être fourni.

409 – Conflit

Renvoyé en cas de conflit de version ou de simultanéité.

410 Disparus

Renvoyé lorsque la ressource demandée a été définitivement supprimée.

429 Trop de demandes

Renvoyé lorsque les limites de débit sont dépassées.

500 Erreur de serveur interne

Renvoyé lorsqu'une erreur de serveur inattendue se produit.

501 Non implémenté

Renvoyé lorsque l'opération demandée n'est pas encore implémentée.

Règles de validation

Validation des entrées

QuestionnaireResponse validation

Déduplication des ressources

Spécifications de performance

Autorisations requises

Pour utiliser l'$questionnaire-packageopération, assurez-vous que votre rôle IAM possède les éléments suivants :

SMART sur les oscilloscopes FHIR

Étendue minimale requise :

Remarques de mise en œuvre importantes

Stratégie de récupération des ressources

Priorité d'identification du questionnaire :

Résolution des dépendances

Bibliothèques CQL :

ValueSets:

QuestionnaireResponse pré-population

L'opération peut renvoyer un fichier QuestionnaireResponse avec des données préremplies lorsque :

Critères de recherche pour QuestionnaireResponse :

Filtrage des ressources modifié

Lorsque le changedSince paramètre est fourni :

Forfaits groupés multiples

L'opération peut renvoyer plusieurs Package Bundles lorsque :

Chaque Package Bundle est autonome avec toutes les dépendances nécessaires.

Cas d’utilisation courants

Cas d'utilisation 1 : documentation relative à l'autorisation préalable

Scénario : Un fournisseur doit recueillir de la documentation pour une autorisation préalable d'oxygénothérapie à domicile.

{  
  "resourceType": "Parameters",  
  "parameter": [  
    {  
      "name": "coverage",  
      "resource": { /* Patient's insurance coverage */ }  
    },  
    {  
      "name": "order",  
      "resource": {  
        "resourceType": "ServiceRequest",  
        "code": {  
          "coding": [{  
            "system": "http://www.ama-assn.org/go/cpt",  
            "code": "94660"  
          }]  
        }  
      }  
    }  
  ]  
}

Résultat : renvoie un colis contenant le questionnaire d'oxygénothérapie, prérempli avec les données vitales du patient et les codes de diagnostic du dossier médical électronique.

Cas d'utilisation 2 : récupérer une version spécifique du questionnaire

Scénario : un fournisseur a besoin d'une version spécifique d'un questionnaire pour se conformer.

{  
  "resourceType": "Parameters",  
  "parameter": [  
    {  
      "name": "coverage",  
      "resource": { /* Coverage resource */ }  
    },  
    {  
      "name": "questionnaire",  
      "valueCanonical": "http://example.org/fhir/Questionnaire/dme-request|3.1.0"  
    }  
  ]  
}

Résultat : renvoie exactement la version 3.1.0 du questionnaire de demande DME avec toutes les dépendances.

Cas d'utilisation 3 : Vérifier les mises à jour

Scénario : un fournisseur souhaite vérifier si des ressources du questionnaire ont été mises à jour depuis la dernière extraction.

{  
  "resourceType": "Parameters",  
  "parameter": [  
    {  
      "name": "coverage",  
      "resource": { /* Coverage resource */ }  
    },  
    {  
      "name": "questionnaire",  
      "valueCanonical": "http://example.org/fhir/Questionnaire/medication-request"  
    },  
    {  
      "name": "changedSince",  
      "valueDateTime": "2024-03-01T00:00:00Z"  
    }  
  ]  
}

Résultat : renvoie uniquement les ressources qui ont été modifiées après le 1er mars 2024, ou un package vide si rien n'a changé.

Cas d'utilisation 4 : commandes multiples

Scénario : un fournisseur soumet plusieurs demandes de service qui peuvent nécessiter différents questionnaires.

{  
  "resourceType": "Parameters",  
  "parameter": [  
    {  
      "name": "coverage",  
      "resource": { /* Coverage resource */ }  
    },  
    {  
      "name": "order",  
      "resource": { /* ServiceRequest for imaging */ }  
    },  
    {  
      "name": "order",  
      "resource": { /* ServiceRequest for DME */ }  
    }  
  ]  
}

Résultat : renvoie plusieurs Packages groupés, un pour chaque questionnaire applicable.

Intégration avec d'autres Da Vinci IGs

Découverte des exigences de couverture (CRD)

Intégration du flux de travail :

Support d'autorisation préalable (PAS)

Intégration du flux de travail :

Échange de données cliniques (CDex)

Intégration du flux de travail :

Guide de dépannage

Problème : aucun questionnaire n'a été renvoyé

Causes possibles :

Solutions :

Problème : dépendances manquantes dans le package

Causes possibles :

Solutions :

Problème : Package vide avec ChangedSince

Causes possibles :

Solutions :

Problème : QuestionnaireResponse Non prérempli

Causes possibles :

Solutions :

Bonnes pratiques

1. Utiliser Canonical URLs avec les versions

Spécifiez toujours les numéros de version lorsque vous demandez des questionnaires spécifiques :

{  
  "name": "questionnaire",  
  "valueCanonical": "http://example.org/fhir/Questionnaire/dme|2.1.0"  
}

Pourquoi : Garantit la cohérence et empêche les changements inattendus lors de la mise à jour des questionnaires.

2. Tirez parti de ChangedSince pour améliorer les performances

Pour les questionnaires fréquemment consultés, utilisez changedSince pour minimiser le transfert de données :

{  
  "name": "changedSince",  
  "valueDateTime": "2024-03-10T15:30:00Z"  
}

Pourquoi : réduit la latence et l'utilisation de la bande passante en ne récupérant que les ressources mises à jour.

3. Incluez des informations complètes sur la couverture

Fournissez des informations complètes sur la couverture afin de garantir une sélection correcte du questionnaire :

{  
  "name": "coverage",  
  "resource": {  
    "resourceType": "Coverage",  
    "beneficiary": { "reference": "Patient/123" },  
    "payor": [{ "reference": "Organization/payer-abc" }],  
    "class": [{ /* Group/plan information */ }]  
  }  
}

Pourquoi : aide à HealthLake identifier les questionnaires et les exigences spécifiques au payeur.

Opérations liées