FHIR R4-Suchparameter für HealthLake - AWS HealthLake

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

FHIR R4-Suchparameter für HealthLake

Verwenden Sie die searchFHIR-Interaktion, um anhand einiger Filterkriterien eine Reihe von FHIR-Ressourcen in einem HealthLake Datenspeicher zu durchsuchen. Die search Interaktion kann entweder mit einer GET Oder-Anfrage durchgeführt werden. POST Für Suchanfragen, die personenbezogene Daten (PII) oder geschützte Gesundheitsinformationen (PHI) beinhalten, wird empfohlen, POST Anfragen zu verwenden, da PII und PHI als Teil des Anfragetextes hinzugefügt und bei der Übertragung verschlüsselt werden.

Anmerkung

Die in diesem Kapitel beschriebene search FHIR-Interaktion entspricht dem HL7 FHIR R4-Standard für den Austausch von Gesundheitsdaten. Da es sich um eine Repräsentation eines HL7 FHIR-Dienstes handelt, wird er nicht über und angeboten. AWS CLI AWS SDKs Weitere Informationen finden Sie searchin der FHIR RESTful R4-API-Dokumentation.

Sie können HealthLake Datenspeicher auch mit SQL mithilfe von Amazon Athena abfragen. Weitere Informationen finden Sie unter Integrieren.

HealthLake unterstützt die folgende Teilmenge der FHIR R4-Suchparameter. Weitere Informationen finden Sie unter FHIR R4-Suchparameter für HealthLake.

Unterstützte Suchparametertypen

Die folgende Tabelle zeigt die unterstützten Suchparametertypen in HealthLake.

Unterstützte Suchparametertypen
Suchparameter Beschreibung
_id Ressourcen-ID (keine vollständige URL)
_Letzte Aktualisierung Datum der letzten Aktualisierung. Die Genauigkeit der Grenzen liegt im Ermessen des Servers.
_tag Suche nach einem Ressourcen-Tag.
_Profil Sucht nach allen Ressourcen, die mit einem Profil gekennzeichnet sind.
_Sicherheit Sucht nach Sicherheitslabels, die auf diese Ressource angewendet wurden.
_Quelle Sucht danach, woher die Ressource stammt.
_text Suchen Sie nach der Erzählung der Ressource.
createdAt Suchen Sie nach der benutzerdefinierten Erweiterung CreatedAt.
Anmerkung

Die folgenden Suchparameter werden nur für Datenspeicher unterstützt, die nach dem 09. Dezember 2023 erstellt wurden: _security, _source, _text, createdAt.

Die folgende Tabelle zeigt Beispiele dafür, wie Abfragezeichenfolgen auf der Grundlage bestimmter Datentypen für einen bestimmten Ressourcentyp geändert werden können. Aus Gründen der Übersichtlichkeit wurden Sonderzeichen in der Beispielspalte nicht codiert. Um eine erfolgreiche Abfrage durchzuführen, stellen Sie sicher, dass die Abfragezeichenfolge richtig codiert wurde.

Beispiele für Suchparameter
Typen von Suchparametern Details Beispiele

Anzahl

Sucht in einer angegebenen Ressource nach einem numerischen Wert. Signifikante Zahlen werden beobachtet. Die Anzahl der signifikanten Ziffern ist spezifisch für den Suchparameterwert, ausgenommen führende Nullen. Vergleichspräfixe sind zulässig.

[parameter]=100

[parameter]=1e2

[parameter]=lt100

Datum/ DateTime

Sucht nach einem bestimmten Datum oder einer bestimmten Uhrzeit. Das erwartete Format istyyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm], kann aber variieren.

Akzeptiert die folgenden Datentypen: datedateTime,instant,Period, undTiming. Weitere Informationen zur Verwendung dieser Datentypen bei Suchen finden Sie unter Datum in der FHIR RESTful R4-API-Dokumentation.

Vergleichspräfixe sind zulässig.

[parameter]=eq2013-01-14

[parameter]=gt2013-01-14T10:00

[parameter]=ne2013-01-14

String

Sucht nach einer Zeichenfolge unter Berücksichtigung von Groß- und Kleinschreibung.

