5.4.1 Exigences des éléments de DocumentRetrieveRequest
Informations API
oknjknjknj
Le DocumentRetrieveRequest est un message GET qui utilisera les informations de point de terminaison API de service web suivantes pour récupérer un document via Surescripts.
Opération | Description du point de terminaison API | Description |
|---|---|---|
Récupération de document | GET [base]/Binary?documentID=&repository Id>&homeCommunityId= | Retourne le document sous forme binaire. |
Remarque: En tant que répondeur, vous serez responsable de définir les informations de point de terminaison et l’URL afin que d’autres puissent récupérer des documents depuis votre système. Ces informations sont retournées dans la DocumentSearchResponse de votre système.
Types de contenu et encodages
Selon la section 3.1.0.1.9 de la spécification FHIR® Content Types and encodings,
« Le type MIME formel pour les ressources FHIR® est application/fhir+json ou application/fhir+xml. Le type MIME correct DOIT être utilisé par les clients et les serveurs. » Plus loin dans cette même section, « L’encodage UTF-8 DOIT être utilisé pour le type MIME application/fhir. Cela PEUT être spécifié comme paramètre de type MIME pour le type MIME application/fhir, mais n’est pas requis » parce que FHIR® utilise UTF-8 pour tous les corps de requête et de réponse. Puisque la spécification HTTP (section 3.7.1) définit un encodage de caractères par défaut de ISO-8859-1, les requêtes et réponses DOIVENT explicitement définir l’encodage de caractères sur UTF-8 à l’aide du paramètre charset du type MIME dans l’en-tête Content-Type. Les requêtes PEUVENT également spécifier ce paramètre charset dans l’en-tête Accept et/ou utiliser l’en-tête Accept-Charset.
En raison de ces exigences, les requêtes/réponses devront inclure un Content-Type dans l’en-tête HTTP. Ci-dessous se trouve un exemple :
- Content-Type: application/fhir+json; charset=utf-8
Remarque: charset=utf-8 n’est pas requis par Surescripts, mais est pris en charge s’il est envoyé.
Contenu de l’en-tête Accept c. paramètre de requête the_format
Les spécifications FHIR R4 indiquent que les documents doivent être retournés selon la façon dont ils ont été demandés, soit via des Bundles avec des contenus encodés en Base64 dans un bundle, soit comme contenu diffusé en continu. Le champ d’en-tête de requête Accept dans une requête de récupération de document peut être utilisé pour spécifier les types de médias acceptables pour chaque réponse.
- Si « application/fhir+xml » ou « application/fhir+json » est spécifié dans le champ Accept de l’en-tête d’une requête, le document sera retourné via des bundles FHIR.
- Les documents (ex. : CCDAs, PLQs, fichiers binaires) retournés aux demandeurs de documents via des bundles dans les réponses FHIR doivent être encodés en Base64
- Si un autre type est utilisé, ex. : « application/pdf » (ou d’autres types binaires), le document demandé sera diffusé directement au demandeur
Comme alternative, le produit FHIR® RLE prend également en charge l’utilisation du paramètre « _format », tel que décrit dans la section 3.1.0.1.11 de la spécification FHIR®, permettant aux demandeurs de documents de spécifier leur préférence pour recevoir les documents demandés dans un format autre que celui inclus dans l’en-tête HTTP (dans les situations où une application demandeuse peut contrôler le contenu de ses requêtes, mais pas l’en-tête HTTP en raison de l’utilisation d’un logiciel de communication tiers ou d’autres limitations).
Exemple de requête avec le paramètre « _format » :
https://rle.surescripts.net/fhir/R4/Binary?documentId=CCDA123&repositoryId=urn:
oid:44.5555.66=urn:oid:77.8888.99&
_format=application/fhir+json
Veuillez noter que l’utilisation du paramètre « _format » dans la requête remplace tous les types de médias de requête spécifiés dans le champ Accept de l’en-tête de message de la requête.
5.4.10 Exemple de DocumentRetrieveRequest
L’exemple suivant d’URL et d’en-tête HTTP retournerait une réponse groupée au format JSON.
https://rle.surescripts.net/fhir/Binary?documentId=2.16.840.1.113883.3.2054.2.1.128118651&repositoryId=2.16.840.1.113883.3.2054.2.1&homeCommunityId=2.16.840.1.113883.3.2054.2.1
5.4.11 Exigences des éléments de DocumentRetrieveResponse
Les documents seront retournés selon la façon dont ils ont été demandés (voir DocumentRetrieveRequest), soit via des Bundles avec des contenus encodés en Base64 dans un bundle, soit comme contenu diffusé directement au demandeur dans le format (sans encodage) spécifié par le contentType du document demandé.
Le tableau ci-dessous présente les exigences pour la ressource Bundle utilisée dans le message DocumentRetrieveResponse.
Remarque : Ce guide inclut des éléments de données uniquement lorsque Surescripts a des exigences spécifiques ou fournit des explications supplémentaires sur l’utilisation du champ. Reportez-vous à la ressource Bundle FHIR pour obtenir une liste complète des champs.
5.4.12 Exemple de message DocumentRetrieveResponse
{
"resourceType": "Bundle",
"id": "f98511eb-a5a2-4ecf-8ee9-c6d35bb3bb99",
"type": "searchset",
"entry": [
{
"resource": {
"resourceType": "Binary",
"id": "16dade3d-e45b-4be4-889b-c0ca65bc9367",
"contentType": "image/jpeg",
"data": "iVBORw0KGgoAAAANSUhEUgAAAmQAAAC0CAYAAAA6sDC6…(Base64 content truncated for readability)…SUVORK5CYII="
}
}
]
}