Uw FHIR-gegevens exporteren
Met behulp van de bulkbewerking $export in de FHIR-service kunt u gegevens exporteren zoals beschreven in de SPECIFICATIE HL7 FHIR Bulk Data Access.
Voordat u probeert te gebruiken $export, moet u ervoor zorgen dat uw FHIR-service is geconfigureerd om verbinding te maken met een Azure Data Lake Storage Gen2-account. Als u exportinstellingen wilt configureren en een Data Lake Storage Gen2-account wilt maken, raadpleegt u Instellingen configureren voor export.
Het $export eindpunt aanroepen
Nadat u de FHIR-service hebt ingesteld om verbinding te maken met een Data Lake Storage Gen2-account, kunt u het $export eindpunt aanroepen en exporteert de FHIR-service gegevens naar een Azure Blob Storage-container in het opslagaccount. Met de volgende voorbeeldaanvraag worden alle resources geëxporteerd naar een container, die wordt opgegeven met de naam ({{containerName}}). Houd er rekening mee dat u de container vooraf moet maken in het Data Lake Storage Gen2-account als u de {{containerName}} container in de aanvraag wilt opgeven.
GET {{fhirurl}}/$export?_container={{containerName}}
Als u geen containernaam opgeeft in de aanvraag (bijvoorbeeld door aan te roepen GET {{fhirurl}}/$export), wordt er een nieuwe container met een automatisch gegenereerde naam gemaakt voor de geëxporteerde gegevens.
Zie de documentatie over de HL7 FHIR-aanvraagstroom voor algemene informatie over de FHIR-API-specificatie$export.
De FHIR-service ondersteunt $export op de volgende niveaus:
- Systeem:
GET {{fhirurl}}/$export - Patiënt:
GET {{fhirurl}}/Patient/$export - Groep patiënten*:
GET {{fhirurl}}/Group/[ID]/$export
*De FHIR-service exporteert alle resources waarnaar wordt verwezen, maar exporteert niet de kenmerken van de groepsresource zelf.
Gegevens worden geëxporteerd in meerdere bestanden. Elk bestand bevat resources van slechts één type. Het aantal resources in een afzonderlijk bestand is beperkt. Het maximum aantal resources is gebaseerd op systeemprestaties. Het is momenteel ingesteld op 5000, maar kan worden gewijzigd. Het resultaat is dat u mogelijk meerdere bestanden voor een resourcetype krijgt. De bestandsnamen volgen de indeling <resourceName>-<number>-<number>.ndjson. De volgorde van de bestanden komt niet gegarandeerd overeen met de volgorde van de resources in de database.
Notitie
Patient/$export en Group/[ID]/$export kan dubbele resources exporteren als een resource zich in meerdere groepen of in een compartiment van meer dan één resource bevindt.
Naast het controleren van de aanwezigheid van geëxporteerde bestanden in uw opslagaccount, kunt u uw $export bewerkingsstatus controleren via de URL in de Content-Location header die wordt geretourneerd in het antwoord van de FHIR-service. Zie de documentatie over de aanvraag voor bulkgegevensstatus van HL7 voor meer informatie.
Uw FHIR-gegevens exporteren naar Data Lake Storage Gen2
Momenteel biedt de FHIR-service ondersteuning $export voor Data Lake Storage Gen2-accounts, met de volgende beperkingen:
- Data Lake Storage Gen2 biedt hiërarchische naamruimten, maar er is geen manier om bewerkingen te richten
$exportop een specifieke submap binnen een container. De FHIR-service kan alleen de doelcontainer voor de export opgeven, waarbij een nieuwe map voor elke$exportbewerking wordt gemaakt. - Nadat een
$exportbewerking is voltooid en alle gegevens in een map zijn geschreven, exporteert de FHIR-service niets opnieuw naar die map, omdat de volgende exports naar dezelfde container zich in een zojuist gemaakte map bevinden.
Als u gegevens wilt exporteren naar een opslagaccount achter een firewall, raadpleegt u Instellingen configureren voor export.
Instellingen en parameters
Headers
Er moeten twee vereiste headerparameters worden ingesteld voor $export taken. De waarden worden ingesteld volgens de huidige HL7 -$export specificatie.
- Accepteren:
application/fhir+json - Liever:
respond-async
Queryparameters
De FHIR-service ondersteunt de volgende queryparameters voor het filteren van geëxporteerde gegevens. Al deze parameters zijn optioneel.
| Queryparameter | Gedefinieerd door de FHIR-specificatie? | Beschrijving |
|---|---|---|
_outputFormat |
Ja | Ondersteunt momenteel drie waarden die moeten worden uitgelijnd op de FHIR-specificatie: application/fhir+ndjson, application/ndjsonof alleen ndjson. Alle exporttaken retourneren .ndjson bestanden en de doorgegeven waarde heeft geen effect op het gedrag van code. |
_since |
Ja | Hiermee kunt u alleen resources exporteren die zijn gewijzigd sinds de opgegeven tijd. |
_type |
Ja | Hiermee kunt u opgeven welke typen resources worden opgenomen. Retourneert bijvoorbeeld _type=Patient alleen patiëntenbronnen. |
_typeFilter |
Ja | Als u fijnmazige filters wilt aanvragen, kunt u samen met de _type parameter gebruiken_typeFilter. De waarde van de _typeFilter parameter is een door komma's gescheiden lijst met FHIR-query's die de resultaten verder beperken. |
_container |
Nee | Hiermee geeft u de naam van de container in het geconfigureerde opslagaccount waar de gegevens moeten worden geëxporteerd. Als er een container is opgegeven, worden de gegevens geëxporteerd naar een map in die container. Als de container niet is opgegeven, worden de gegevens geëxporteerd naar een nieuwe container met een automatisch gegenereerde naam. |
_till |
Nee | Hiermee kunt u resources exporteren die zijn gewijzigd tot de opgegeven tijd. Deze parameter is alleen van toepassing met export op systeemniveau. In dit geval, als historische versies niet zijn uitgeschakeld of opgeschoond, garandeert export echte momentopnameweergave, of, met andere woorden, tijdreizen. |
includeAssociatedData |
Nee | Hiermee kunt u geschiedenis en voorlopig verwijderde resources exporteren. Dit filter werkt niet met de queryparameter '_typeFilter'. Voeg waarde toe als '_history' om geschiedenis/niet-meest recente versiebronnen te exporteren. Voeg waarde toe als '_deleted' om voorlopig verwijderde resources te exporteren. |
Notitie
Alleen opslagaccounts in hetzelfde abonnement als de FHIR-service mogen worden geregistreerd als de bestemming voor $export bewerkingen.
Problemen oplossen
De volgende informatie kan u helpen bij het oplossen van problemen met het exporteren van FHIR-gegevens.
Taken zijn vastgelopen in een slechte status
In sommige situaties kan een taak in een slechte status vastlopen terwijl de FHIR-service probeert gegevens te exporteren. Dit kan vooral gebeuren als de machtigingen van het Data Lake Storage Gen2-account niet juist zijn ingesteld.
Een manier om de status van uw $export bewerking te controleren, is door naar de opslagbrowser van uw opslagaccount te gaan en te zien of er .ndjson bestanden aanwezig zijn in de exportcontainer. Als de bestanden niet aanwezig zijn en er geen andere $export taken worden uitgevoerd, is het mogelijk dat de huidige taak een slechte status heeft. In dit geval kunt u de $export taak annuleren door de FHIR-service-API aan te roepen met een DELETE aanvraag. Later kunt u de $export taak opnieuw weergeven en het opnieuw proberen.
Zie de documentatie over aanvraag voor bulksgewijs verwijderen van HL7 voor meer informatie over het annuleren van een $export bewerking.
Notitie
In de FHIR-service is de standaardtijd voor een $export bewerking inactief 10 minuten voordat de service de bewerking stopt en naar een nieuwe taak gaat.
Volgende stappen
In dit artikel hebt u geleerd hoe u FHIR-resources exporteert met behulp van de $export bewerking. Zie voor meer informatie over het instellen en gebruiken van aanvullende opties voor exporteren:
FHIR® is een geregistreerd handelsmerk van HL7 en wordt gebruikt met de machtiging HL7.