Unterstützt beide HumanName Address Typen. Weitere Informationen finden Sie in den HumanName Datentypeinträgen und den AddressDatentypeinträgen in der FHIR R4-Dokumentation.

Die erweiterte Suche wird mithilfe :text von Modifikatoren unterstützt.

[base]/Patient?given=eve

[base]/Patient?given:contains=eve

Token

Sucht nach einer close-to-exact Übereinstimmung mit einer Zeichenfolge und wird häufig mit einem Paar medizinischer Codewerte verglichen.

Die Berücksichtigung von Groß- und Kleinschreibung hängt vom Codesystem ab, das bei der Erstellung einer Abfrage verwendet wird. Subsumtionsbasierte Abfragen können dazu beitragen, Probleme im Zusammenhang mit der Berücksichtigung von Groß- und Kleinschreibung zu reduzieren. Aus Gründen der Übersichtlichkeit wurde das | nicht codiert.

[parameter]=[system]|[code]: [system] Bezieht sich hier auf ein Kodierungssystem und [code] bezieht sich auf den Codewert, der in diesem spezifischen System gefunden wurde.

[parameter]=[code]: Hier entspricht Ihre Eingabe entweder einem Code oder einem System.

[parameter]=|[code]: Hier entspricht Ihre Eingabe einem Code, und die Systemeigenschaft hat keinen Bezeichner.

Zusammengesetzt

Sucht mithilfe der Modifikatoren $ und der , Operation nach mehreren Parametern innerhalb eines einzigen Ressourcentyps.

Vergleichspräfixe sind zulässig.

/Patient?language=FR,NL&language=EN

Observation?component-code-value-quantity=http://loinc.org|8480-6$lt60

[base]/Group?characteristic-value=gender$mixed

Quantity (Menge)

Sucht nach einer Zahl, einem System und einem Code als Werte. Eine Zahl ist erforderlich, System und Code sind jedoch optional. Basiert auf dem Datentyp Menge. Weitere Informationen finden Sie unter Menge in der FHIR R4-Dokumentation.

Verwendet die folgende angenommene Syntax [parameter]=[prefix][number]|[system]|[code]

[base]/Observation?value-quantity=5.4|http://unitsofmeasure.org|mg

[base]/Observation?value-quantity=5.4|http://unitsofmeasure.org|mg

[base]/Observation?value-quantity=5.4|http://unitsofmeasure.org|mg

[base]/Observation?value-quantity=le5.4|http://unitsofmeasure.org|mg

Referenz

Sucht nach Verweisen auf andere Ressourcen.

[base]/Observation?subject=Patient/23

test

URI

Sucht nach einer Zeichenfolge, die eine bestimmte Ressource eindeutig identifiziert.

[base]/ValueSet?url=http://acme.org/fhir/ValueSet/123

Spezial

Suchanfragen basieren auf integrierten medizinischen NLP-Erweiterungen.

Erweiterte Suchparameter werden unterstützt von HealthLake

HealthLake unterstützt die folgenden erweiterten Suchparameter.

