Konformitätserklärung (CapabilityStatement)

Beschreibung

Dieses CapabilityStatement beschreibt alle Interaktionen, die ein ISiK-konformes System unterstützen MUSS bzw. KANN, um das Bestätigungsverfahren für dieses Modul zu bestehen.

Jede Instanz eines bestätigungsrelevanten Systems MUSS an ihrem Endpunkt eine CapabilityStatement-Ressource bereitstellen. Hierzu MUSS die capabilities-Interaktion gemäß FHIR-Kernspezifikation unterstützt werden. Der MODE-Parameter kann ignoriert werden.
Das CapabilityStatement in dieser Spezifikation stellt die Anforderungen seitens der gematik dar (kind = requirements). Zur Unterscheidung von Anforderungen, die erfüllt werden MÜSSEN gegenüber jenen, die erfüllt werden KÖNNEN, wird die CapabilityStatement-Expectation-Extension mit den möglichen Werten SHALL (=MUSS) und MAY (=KANN) verwendet.

Eine Server-Instanz MUSS ihrerseits ein CapabilityStatement vom kind = instance liefern und im Element software den Namen und die Versionsnummer angeben. Darüber hinaus MUSS in CapabilityStatement.instantiates die Canonical URL des nachfolgenden CapabilityStatements angegeben werden.

Das CapabilityStatement der Instanz MUSS alle Funktionalitäten auflisten, die im folgenden CapabilityStatement mit SHALL gekennzeichnet sind. Das CapabilityStatement KANN darüber hinaus die mit MAY gekennzeichneten Funktionalitäten, sowie weitere Funktionalitäten auflisten, sofern diese in der Instanz implementiert wurden.

Die Verwendung der CapabilityStatement-Expectation-Extension ist im CapabilityStatement der Server-Instanz nicht erforderlich.

CanonicalURLhttps://gematik.de/fhir/isik/CapabilityStatement/ISiKCapabilityStatementBasisServer
Intentionrequirements
Statusactive
Version4.0.1

Anforderungen an die FHIR-API

Modusserver

Interaktionen

RessourcentypProfileVerbindlichkeitREADCREATESEARCHUPDATEDELETE
Accounthttps://gematik.de/fhir/isik/StructureDefinition/ISiKAbrechnungsfallSHALLSHALLSHALL
AllergyIntolerancehttps://gematik.de/fhir/isik/StructureDefinition/ISiKAllergieUnvertraeglichkeitSHALLSHALLSHALL
Bundlehttps://gematik.de/fhir/isik/StructureDefinition/ISiKBerichtBundleMAY
CodeSystemhttps://gematik.de/fhir/isik/StructureDefinition/ISiKCodeSystemMAYMAYMAY
Compositionhttps://gematik.de/fhir/isik/StructureDefinition/ISiKBerichtSubSystemeMAY
Conditionhttps://gematik.de/fhir/isik/StructureDefinition/ISiKDiagnoseSHALLSHALLSHALL
Coveragehttps://gematik.de/fhir/isik/StructureDefinition/ISiKVersicherungsverhaeltnisGesetzlich; https://gematik.de/fhir/isik/StructureDefinition/ISiKVersicherungsverhaeltnisSelbstzahlerSHALLSHALLSHALL
Encounterhttps://gematik.de/fhir/isik/StructureDefinition/ISiKKontaktGesundheitseinrichtungSHALLSHALLSHALL
Locationhttps://gematik.de/fhir/isik/StructureDefinition/ISiKStandort; https://gematik.de/fhir/isik/StructureDefinition/ISiKStandortRaum; https://gematik.de/fhir/isik/StructureDefinition/ISiKStandortBettenstellplatzMAYSHOULDSHOULDSHOULD
Observationhttps://gematik.de/fhir/isik/StructureDefinition/ISiKLebensZustand; https://gematik.de/fhir/isik/StructureDefinition/ISiKSchwangerschaftsstatus; https://gematik.de/fhir/isik/StructureDefinition/ISiKSchwangerschaftErwarteterEntbindungstermin; https://gematik.de/fhir/isik/StructureDefinition/ISiKAlkoholAbusus; https://gematik.de/fhir/isik/StructureDefinition/ISiKRaucherStatus; https://gematik.de/fhir/isik/StructureDefinition/ISiKStillstatusSHALLSHALLSHALL
Organizationhttps://gematik.de/fhir/isik/StructureDefinition/ISiKOrganisation; https://gematik.de/fhir/isik/StructureDefinition/ISiKOrganisationFachabteilungMAYSHOULDSHOULD
Patienthttps://gematik.de/fhir/isik/StructureDefinition/ISiKPatientSHALLSHALLSHALL
Practitionerhttps://gematik.de/fhir/isik/StructureDefinition/ISiKPersonImGesundheitsberufSHALLSHALLSHALL
Procedurehttps://gematik.de/fhir/isik/StructureDefinition/ISiKProzedurSHALLSHALLSHALL
RelatedPersonhttps://gematik.de/fhir/isik/StructureDefinition/ISiKAngehoerigerSHALLSHALLSHALL
Subscriptionhttps://gematik.de/fhir/isik/StructureDefinition/patient-merge-subscriptionMAYMAYMAYMAYMAY
ValueSethttps://gematik.de/fhir/isik/StructureDefinition/ISiKValueSetSHALLSHALL

Ressourcentyp-spezifische Operations

RessourcenTypNameSpezifikationVerbindlichkeit
Subscription$get-ws-binding-tokenhttp://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-get-ws-binding-tokenMAY

Dokumenten-Endpunkt

ModusVerbindlichkeitDokumentationProfil
consumerSHALL

Endpunkt zur Entgegennahme von Subsystem-Berichten in Form eines ISiKBerichtBundles. Weitere Hinweise siehe Bericht aus Subsystemen (Composition)

https://gematik.de/fhir/isik/StructureDefinition/ISiKBerichtBundle

Suchparameter

RessourcenTypSuchParameterVerbindlichkeitHinweiseDefinition
Patient_idSHALL

Beispiel:
GET [base]/[Resourcetype]?_id=103270
Anwendungshinweis:
Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten:
GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Resource-id
Patient_tagSHALL

Beispiel:
GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

http://hl7.org/fhir/SearchParameter/Resource-tag
Patient_countSHALL

Beispiel:
GET [base]/[Resourcetype]?_count=100
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

Patient_hasMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben
GET [base]/Patient?_has:Observation:patient:code=1234-5
Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde
GET [base]/Encounter?_has:Condition:encounter:code=A12.3
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

PatientidentifierSHALL

Beispiel:
GET [base]/Patient?identifier=http://fhir.krankenhaus.example|1032702
GET [base]/Patient?identifier=1032702
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Patient-identifier
PatientfamilySHALL

Beispiel:
GET [base]/Patient?family=Musterfrau
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/individual-family
PatientgivenSHALL

Beispiel:
GET [base]/Patient?given=Erika
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/individual-given
PatientbirthdateSHALL

Beispiel:
GET [base]/Patient?birthdate=1964-12-08
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/individual-birthdate
PatientgenderSHALL

Beispiel:
GET [base]/Patient?birthdate=1964-12-08
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/individual-gender
PatientnameMAY

Beispiel:
GET [base]/Patient?name=Erika
GET [base]/Patient?name=Erika
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Patient-name
PatientaddressMAY

Beispiel:
GET [base]/Patient?address=Berlin
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/individual-address
Patientaddress-cityMAY

Beispiel:
GET [base]/Patient?address-city=Berlin
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/individual-address-city
Patientaddress-countryMAY

Beispiel:
GET [base]/Patient?address-country=DE
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/individual-address-country
Patientaddress-postalcodeMAY