Name Beschreibung Beispiel Funktion
_include Wird verwendet, um anzufordern, dass zusätzliche Ressourcen in einer Suchanfrage zurückgegeben werden. Es gibt Ressourcen zurück, auf die von der Zielressourceninstanz verwiesen wird. Encounter?_include=Encounter:subject
_revinclude Wird verwendet, um anzufordern, dass zusätzliche Ressourcen in einer Suchanfrage zurückgegeben werden. Es gibt Ressourcen zurück, die auf die primäre Ressourceninstanz verweisen. Patient?_id=patient-identifier&_revinclude=Encounter:patient
_summary Die Zusammenfassung kann verwendet werden, um eine Teilmenge der Ressource anzufordern. Patient?_summary=text Die folgenden Übersichtsparameter werden unterstützt:_summary=true,, _summary=false_summary=text,_summary=data.
_elements Fordert an, dass ein bestimmter Satz von Elementen als Teil einer Ressource in den Suchergebnissen zurückgegeben wird. Patient?_elements=identifier,active,link
_total Gibt die Anzahl der Ressourcen zurück, die den Suchparametern entsprechen. Patient?_total=accurate Support_total=accurate,_total=none.
_sort Geben Sie die Sortierreihenfolge der zurückgegebenen Suchergebnisse mithilfe einer durch Kommas getrennten Liste an. Das - Präfix kann für jede Sortierregel in der kommagetrennten Liste verwendet werden, um die absteigende Reihenfolge anzugeben. Observation?_sort=status,-date Support Sortierung nach Feldern mit TypenNumber, String, Quantity, Token, URI, Reference. Sortieren nach Date wird nur für Datenspeicher unterstützt, die nach dem 09. Dezember 2023 erstellt wurden. Support bis zu 5 Sortierregeln.
_count Steuern Sie, wie viele Ressourcen pro Seite des Suchpakets zurückgegeben werden. Patient?_count=100 Die maximale Seitengröße beträgt 100.
chaining Suchen Sie nach Elementen von Ressourcen, auf die verwiesen wird. Der . leitet die verkettete Suche auf das Element in der referenzierten Ressource weiter. DiagnosticReport?subject:Patient.name=peter
reverse chaining (_has) Sucht auf der Grundlage der Ressourcenelemente, die auf sie verweisen, nach einer Ressource. Patient?_has:Observation:patient:code=1234-5

_include

Durch die Verwendung _include in einer Suchabfrage können auch zusätzliche angegebene FHIR-Ressourcen zurückgegeben werden. Wird verwendet_include, um Ressourcen einzubeziehen, die weiterverknüpft sind.

Beispiel — Wird verwendet_include, um die Patienten oder die Gruppe von Patienten zu finden, bei denen Husten diagnostiziert wurde

Sie würden nach dem Condition Ressourcentyp suchen, indem Sie den Diagnosecode für Husten _include angeben und dann angeben, dass auch die subject Diagnose zurückgegeben werden soll. Beim Condition Ressourcentyp subject handelt es sich entweder um den Ressourcentyp für den Patienten oder den Ressourcentyp für die Gruppe.

Aus Gründen der Übersichtlichkeit wurden Sonderzeichen im Beispiel nicht codiert. Um eine erfolgreiche Abfrage durchzuführen, stellen Sie sicher, dass die Abfragezeichenfolge richtig codiert wurde.

GET https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/ Condition?code=49727002&_include=Condition:subject

_revinclude

Durch die Verwendung _revinclude in einer Suchabfrage können auch zusätzliche angegebene FHIR-Ressourcen zurückgegeben werden. Wird verwendet_revinclude, um Ressourcen einzubeziehen, die rückwärts verknüpft sind.

Beispiel — Wird verwendet, _revinclude um verwandte Ressourcentypen für Begegnung und Beobachtung einzubeziehen, die mit einem bestimmten Patienten verknüpft sind

Um diese Suche durchzuführen, würden Sie zunächst die Person definieren, Patient indem Sie ihre Kennung im _id Suchparameter angeben. Anschließend würden Sie mithilfe der Struktur Encounter:patient und Observation:patient zusätzliche FHIR-Ressourcen angeben.

Aus Gründen der Übersichtlichkeit wurden die Sonderzeichen im Beispiel nicht codiert. Um eine erfolgreiche Abfrage durchzuführen, stellen Sie sicher, dass die Abfragezeichenfolge richtig codiert wurde.

GET https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/ Patient?_id=patient-identifier&_revinclude=Encounter:patient&_revinclude=Observation:patient

_summary

Die Verwendung _summary in einer Suchabfrage ermöglicht es dem Benutzer, eine Teilmenge der FHIR-Ressource anzufordern. Es kann einen der folgenden Werte enthalten:. true, text, data, false Alle anderen Werte werden als ungültig behandelt. Die zurückgegebenen Ressourcen werden 'SUBSETTED' in meta.tag mit gekennzeichnet, um darauf hinzuweisen, dass die Ressourcen unvollständig sind.

  • true: Gibt alle unterstützten Elemente zurück, die in der Basisdefinition der Ressource (n) als „Zusammenfassung“ gekennzeichnet sind.

  • text: Gibt nur die Elemente 'text', 'id', 'meta' und nur die obligatorischen Elemente der obersten Ebene zurück.

  • data: Gibt alle Teile außer dem Element „Text“ zurück.

  • false: Gibt alle Teile der Ressource (n) zurück