Beispiel:
GET [base]/Patient?address-postalcode=10117
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/individual-address-postalcode
PatientactiveMAY

Beispiel:
GET [base]/Patient?active=true
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Patient-active
PatienttelecomMAY

Beispiel:
GET [base]/Patient?telecom=phone|+49152236898
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/individual-telecom
Encounter_idSHALL

Beispiel:
GET [base]/[Resourcetype]?_id=103270
Anwendungshinweis:
Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten:
GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Resource-id
Encounter_tagSHALL

Beispiel:
GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

http://hl7.org/fhir/SearchParameter/Resource-tag
Encounter_countSHALL

Beispiel:
GET [base]/[Resourcetype]?_count=100
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

Encounter_hasMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben
GET [base]/Patient?_has:Observation:patient:code=1234-5
Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde
GET [base]/Encounter?_has:Condition:encounter:code=A12.3
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

EncounteridentifierSHALL

Beispiel:
GET [base]/Encounter?identifier=http://test.krankenhaus.de/fhir/sid/fallnr|123456
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/clinical-identifier
EncounterstatusSHALL

Beispiel:
GET [base]/Encounter?status=finished
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Encounter-status
EncounterclassSHALL

Beispiel:
GET [base]/Encounter?class=IMP
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Encounter-class
EncountertypeSHALL

Beispiel:
GET [base]/Encounter?type=http://fhir.de/CodeSystem/kontaktart-de|stationaer
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/clinical-type
EncounterpatientSHALL

Beispiel:
GET [base]/Encounter?patient=Patient/123
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.
Dieser Suchparameter ist für die Umsetzung des IHE QEDm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/clinical-patient
EncountersubjectSHALL

Beispiel:
GET [base]/Encounter?subject=Patient/123
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Encounter-subject
EncounteraccountSHALL

Beispiel:
GET [base]/Encounter?account=Account/123
GET [base]/Encounter?account:identifier=123456
GET [base]/Encounter?account:identifier=https://example.org/fhir/sid/abrechnungsfallnr|123456
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Encounter-account
EncounterdateSHALL

Beispiel:
GET [base]/Encounter?date=lt2020-26-10
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.
Bei der Formulierung der Suche sollten die Vorgaben aus der Definition der Such-Prefixe - und hier insbesondere die Unterschiede zwischen lt und eb bzw. gt und sa - beachtet werden.

http://hl7.org/fhir/SearchParameter/clinical-date
Encounterdate-startSHALL

Beispiel:
GET [base]/Encounter?end-date=lt2020-26-10
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.
Bei diesem Suchparameter handelt es sich um eine Präadoption eines Suchparameters, der in FHIR R5 hinzugefügt wurde.

https://gematik.de/fhir/isik/SearchParameter/Encounter-date-start
Encounterend-dateSHALL

Beispiel:
GET [base]/Encounter?end-date=lt2020-26-10
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.
Bei diesem Suchparameter handelt es sich um eine Präadoption eines Suchparameters, der in FHIR R5 hinzugefügt wurde.

https://gematik.de/fhir/isik/SearchParameter/Encounter-end-date
EncounterlocationMAY

Beispiel:
GET [base]/Encounter?location=Location/test
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Encounter-location
Encounterservice-providerMAY

Beispiel:
GET [base]/Encounter?service-provider=Organization/test
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Encounter-service-provider
Account_idSHALL

Beispiel:
GET [base]/[Resourcetype]?_id=103270
Anwendungshinweis:
Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten:
GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Resource-id
Account_tagSHALL

Beispiel:
GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

http://hl7.org/fhir/SearchParameter/Resource-tag
Account_countSHALL

Beispiel:
GET [base]/[Resourcetype]?_count=100
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

Account_hasMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben
GET [base]/Patient?_has:Observation:patient:code=1234-5
Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde
GET [base]/Encounter?_has:Condition:encounter:code=A12.3
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

AccountidentifierSHALL

Beispiel:
GET [base]/Account?identifier=http://test.krankenhaus.de/fhir/sid/fallnr|123456
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/clinical-identifier
AccountstatusSHALL

Beispiel:
GET [base]/Account?status=active
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Account-status
AccounttypeSHALL

Beispiel:
GET [base]/Account?type=http://terminology.hl7.org/CodeSystem/v3-ActCode|AMB
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/clinical-type
AccountpatientSHALL

Beispiel:
GET [base]/Account?patient=Patient/123
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/clinical-patient
Condition_idSHALL

Beispiel:
GET [base]/[Resourcetype]?_id=103270
Anwendungshinweis:
Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten:
GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Resource-id
Condition_tagSHALL

Beispiel:
GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

http://hl7.org/fhir/SearchParameter/Resource-tag
Condition_countSHALL

Beispiel:
GET [base]/[Resourcetype]?_count=100
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

Condition_hasMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben
GET [base]/Patient?_has:Observation:patient:code=1234-5
Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde
GET [base]/Encounter?_has:Condition:encounter:code=A12.3
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

Conditionclinical-statusSHALL

Beispiel:
GET [base]/Condition?clincial-status=active
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Condition-clinical-status
ConditionpatientSHALL

Beispiel:
GET [base]/Condition?patient=Patient/123
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.
Dieser Suchparameter ist für die Umsetzung des IHE QEDm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/clinical-patient
ConditionsubjectSHALL

Beispiel:
GET [base]/Condition?subject=Patient/123
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Condition-subject
ConditionencounterSHALL

Beispiel:
GET [base]/Condition?encounter=Patient/123
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Condition-encounter
Conditionrecorded-dateSHALL

Beispiel:
GET [base]/Condition?recorded-date=2015-01-01
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Condition-recorded-date
ConditionrelatedSHALL

Beispiel:
GET [base]/Condition?related=Condition/123
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation und Deutsche Basisprofile R4 - Doppel-/Mehrfachkodierte ICD-Codes.

http://fhir.de/SearchParameter/Condition-related
ConditioncategoryMAY

Beispiel:
GET [base]/Condition?category=http://hl7.org/fhir/ValueSet/condition-category|problem-list-item
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.
Dieser Suchparameter ist für die Umsetzung des IHE QEDm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Condition-category
Procedure_idSHALL

Beispiel:
GET [base]/[Resourcetype]?_id=103270
Anwendungshinweis:
Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten:
GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Resource-id
Procedure_tagSHALL

Beispiel:
GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

http://hl7.org/fhir/SearchParameter/Resource-tag
Procedure_countSHALL

Beispiel:
GET [base]/[Resourcetype]?_count=100
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

Procedure_hasMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben
GET [base]/Patient?_has:Observation:patient:code=1234-5
Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde
GET [base]/Encounter?_has:Condition:encounter:code=A12.3
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

ProcedurestatusSHALL

Beispiel:
GET [base]/Procedure?status=http://hl7.org/fhir/event-status|entered-in-error
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Procedure-status
ProcedurecategorySHALL

Beispiel:
GET [base]/Procedure?category=http://snomed.info/sct|387713003
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Procedure-category
ProcedurecodeSHALL

Beispiel:
GET [base]/Procedure?code=http://fhir.de/CodeSystem/bfarm/ops|5-470
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Procedure-code
ProcedurepatientSHALL

Beispiel:
GET [base]/Procedure?patient=Patient/123
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/clinical-patient
ProceduresubjectSHALL

Beispiel:
GET [base]/Procedure?subject=Patient/123
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Procedure-subject
ProcedureencounterSHALL

Beispiel:
GET [base]/Procedure?encounter=Encounter/123
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/clinical-encounter
ProceduredateSHALL

Beispiel:
GET [base]/Procedure?date=lt2020-26-10
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/clinical-date
Coverage_idSHALL

Beispiel:
GET [base]/[Resourcetype]?_id=103270
Anwendungshinweis:
Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten:
GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Resource-id
Coverage_tagSHALL