Kann in einer einzelnen Suchanfrage _summary=text nicht mit _include oder mit _revinclude Suchparametern kombiniert werden.

Beispiel — Ruft das „Text“ -Element der Patientenressourcen in einem Datenspeicher ab.
GET https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/Patient?_summary=text

_elements

Durch die Verwendung _elements in einer Suchabfrage können bestimmte FHIR-Ressourcenelemente angefordert werden. Die zurückgegebenen Ressourcen werden 'SUBSETTED' in meta.tag mit gekennzeichnet, um darauf hinzuweisen, dass die Ressourcen unvollständig sind.

Der _elements Parameter besteht aus einer durch Kommas getrennten Liste von Basiselementnamen, z. B. Elementen, die auf der Stammebene der Ressource definiert sind. Es dürfen nur die aufgelisteten Elemente zurückgegeben werden. Wenn _elements Parameterwerte ungültige Elemente enthalten, ignoriert der Server sie und gibt obligatorische Elemente und gültige Elemente zurück.

_elementsgilt nicht für eingeschlossene Ressourcen (zurückgegebene Ressourcen, deren Suchmodus istinclude).

Kann in einer einzelnen Suchanfrage _elements nicht mit _summary Suchparametern kombiniert werden.

Beispiel — Rufen Sie die Elemente „Identifier“, „Active“ und „Link“ von Patientenressourcen in Ihrem HealthLake Datenspeicher ab.
GET https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/Patient?_elements=identifier,active,link

_total

_totalBei Verwendung in einer Suchabfrage wird die Anzahl der Ressourcen zurückgegeben, die den angeforderten Suchparametern entsprechen. HealthLake gibt die Gesamtzahl der übereinstimmenden Ressourcen (zurückgegebene Ressourcen, deren Suchmodus istmatch) in Bundle.total der Suchantwort zurück.

_totalunterstützt die accurate none Parameterwerte. _total=estimatewird nicht unterstützt. Alle anderen Werte werden als ungültig behandelt. _totalgilt nicht für die eingeschlossenen Ressourcen (zurückgegebene Ressourcen, deren Suchmodus istinclude).

Beispiel — Ruft die Gesamtzahl der Patientenressourcen in einem Datenspeicher ab:
GET https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/Patient?_total=accurate

_sort

Durch die Verwendung _sort in der Suchabfrage werden die Ergebnisse in einer bestimmten Reihenfolge angeordnet. Die Ergebnisse werden auf der Grundlage der durch Kommas getrennten Liste von Sortierregeln in Prioritätsreihenfolge sortiert. Die Sortierregeln sollten gültige Suchparameter sein. Alle anderen Werte werden als ungültig behandelt.

In einer einzigen Suchanfrage können Sie bis zu 5 Sortier-Suchparameter verwenden. Sie können optional ein - Präfix verwenden, um die absteigende Reihenfolge anzugeben. Der Server sortiert standardmäßig in aufsteigender Reihenfolge.

Die unterstützten Parametertypen für die Sortiersuche sind:Number, String, Date, Quantity, Token, URI, Reference. Wenn sich ein Suchparameter auf ein verschachteltes Element bezieht, wird dieser Suchparameter für die Sortierung nicht unterstützt. Beispielsweise bezieht sich die Suche nach „Name“ des Ressourcentyps Patient auf Patienten.Ein Name-Element mit HumanName Datentyp wird als verschachtelt betrachtet. Daher wird die Sortierung von Patientenressourcen nach „Name“ nicht unterstützt.

Beispiel — Rufen Sie Patientenressourcen in einem Datenspeicher ab und sortieren Sie sie in aufsteigender Reihenfolge nach dem Geburtsdatum:
GET https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/Patient?_sort=birthdate

_count