Beispiel:
GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

http://hl7.org/fhir/SearchParameter/Resource-tag
Coverage_countSHALL

Beispiel:
GET [base]/[Resourcetype]?_count=100
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

Coverage_hasMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben
GET [base]/Patient?_has:Observation:patient:code=1234-5
Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde
GET [base]/Encounter?_has:Condition:encounter:code=A12.3
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

CoveragestatusSHALL

Beispiel:
GET [base]/Coverage?status=active
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Coverage-status
CoveragetypeSHALL

Beispiel:
GET [base]/Coverage?type=http://fhir.de/CodeSystem/versicherungsart-de-basis|GKV
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Coverage-type
CoveragebeneficiarySHALL

Beispiel:
GET [base]/Coverage?beneficiary=Patient/123
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Coverage-beneficiary
CoveragepayorSHALL

Beispiel:
GET [base]/Coverage?payor:identifier=0123456789
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Coverage-payor
CoveragesubscriberMAY

Beispiel:
GET [base]/Coverage?subscriber=Patient/123
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Coverage-subscriber
RelatedPerson_idSHALL

Beispiel:
GET [base]/[Resourcetype]?_id=103270
Anwendungshinweis:
Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten:
GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Resource-id
RelatedPerson_tagSHALL

Beispiel:
GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

http://hl7.org/fhir/SearchParameter/Resource-tag
RelatedPerson_countSHALL

Beispiel:
GET [base]/[Resourcetype]?_count=100
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

RelatedPerson_hasMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben
GET [base]/Patient?_has:Observation:patient:code=1234-5
Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde
GET [base]/Encounter?_has:Condition:encounter:code=A12.3
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

RelatedPersonpatientSHALL

Beispiel:
GET [base]/RelatedPerson?patient=Patient/123
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/RelatedPerson-patient
RelatedPersonnameMAY

Beispiel:
GET [base]/RelatedPerson?name=Heidi
GET [base]/RelatedPerson?name=Alpenzauber
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/RelatedPerson-name
RelatedPersonaddressMAY

Beispiel:
GET [base]/RelatedPerson?address=Berlin
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/individual-address
RelatedPersonaddress-cityMAY

Beispiel:
GET [base]/RelatedPerson?address-city=Berlin
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/individual-address-city
RelatedPersonaddress-countryMAY

Beispiel:
GET [base]/RelatedPerson?address-country=DE
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/individual-address-country
RelatedPersonaddress-postalcodeMAY

Beispiel:
GET [base]/RelatedPerson?address-postalcode=10117
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/individual-address-postalcode
Practitioner_idSHALL

Beispiel:
GET [base]/[Resourcetype]?_id=103270
Anwendungshinweis:
Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten:
GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Resource-id
Practitioner_tagSHALL

Beispiel:
GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

http://hl7.org/fhir/SearchParameter/Resource-tag
Practitioner_countSHALL

Beispiel:
GET [base]/[Resourcetype]?_count=100
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

Practitioner_hasMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben
GET [base]/Patient?_has:Observation:patient:code=1234-5
Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde
GET [base]/Encounter?_has:Condition:encounter:code=A12.3
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

PractitioneridentifierSHALL

Beispiel:
GET [base]/Practitioner?identifier=42
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Practitioner-identifier
PractitionerfamilySHALL

Beispiel:
GET [base]/Practitioner?family=Alpenzauber
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/individual-family
PractitionergivenSHALL

Beispiel:
GET [base]/Practitioner?given=Heidi
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/individual-given
PractitionernameMAY

Beispiel:
GET [base]/Practitioner?name=Heidi GET [base]/Practitioner?name=Alpenzauber
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Practitioner-name
PractitioneraddressMAY

Beispiel:
GET [base]/Practitioner?address=Berlin
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/individual-address
PractitionergenderMAY

Beispiel:
GET [base]/Practitioner?gender=female
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/individual-gender
CodeSystem_idSHALL

Beispiel:
GET [base]/[Resourcetype]?_id=103270
Anwendungshinweis:
Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten:
GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Resource-id
CodeSystem_tagSHALL

Beispiel:
GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

http://hl7.org/fhir/SearchParameter/Resource-tag
CodeSystem_countSHALL

Beispiel:
GET [base]/[Resourcetype]?_count=100
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

CodeSystem_hasMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben
GET [base]/Patient?_has:Observation:patient:code=1234-5
Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde
GET [base]/Encounter?_has:Condition:encounter:code=A12.3
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

CodeSystemurlMAY

Beispiel:
GET [base]/CodeSystem?url=http://example.org/fhir/CodeSystem/test
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/conformance-url
ValueSet_idSHALL

Beispiel:
GET [base]/[Resourcetype]?_id=103270
Anwendungshinweis:
Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten:
GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Resource-id
ValueSet_tagSHALL

Beispiel:
GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

http://hl7.org/fhir/SearchParameter/Resource-tag
ValueSet_countSHALL

Beispiel:
GET [base]/[Resourcetype]?_count=100
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

ValueSet_hasMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben
GET [base]/Patient?_has:Observation:patient:code=1234-5
Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde
GET [base]/Encounter?_has:Condition:encounter:code=A12.3
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

ValueSeturlSHALL

Beispiel:
GET [base]/ValueSet?url=http://example.org/fhir/ValueSet/test
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/conformance-url
ValueSetnameSHALL

Beispiel:
GET [base]/ValueSet?name=TestValueSet
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/conformance-name
ValueSetstatusSHALL

Beispiel:
GET [base]/ValueSet?status=active
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/conformance-status
ValueSetversionSHALL

Beispiel:
GET [base]/ValueSet?version=1.0.0
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/conformance-version
ValueSetcontext-type-valueMAY

Beispiel:
GET [base]/ValueSet?context-type-value=http://terminology.hl7.org/CodeSystem/usage-context-type|focus$http://hl7.org/fhir/resource-types|Encounter
Anwendungshinweis:
Mit dieser Abfrage können hausinterne Kataloge anhand des Ressource-Typs ermittelt werden. Diese Informationen sind u.a. relevant im Kontext von:
* Hausinternen Prozeduren/Diagnosen-Codes * Kodierung von Encounter-Informationen (z.B. Wahlleistungen, Orttypen)
Use Cases im Zusammenhang:
(A) Zur Konfigurationszeit können passende ValueSets von einem Server spezifisch für einen Ressourcentyp abgerufen und vorbereitend auf eine Systemintegration begutachtet bzw. in Client-Systeme eingebunden werden. In diesem Sinne wird die Abfrage im Kontext der Terminvereinbarung durch einen Termin-Requestor genutzt.
(B) Zur Laufzeit können spezifische ValueSets synchronisiert bzw. direkt in die Eingabemasken von Clients eingebunden werden.
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/conformance-context-type-value
Observation_idSHALL

Beispiel:
GET [base]/[Resourcetype]?_id=103270
Anwendungshinweis:
Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten:
GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Resource-id
Observation_tagSHALL

Beispiel:
GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

http://hl7.org/fhir/SearchParameter/Resource-tag
Observation_countSHALL

Beispiel:
GET [base]/[Resourcetype]?_count=100
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

Observation_hasMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben
GET [base]/Patient?_has:Observation:patient:code=1234-5
Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde
GET [base]/Encounter?_has:Condition:encounter:code=A12.3
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

ObservationstatusSHALL

Beispiel:
GET [base]/Observation?status=http://hl7.org/fhir/observation-status|final
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Observation-status
ObservationcategorySHALL

Beispiel:
GET [base]/Observation?category=http://terminology.hl7.org/CodeSystem/observation-category|social-history
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Observation-category
ObservationcodeSHALL