Der Parameter _count ist als Anweisung an den Server definiert, wie viele Ressourcen auf einer einzigen Seite zurückgegeben werden sollen.

Die maximale Seitengröße ist 100. Alle Werte über 100 sind ungültig. _count=0wird nicht unterstützt.

Beispiel — Suchen Sie nach der Patientenressource und legen Sie die Größe der Suchseite auf 25 fest:
GET https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/Patient?_count=25

Chaining and Reverse Chaining(_has)

Verkettung und umgekehrte Verkettung in FHIR bieten eine effizientere und kompaktere Möglichkeit, miteinander verbundene Daten zu erhalten, wodurch die Notwendigkeit mehrerer separater Abfragen reduziert wird und der Datenabruf für Entwickler und Benutzer komfortabler wird.

Wenn eine Rekursionsebene mehr als 100 Ergebnisse zurückgibt, HealthLake wird 4xx zurückgegeben, um den Datenspeicher vor Überlastung und mehrfachen Paginierungen zu schützen.

Beispiel — Verkettung — Ruft alle Daten ab DiagnosticReport , die sich auf einen Patienten beziehen, wobei der Patientenname Peter ist.
GET https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/DiagnosticReport?subject:Patient.name=peter
Beispiel — Umgekehrte Verkettung — Ruft Patientenressourcen ab, wobei die Patientenressource durch mindestens eine Beobachtung referenziert wird, wobei die Beobachtung den Code 1234 hat und wobei sich die Beobachtung auf die Patientenressource im Patientensuchparameter bezieht.

GET https://healthlake.region.amazonaws.com/datastore/datastoreId/r4/Patient?_has:Observation:patient:code=1234

Unterstützte Suchmodifikatoren

Suchmodifikatoren werden mit Feldern verwendet, die auf Zeichenfolgen basieren. Alle verwendeten Suchmodifikatoren verwenden boolesche Logik HealthLake . Sie könnten beispielsweise angeben:contains, dass ein größeres Zeichenkettenfeld eine kleine Zeichenfolge enthalten soll, damit es in Ihre Suchergebnisse aufgenommen wird.

Unterstützte Suchmodifikatoren
Suchmodifikator Typ
: fehlt Alle Parameter außer Composite
:exakt String
:enthält String
:nicht Token
:Text Token
:Bezeichner Referenz
:unten URI

Unterstützte Suchvergleicher

Sie können Suchkomparatoren verwenden, um die Art der Übereinstimmung in einer Suche zu steuern. Sie können Komparatoren verwenden, wenn Sie nach Zahlen-, Datums- und Mengenfeldern suchen. In der folgenden Tabelle sind Suchkomparatoren und ihre Definitionen aufgeführt, die von unterstützt werden. HealthLake

Unterstützte Suchvergleicher

Suchkomparator

Beschreibung

eq Der Wert für den Parameter in der Ressource entspricht dem angegebenen Wert.
Eins Der Wert für den Parameter in der Ressource entspricht nicht dem angegebenen Wert.
gt Der Wert für den Parameter in der Ressource ist größer als der angegebene Wert.
lt Der Wert für den Parameter in der Ressource ist kleiner als der angegebene Wert.
ge Der Wert für den Parameter in der Ressource ist größer oder gleich dem angegebenen Wert.
le Der Wert für den Parameter in der Ressource ist kleiner oder gleich dem angegebenen Wert.
sa Der Wert für den Parameter in der Ressource beginnt nach dem angegebenen Wert.
eb Der Wert für den Parameter in der Ressource endet vor dem angegebenen Wert.

FHIR-Suchparameter werden nicht unterstützt von HealthLake

HealthLake unterstützt alle FHIR-Suchparameter mit Ausnahme der in der folgenden Tabelle aufgeführten. Eine vollständige Liste der FHIR-Suchparameter finden Sie in der FHIR-Suchparameter-Registrierung.

Suchparameter werden nicht unterstützt
Zusammenstellung des Pakets Lage in der Nähe
Bundle-ID C onsent-source-reference
Bundle-Nachricht Vertragspatient
Typ des Pakets Inhalt der Ressource
Zeitstempel des Pakets Ressourcen-Abfrage