Beispiel:
GET [base]/Observation?code=http://loinc.org|82810-3
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/clinical-code
ObservationpatientSHALL

Beispiel:
GET [base]/Observation?patient=Patient/123
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/clinical-patient
ObservationsubjectSHALL

Beispiel:
GET [base]/Observation?subject=Patient/123
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Observation-subject
ObservationdateSHALL

Beispiel:
GET [base]/Observation?date=ge2013-01-14&date=le2021-12-31
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/clinical-date
Observationcombo-codeSHALL

Beispiel:
GET [base]/Observation?combo-code=85354-9
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Observation-combo-code
Observationcombo-code-value-quantitySHALL

Beispiel:
GET [base]/Observation?combo-code-value-quantity=http://loinc.org|8480-6$120|http://unitsofmeasure.org|mm[Hg]
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Observation-combo-code-value-quantity
Observationcomponent-codeSHALL

Beispiel:
GET [base]/Observation?component-code=http://loinc.org|85354-9
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Observation-component-code
ObservationencounterSHALL

Beispiel:
GET [base]/Observation?encounter=Encounter/234
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/clinical-encounter
Location_idSHALL

Beispiel:
GET [base]/[Resourcetype]?_id=103270
Anwendungshinweis:
Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten:
GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Resource-id
Location_tagSHALL

Beispiel:
GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

http://hl7.org/fhir/SearchParameter/Resource-tag
Location_countSHALL

Beispiel:
GET [base]/[Resourcetype]?_count=100
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

Location_hasMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben
GET [base]/Patient?_has:Observation:patient:code=1234-5
Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde
GET [base]/Encounter?_has:Condition:encounter:code=A12.3
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

LocationidentifierMAY

Beispiel:
GET [base]/Location?identifier=http://fhir.krankenhaus.example|260120196
GET [base]/Location?identifier=345678975
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Location-identifier
LocationaddressMAY

Beispiel:
GET [base]/Location?address=Berlin
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Location-address
Locationoperational-statusMAY

Beispiel:
GET [base]/Location?operational-status=Unoccupied
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Location-operational-status
LocationorganizationMAY

Beispiel:
GET [base]/Location?organization=AbteilungAllgemeinchirurgieOrganisationBeispiel
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Location-organization
LocationtypeMAY

Beispiel zur Suche nach Typ eines Standorts:
GET [base]/Location?type=bed
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Location-type
LocationpartofMAY

Beispiel zur Suche nach Standort-Zugehörigkeit eines Raums (Zu welcher Abteilung gehört dieser Raum?):
[base]/Location?partof=RaumStandortBeispiel
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Location-partof
LocationcontainsMAY

Beispiel zur Suche nach Standort-Zugehörigkeit eines Raums:
GET [base]/Location?contains=KoordinatenBeispielGeoJSON
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Location-contains
LocationnearMAY

Beispiel zur Suche nach Standort nahe (100m) Koordinaten:
GET [base]/Location?contains=52.525851|13.37774|100|m
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Location-near
Organization_idSHALL

Beispiel:
GET [base]/[Resourcetype]?_id=103270
Anwendungshinweis:
Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten:
GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Resource-id
Organization_tagSHALL

Beispiel:
GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

http://hl7.org/fhir/SearchParameter/Resource-tag
Organization_countSHALL

Beispiel:
GET [base]/[Resourcetype]?_count=100
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

Organization_hasMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben
GET [base]/Patient?_has:Observation:patient:code=1234-5
Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde
GET [base]/Encounter?_has:Condition:encounter:code=A12.3
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

OrganizationidentifierSHALL

Beispiel:
GET [base]/Organization?identifier=http://fhir.de/sid/arge-ik/iknr|260120196 GET [base]/Organization?identifier=http://fhir.de/StructureDefinition/identifier-bsnr|345678975 GET [base]/Organization?identifier=345678975
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Organization-identifier
OrganizationactiveSHALL

Beispiel:
GET [base]/Organization?active=true GET [base]/Organization?active=false
Anwendungshinweis:
Insbesondere für die Suche nach Daten historischer Organisationsstrukturen - z.B. nach Schließung, Zusammenlegung von Fachabteilungen etc. - erscheint es erforderlich nach Ressourcen nicht aktiver Organisationseinheiten suchen zu können. Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Organization-active
OrganizationtypeSHALL

Beispiel:
GET [base]/Organization?type=dept
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Organization-type
OrganizationnameSHALL

Beispiel:
GET [base]/Organization?name=FA-Gynäkologie
GET [base]/Organization?name=GYN
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Organization-name
OrganizationaddressMAY

Beispiel:
GET [base]/Organization?address=Berlin
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Organization-address
OrganizationpartofSHALL

Beispiel:
GET [base]/Organization?partof:identifier=260120196
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Organization-partof
OrganizationendpointMAY

Beispiel:
GET [base]/Organization?endpoint:identifier=123456
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Organization-endpoint
AllergyIntolerance_idSHALL

Beispiel:
GET [base]/[Resourcetype]?_id=103270
Anwendungshinweis:
Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten:
GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Resource-id
AllergyIntolerance_tagSHALL

Beispiel:
GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

http://hl7.org/fhir/SearchParameter/Resource-tag
AllergyIntolerance_countSHALL

Beispiel:
GET [base]/[Resourcetype]?_count=100
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

AllergyIntolerance_hasMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben
GET [base]/Patient?_has:Observation:patient:code=1234-5
Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde
GET [base]/Encounter?_has:Condition:encounter:code=A12.3
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

AllergyIntoleranceclinical-statusSHALL

Beispiel:
GET [base]/AllergyIntolerance?clinical-status=active
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status
AllergyIntolerancepatientSHALL

Beispiel:
GET [base]/AllergyIntolerance?patient=Patient/123
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/clinical-patient
AllergyIntoleranceonsetSHALL

Beispiel:
GET [base]/AllergyIntolerance?onset=2015-01-01T12:00:23Z+02:00
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/AllergyIntolerance-onset
AllergyIntolerancedateSHALL

Beispiel:
GET [base]/AllergyIntolerance?date=2015-01-01T12:00:23Z+02:00
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/conformance-date
AllergyIntolerancecategorySHALL

Beispiel:
GET [base]/AllergyIntolerance?category=environment
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/AllergyIntolerance-category
AllergyIntolerancetypeSHALL

Beispiel:
GET [base]/AllergyIntolerance?type=allergy
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/clinical-type

(Reverse-)Include

RessourcenTypInclude (SHALL)Include (MAY)Reverse Include (MAY)
PatientComposition:patient; Composition:subject; Composition:author; Condition:patient; Condition:subject; Procedure:patient; Procedure:subject; Encounter:patient; Encounter:subject; Coverage:beneficiary; Coverage:subscriber; Coverage:patient; Coverage:payor; Account:subject; Account:patient; AllergyIntolerance:patient; Observation:patient
EncounterEncounter:patientEncounter:subject; Encounter:part-of; Encounter:diagnosis; Encounter:accountEncounter:part-of; Condition:encounter; Composition:encounter; Procedure:encounter
Account
ConditionCondition:patient; Condition:encounterCondition:subjectEncounter:diagnosis
ProcedureProcedure:patient; Procedure:encounterProcedure:subjectEncounter:diagnosis
CoverageCoverage:patientCoverage:subscriber; Coverage:payor; Coverage:beneficiary
RelatedPersonRelatedPerson:patientCoverage:subscriber; Coverage:payor
Practitioner
CodeSystem
ValueSet
Composition
Bundle
ObservationObservation:encounter; Observation:patientObservation:subject
Location
Organization
AllergyIntoleranceAllergyIntolerance:patient; AllergyIntolerance:encounterAllergyIntolerance:recorder; AllergyIntolerance:asserter
Subscription