AMTS ISiK Implementierungsleitfaden
Version 6.0.0-rc - ballot

CapabilityStatement: Akteur ISiKCapabilityStatementBasisServerAkteur (Expanded)

Official URL: https://gematik.de/fhir/isik/CapabilityStatement/ISiKCapabilityStatementBasisServerAkteur-expanded Version: 6.0.0-rc
Active as of 2026-04-02 Computable Name: ISiK-CapabilityStatementBasisServerAkteurExpanded

Dieses CapabilityStatement beschreibt alle Interaktionen, die ein System unterstützen MUSS, welches diesen Akteur implementiert.

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 Rollen, die erfüllt werden MÜSSEN gegenüber jenen, die erfüllt werden KÖNNEN, wird die CapabilityStatement-Imports-Expectation-Extension mit den möglichen Werten ‘SHALL’ (=MUSS) ‘SHOULD’ (=SOLL) ‘MAY’ (=KANN) ‘SHOULD-NOT’ (=SOLL NICHT) 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 MÜSSEN in CapabilityStatement.instantiates sämtliche Canonical URLs der implementierten Rollen angegeben werden. Die mindestens zu implementierenden Profile für einen Akteur und Interaktionen entsprechen daher den aggregierten Anforderungen der einzelnen Rolle (per ‘imports’). In den CapabilityStatements zu den Rollen sind die Anforderungen tabellarisch gelistet und weisen so die zu implementierenden Profile aus.

Das CapabilityStatement der Instanz MUSS alle Funktionalitäten auflisten, die im folgenden CapabilityStatement (bzw. der in ihm importierten Rollen - siehe ‘imports’) 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.

CapabilityStatement für den Akteur ISiKCapabilityStatementBasisServerAkteur. Dieser Akteur aggregiert die Rollen zur Abfrage von Stammdaten, Erweiterte Stammdaten, Aufbau-Struktur, Terminologie, klinischen Daten, Abrechnungsinformationen und Gesundheitsstatus.

Akteur ISiKCapabilityStatementBasisServerAkteur (Expanded)

  • Implementation Guide Version: 6.0.0-rc
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Published on: 2026-04-02
  • Published by: gematik GmbH

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

  • https://gematik.de/fhir/isik/ImplementationGuide/ISiK-Basismodul

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
PatientSupported Profiles
  ISiKPatient
YY_id, _count, _has, _tag, _lastUpdated, identifier, family, given, birthdate, gender, name, address, address-city, address-country, address-postalcode, active, telecomEncounter:patient, Encounter:subject$Patient-everything
EncounterSupported Profiles
  ISiKKontaktGesundheitseinrichtung
YY_id, _count, _has, _tag, _lastUpdated, identifier, status, class, type, patient, account, date, date-start, end-date, location, service-providerEncounter:patient, Encounter:subject, Encounter:part-of, Encounter:diagnosis, Encounter:accountEncounter:part-of$Encounter-everything
OrganizationSupported Profiles
  ISiKOrganisation
  ISiKOrganisationFachabteilung
YY_id, _count, _has, _tag, _lastUpdated, identifier, active, type, name, address, partof, endpoint
LocationSupported Profiles
  ISiKStandort
  ISiKStandortRaum
  ISiKStandortBettenstellplatz
YYY_id, _count, _has, _tag, _lastUpdated, identifier, address, operational-status, organization, partof, near, characteristic
PractitionerSupported Profiles
  ISiKPersonImGesundheitsberuf
YY_id, _count, _has, _tag, _lastUpdated, identifier, family, given, name, address, gender
PractitionerRoleSupported Profiles
  ISiKRolleImKrankenhaus
YY_id, _count, _has, _tag, _lastUpdated, active, identifier, organization, practitioner, role, specialty
ObservationSupported Profiles
  ISiKLebensZustand
  ISiK Schwangerschaftsstatus
  ISiK Schwangerschaft - Erwarteter Entbindungstermin
  ISiK Alkohol Abusus
  ISiK Raucherstatus
  ISiKStillstatus
YY_id, _count, _has, _tag, _lastUpdated, status, category, code, patient, subject, date, code-value-concept, code-value-date, component-code, encounterObservation:encounter, Observation:patient, Observation:subject
AllergyIntoleranceSupported Profiles
  ISiKAllergieUnvertraeglichkeit
YY_id, _count, _has, _tag, _lastUpdated, clinical-status, patient, onset, date, category, typeAllergyIntolerance:patient, AllergyIntolerance:encounter, AllergyIntolerance:recorder, AllergyIntolerance:asserter
ProcedureSupported Profiles
  ISiKProzedur
YY_id, _count, _has, _tag, _lastUpdated, status, category, code, patient, subject, encounter, dateProcedure:patient, Procedure:subject, Procedure:encounterEncounter:diagnosis
ConditionSupported Profiles
  ISiKDiagnose
YY_id, _count, _has, _tag, _lastUpdated, clinical-status, patient, subject, encounter, recorded-date, related, categoryCondition:patient, Condition:subject, Condition:encounterEncounter:diagnosis
CodeSystemSupported Profiles
  ISiKCodeSystem
y?y?_id, _count, _has, _tag, _lastUpdated, url
ValueSetSupported Profiles
  ISiKValueSet
YY_id, _count, _has, _tag, _lastUpdated, url, name, status, version, context-type-value
CoverageSupported Profiles
  ISiKVersicherungsverhaeltnisGesetzlich
  ISiKVersicherungsverhaeltnisSelbstzahler
  ISiKVersicherungsverhaeltnisSonstige
YY_id, _count, _has, _tag, _lastUpdated, status, type, beneficiary, payor, subscriberCoverage:subscriber, Coverage:patient, Coverage:payor, Coverage:beneficiary
RelatedPersonSupported Profiles
  ISiKAngehoeriger
YY_id, _count, _has, _tag, _lastUpdated, patient, name, address, address-city, address-country, address-postalcodeRelatedPerson:patientCoverage:subscriber, Coverage:payor
AccountSupported Profiles
  ISiKAbrechnungsfall
  ISiKAbrechnungsfallAmbulant
YY_id, _count, _has, _tag, _lastUpdated, identifier, status, type, patient
DeviceSupported Profiles
  ISiKImplantat
y?y?_id, _count, _has, _tag, _lastUpdated, status, type, patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

ISiKPatient

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

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.

SHALL_countnumber

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

SHALL_lastUpdateddate

Beispiel: Suche nach allen Patienten-Ressourcen, die seit dem 1. Januar neu angelegt oder geändert wurden:
GET [base]/Patient?_lastUpdated=ge2026-01-01
Beispiel: Suche nach allen Observations eines Patienten im Zeitraum einer Stunde:
GET [base]/Observation?_lastUpdated=ge2026-03-05T10:20:10.423+02:00&_lastUpdate=lt2026-03-05T11:20:10.423+02:00&patient=Patient/12345
Anwendungshinweis:
Dieser Suchparameter dient dem Datenabgleich zwischen Systemen und ist auch für die patientenübergreifende Suche zugelassen. Server können die Anfrage mit einer OperationOutcome-Ressource und dem Fehlercode too-costly beantworten, wenn das vom Client gewählte Zeitfenster oder die Treffermenge zu groß ist und die Durchführhung der Suchanfrage das System unverhältnismäßig stark belasten würde. Weitere Details siehe FHIR-Kernspezifikation, Abschnitt _lastUpdated.

SHALLidentifiertoken

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.

SHALLfamilystring

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

SHALLgivenstring

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

SHALLbirthdatedate

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

SHALLgendertoken

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.

SHALLnamestring

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

SHALLaddressstring

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

SHALLaddress-citystring

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.

SHALLaddress-countrystring

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.

SHALLaddress-postalcodestring

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.

SHALLactivetoken

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

SHALLtelecomtoken

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.

MAY_hasstring

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.

MAY_tagtoken

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.

 
Extended Operations
ConformanceOperationDocumentation
SHALL$Patient-everything

In der Operation ist die Ergebnismenge wie folgt definiert: 'The server SHOULD return at least all resources that it has that are in the patient compartment for the identified patient(s), and any resource referenced from those, including binaries and attachments.'. Im Kontext von ISiK ist das so zu interpretieren, dass ein Akteur alle Ressourcen, die laut seinem CapabilityStatement über seine API abrufbar sind und die Teil des Patient-CompartmentDefinition sind, zurückgeben MUSS. Inklusive aller Ressourcen, die von diesen Ressourcen referenziert werden, einschließlich Binaries und Attachments.

Ein ISiK Akteur MUSS nur das das Instance-Level ([base]/Patient/[id]/$everything) unterstützen, nicht jedoch die Type-Level Operation ([base]/Patient/$everything).

Ein ISiK Akteur darf sinnvolle Limits für die Einschränkung der Ergebnismenge definieren, wie die Forcierung von Pagination über den Parameter _count oder die Einschränkung des Zeitraums der zurückgegebenen Ressourcen über den Parameter _since. Hierbei sollten die Hinweise und vorgaben der ISiK-Spezifikation zu Performance beachtet werden.

Core FHIR Resource
Encounter
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

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.

SHALL_countnumber

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

SHALL_lastUpdateddate

Beispiel: Suche nach allen Patienten-Ressourcen, die seit dem 1. Januar neu angelegt oder geändert wurden:
GET [base]/Patient?_lastUpdated=ge2026-01-01
Beispiel: Suche nach allen Observations eines Patienten im Zeitraum einer Stunde:
GET [base]/Observation?_lastUpdated=ge2026-03-05T10:20:10.423+02:00&_lastUpdate=lt2026-03-05T11:20:10.423+02:00&patient=Patient/12345
Anwendungshinweis:
Dieser Suchparameter dient dem Datenabgleich zwischen Systemen und ist auch für die patientenübergreifende Suche zugelassen. Server können die Anfrage mit einer OperationOutcome-Ressource und dem Fehlercode too-costly beantworten, wenn das vom Client gewählte Zeitfenster oder die Treffermenge zu groß ist und die Durchführhung der Suchanfrage das System unverhältnismäßig stark belasten würde. Weitere Details siehe FHIR-Kernspezifikation, Abschnitt _lastUpdated.

SHALLidentifiertoken

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

SHALLstatustoken

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

SHALLclasstoken

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

SHALLtypetoken

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

SHALLpatientreference

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.

SHALLaccountreference

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.

SHALLdatedate

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.

SHALLdate-startdate

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.

SHALLend-datedate

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.

SHALLlocationreference

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

SHALLservice-providerreference

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

MAY_hasstring

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.

MAY_tagtoken

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.

 
Extended Operations
ConformanceOperationDocumentation
SHALL$Encounter-everything

Im Kontext von ISiK werden auf Basis der Core-Definition der Operation Encounter-everything folgende Festlegungen getroffen:

- Ein Akteur MUSS alle Ressourcen zurückgeben, die laut seinem CapabilityStatement über seine API abrufbar sind und die Teil des [Encounter-CompartmentDefinition](http://hl7.org/fhir/R4/compartmentdefinition-encounter.html) sind.
- Im Kontext von ISiK werden assoziierte Encounter über die Verknüpfung mit dem selben Abrechnungsfall dargestellt. Aus dem Grund MÜSSEN alle Ressourcen beinhaltet sein, die auch auf Encounter verweisen, welche mit dem selben Abrechnungsfall (`Encounter.account.identifier`) verknüpft sind. Auf diese Encounter wird die selbe Logik wie in Punkt 1 und den folgenden Punkten angewendet.
- Zusätzlich (zum Encounter-Compartment) sind Ressourcen OHNE Fallbezug, die dem gleichen Patienten zugeordnet sind, einzubeziehen:
  - AllergyIntolerances
- Es müssen alle Ressourcen inkludiert werden, die aus den oben identifizierten Ressourcen referenziert werden, einschließlich Binaries und Attachments.

Ein ISiK Akteur darf sinnvolle Limits für die Einschränkung der Ergebnismenge definieren, wie die Forcierung von Pagination über den Parameter _count oder die Einschränkung des Zeitraums der zurückgegebenen Ressourcen über den Parameter _since. Hierbei sollten die Hinweise und vorgaben der ISiK-Spezifikation zu Performance beachtet werden.

Core FHIR Resource
Organization
Reference Policy
Interaction summary
  • SHALL support
    read

    Die Ressource Organization MUSS unterstützt werden, da sie notwendig ist zur Abbildung der Aufbaustruktur und insbesondere zur Ausgabe von Angaben zu Fachbereichen.

    search-type

    Die REST-Interaktion search MUSS implementiert werden, um die Suche nach Organisationseinheiten, Fachbereichen und Stationen zu ermöglichen.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

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.

SHALL_countnumber

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

SHALL_lastUpdateddate

Beispiel: Suche nach allen Patienten-Ressourcen, die seit dem 1. Januar neu angelegt oder geändert wurden:
GET [base]/Patient?_lastUpdated=ge2026-01-01
Beispiel: Suche nach allen Observations eines Patienten im Zeitraum einer Stunde:
GET [base]/Observation?_lastUpdated=ge2026-03-05T10:20:10.423+02:00&_lastUpdate=lt2026-03-05T11:20:10.423+02:00&patient=Patient/12345
Anwendungshinweis:
Dieser Suchparameter dient dem Datenabgleich zwischen Systemen und ist auch für die patientenübergreifende Suche zugelassen. Server können die Anfrage mit einer OperationOutcome-Ressource und dem Fehlercode too-costly beantworten, wenn das vom Client gewählte Zeitfenster oder die Treffermenge zu groß ist und die Durchführhung der Suchanfrage das System unverhältnismäßig stark belasten würde. Weitere Details siehe FHIR-Kernspezifikation, Abschnitt _lastUpdated.

SHALLidentifiertoken

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.

SHALLactivetoken

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.

SHALLtypetoken

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

SHALLnamestring

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

SHALLpartofreference

Begründung: Die Suche nach übergeordneten Organisationseinheiten (z.B. Zugehörigkeit einer Station zu einem Fachbereich) ist eine zentrale Anforderung für die Abbildung der Aufbaustruktur. Beispiel:
GET [base]/Organization?partof:identifier=260120196
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

MAY_hasstring

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.

MAY_tagtoken

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.

MAYaddressstring

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

MAYendpointreference

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

 
Core FHIR Resource
Location
Reference Policy
Interaction summary
  • SHALL support
    read

    Begründung: Die REST-Interaktion read muss implementiert werden, um einzelne Ressourcen abzurufen.

    search-type

    Begründung: Die REST-Interaktion search muss implementiert werden, um Ressourcen nach bestimmten Kriterien zu suchen.

  • SHOULD support
    update

    Sofern die Ressourcen zum Standort unterstützt werden, SOLL die REST-Interaktion update implementiert werden. Diese dient insbesondere dem Synchronisieren des Status (Location.operationalStatus) der abgeleiteten Ressourcen ISiKStandortRaum und ISiKStandortBettenstellplatz - u.a. zur Kennzeichnung als 'Frei', 'Besetzt', 'Kontaminiert', 'Isoliert', in 'Reinigung' etc.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

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.

SHALL_countnumber

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

SHALL_lastUpdateddate

Beispiel: Suche nach allen Patienten-Ressourcen, die seit dem 1. Januar neu angelegt oder geändert wurden:
GET [base]/Patient?_lastUpdated=ge2026-01-01
Beispiel: Suche nach allen Observations eines Patienten im Zeitraum einer Stunde:
GET [base]/Observation?_lastUpdated=ge2026-03-05T10:20:10.423+02:00&_lastUpdate=lt2026-03-05T11:20:10.423+02:00&patient=Patient/12345
Anwendungshinweis:
Dieser Suchparameter dient dem Datenabgleich zwischen Systemen und ist auch für die patientenübergreifende Suche zugelassen. Server können die Anfrage mit einer OperationOutcome-Ressource und dem Fehlercode too-costly beantworten, wenn das vom Client gewählte Zeitfenster oder die Treffermenge zu groß ist und die Durchführhung der Suchanfrage das System unverhältnismäßig stark belasten würde. Weitere Details siehe FHIR-Kernspezifikation, Abschnitt _lastUpdated.

SHALLidentifiertoken

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

SHALLcharacteristictoken

Begründung: Die Suche nach Stationen ist notwendig und wird über diesen Suchparameter ermöglicht.

    **Beispiel:**    
    `GET [base]/Location?characteristic=http://terminology.hl7.org/CodeSystem/location-physical-type|wa` 
    **Anwendungshinweis:**   
    Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/search.html#token).  
MAY_hasstring

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.

MAY_tagtoken

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.

MAYaddressstring

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

MAYoperational-statustoken

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

MAYorganizationreference

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

MAYpartofreference

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.

MAYnearspecial

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

 
Core FHIR Resource
Practitioner
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

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.

SHALL_countnumber

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

SHALL_lastUpdateddate

Beispiel: Suche nach allen Patienten-Ressourcen, die seit dem 1. Januar neu angelegt oder geändert wurden:
GET [base]/Patient?_lastUpdated=ge2026-01-01
Beispiel: Suche nach allen Observations eines Patienten im Zeitraum einer Stunde:
GET [base]/Observation?_lastUpdated=ge2026-03-05T10:20:10.423+02:00&_lastUpdate=lt2026-03-05T11:20:10.423+02:00&patient=Patient/12345
Anwendungshinweis:
Dieser Suchparameter dient dem Datenabgleich zwischen Systemen und ist auch für die patientenübergreifende Suche zugelassen. Server können die Anfrage mit einer OperationOutcome-Ressource und dem Fehlercode too-costly beantworten, wenn das vom Client gewählte Zeitfenster oder die Treffermenge zu groß ist und die Durchführhung der Suchanfrage das System unverhältnismäßig stark belasten würde. Weitere Details siehe FHIR-Kernspezifikation, Abschnitt _lastUpdated.

SHALLidentifiertoken

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

SHALLfamilystring

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

SHALLgivenstring

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

MAY_hasstring

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.

MAY_tagtoken

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.

MAYnamestring

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

MAYaddressstring

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

MAYgendertoken

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

 
Core FHIR Resource
PractitionerRole
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

ISiKRolleImKrankenhaus

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

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.

SHALL_countnumber

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

SHALL_lastUpdateddate

Beispiel: Suche nach allen Patienten-Ressourcen, die seit dem 1. Januar neu angelegt oder geändert wurden:
GET [base]/Patient?_lastUpdated=ge2026-01-01
Beispiel: Suche nach allen Observations eines Patienten im Zeitraum einer Stunde:
GET [base]/Observation?_lastUpdated=ge2026-03-05T10:20:10.423+02:00&_lastUpdate=lt2026-03-05T11:20:10.423+02:00&patient=Patient/12345
Anwendungshinweis:
Dieser Suchparameter dient dem Datenabgleich zwischen Systemen und ist auch für die patientenübergreifende Suche zugelassen. Server können die Anfrage mit einer OperationOutcome-Ressource und dem Fehlercode too-costly beantworten, wenn das vom Client gewählte Zeitfenster oder die Treffermenge zu groß ist und die Durchführhung der Suchanfrage das System unverhältnismäßig stark belasten würde. Weitere Details siehe FHIR-Kernspezifikation, Abschnitt _lastUpdated.

SHALLactivetoken

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

SHALLidentifiertoken

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

SHALLorganizationreference

Beispiel:
GET [base]/PractitionerRole?organization=Organization/test
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALLpractitionerreference

Beispiel:
GET [base]/PractitionerRole?practitioner=Practitioner/test
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALLroletoken

Beispiel:
GET [base]/PractitionerRole?role=doctor
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALLspecialtytoken

Beispiel:
GET [base]/PractitionerRole?specialty=cardiology
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

MAY_hasstring

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.

MAY_tagtoken

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.

 
Core FHIR Resource
Observation
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

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.

SHALL_countnumber

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

SHALL_lastUpdateddate

Beispiel: Suche nach allen Patienten-Ressourcen, die seit dem 1. Januar neu angelegt oder geändert wurden:
GET [base]/Patient?_lastUpdated=ge2026-01-01
Beispiel: Suche nach allen Observations eines Patienten im Zeitraum einer Stunde:
GET [base]/Observation?_lastUpdated=ge2026-03-05T10:20:10.423+02:00&_lastUpdate=lt2026-03-05T11:20:10.423+02:00&patient=Patient/12345
Anwendungshinweis:
Dieser Suchparameter dient dem Datenabgleich zwischen Systemen und ist auch für die patientenübergreifende Suche zugelassen. Server können die Anfrage mit einer OperationOutcome-Ressource und dem Fehlercode too-costly beantworten, wenn das vom Client gewählte Zeitfenster oder die Treffermenge zu groß ist und die Durchführhung der Suchanfrage das System unverhältnismäßig stark belasten würde. Weitere Details siehe FHIR-Kernspezifikation, Abschnitt _lastUpdated.

SHALLstatustoken

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

SHALLcategorytoken

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

SHALLcodetoken

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

SHALLpatientreference

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

SHALLdatedate

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

SHALLcode-value-conceptcomposite

Beispiel:
GET [base]/Observation?code-value-concept=http://loinc.org|72166-2$http://loinc.org|LA15920-4
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALLcode-value-datecomposite

Beispiel:
GET [base]/Observation?code-value-date=http://loinc.org|11779-6$2024-08-01
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALLcomponent-codetoken

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

SHALLencounterreference

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

MAY_hasstring

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.

MAY_tagtoken

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.

MAYsubjectreference

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

 
Core FHIR Resource
AllergyIntolerance
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

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.

SHALL_countnumber

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

SHALL_lastUpdateddate

Beispiel: Suche nach allen Patienten-Ressourcen, die seit dem 1. Januar neu angelegt oder geändert wurden:
GET [base]/Patient?_lastUpdated=ge2026-01-01
Beispiel: Suche nach allen Observations eines Patienten im Zeitraum einer Stunde:
GET [base]/Observation?_lastUpdated=ge2026-03-05T10:20:10.423+02:00&_lastUpdate=lt2026-03-05T11:20:10.423+02:00&patient=Patient/12345
Anwendungshinweis:
Dieser Suchparameter dient dem Datenabgleich zwischen Systemen und ist auch für die patientenübergreifende Suche zugelassen. Server können die Anfrage mit einer OperationOutcome-Ressource und dem Fehlercode too-costly beantworten, wenn das vom Client gewählte Zeitfenster oder die Treffermenge zu groß ist und die Durchführhung der Suchanfrage das System unverhältnismäßig stark belasten würde. Weitere Details siehe FHIR-Kernspezifikation, Abschnitt _lastUpdated.

SHALLclinical-statustoken

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

SHALLpatientreference

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

SHALLonsetdate

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

SHALLdatedate

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

SHALLcategorytoken

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

SHALLtypetoken

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

MAY_hasstring

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.

MAY_tagtoken

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.

 
Core FHIR Resource
Procedure
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

ISiKProzedur

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

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.

SHALL_countnumber

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

SHALL_lastUpdateddate

Beispiel: Suche nach allen Patienten-Ressourcen, die seit dem 1. Januar neu angelegt oder geändert wurden:
GET [base]/Patient?_lastUpdated=ge2026-01-01
Beispiel: Suche nach allen Observations eines Patienten im Zeitraum einer Stunde:
GET [base]/Observation?_lastUpdated=ge2026-03-05T10:20:10.423+02:00&_lastUpdate=lt2026-03-05T11:20:10.423+02:00&patient=Patient/12345
Anwendungshinweis:
Dieser Suchparameter dient dem Datenabgleich zwischen Systemen und ist auch für die patientenübergreifende Suche zugelassen. Server können die Anfrage mit einer OperationOutcome-Ressource und dem Fehlercode too-costly beantworten, wenn das vom Client gewählte Zeitfenster oder die Treffermenge zu groß ist und die Durchführhung der Suchanfrage das System unverhältnismäßig stark belasten würde. Weitere Details siehe FHIR-Kernspezifikation, Abschnitt _lastUpdated.

SHALLstatustoken

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

SHALLcategorytoken

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

SHALLcodetoken

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

SHALLpatientreference

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

SHALLencounterreference

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

SHALLdatedate

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

MAY_hasstring

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.

MAY_tagtoken

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.

MAYsubjectreference

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

 
Core FHIR Resource
Condition
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

ISiKDiagnose

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

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.

SHALL_countnumber

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

SHALL_lastUpdateddate

Beispiel: Suche nach allen Patienten-Ressourcen, die seit dem 1. Januar neu angelegt oder geändert wurden:
GET [base]/Patient?_lastUpdated=ge2026-01-01
Beispiel: Suche nach allen Observations eines Patienten im Zeitraum einer Stunde:
GET [base]/Observation?_lastUpdated=ge2026-03-05T10:20:10.423+02:00&_lastUpdate=lt2026-03-05T11:20:10.423+02:00&patient=Patient/12345
Anwendungshinweis:
Dieser Suchparameter dient dem Datenabgleich zwischen Systemen und ist auch für die patientenübergreifende Suche zugelassen. Server können die Anfrage mit einer OperationOutcome-Ressource und dem Fehlercode too-costly beantworten, wenn das vom Client gewählte Zeitfenster oder die Treffermenge zu groß ist und die Durchführhung der Suchanfrage das System unverhältnismäßig stark belasten würde. Weitere Details siehe FHIR-Kernspezifikation, Abschnitt _lastUpdated.

SHALLclinical-statustoken

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

SHALLpatientreference

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.

SHALLencounterreference

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

SHALLrecorded-datedate

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

SHALLrelatedreference

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

MAY_hasstring

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.

MAY_tagtoken

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.

MAYsubjectreference

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

MAYcategorytoken

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.

 
Core FHIR Resource
CodeSystem
Reference Policy
Interaction summary
  • MAY support read, search-type.

Supported Profiles

ISiKCodeSystem

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

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.

SHALL_countnumber

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

SHALL_lastUpdateddate

Beispiel: Suche nach allen Patienten-Ressourcen, die seit dem 1. Januar neu angelegt oder geändert wurden:
GET [base]/Patient?_lastUpdated=ge2026-01-01
Beispiel: Suche nach allen Observations eines Patienten im Zeitraum einer Stunde:
GET [base]/Observation?_lastUpdated=ge2026-03-05T10:20:10.423+02:00&_lastUpdate=lt2026-03-05T11:20:10.423+02:00&patient=Patient/12345
Anwendungshinweis:
Dieser Suchparameter dient dem Datenabgleich zwischen Systemen und ist auch für die patientenübergreifende Suche zugelassen. Server können die Anfrage mit einer OperationOutcome-Ressource und dem Fehlercode too-costly beantworten, wenn das vom Client gewählte Zeitfenster oder die Treffermenge zu groß ist und die Durchführhung der Suchanfrage das System unverhältnismäßig stark belasten würde. Weitere Details siehe FHIR-Kernspezifikation, Abschnitt _lastUpdated.

MAY_hasstring

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.

MAY_tagtoken

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.

MAYurluri

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

 
Core FHIR Resource
ValueSet
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

ISiKValueSet

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

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.

SHALL_countnumber

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

SHALL_lastUpdateddate

Beispiel: Suche nach allen Patienten-Ressourcen, die seit dem 1. Januar neu angelegt oder geändert wurden:
GET [base]/Patient?_lastUpdated=ge2026-01-01
Beispiel: Suche nach allen Observations eines Patienten im Zeitraum einer Stunde:
GET [base]/Observation?_lastUpdated=ge2026-03-05T10:20:10.423+02:00&_lastUpdate=lt2026-03-05T11:20:10.423+02:00&patient=Patient/12345
Anwendungshinweis:
Dieser Suchparameter dient dem Datenabgleich zwischen Systemen und ist auch für die patientenübergreifende Suche zugelassen. Server können die Anfrage mit einer OperationOutcome-Ressource und dem Fehlercode too-costly beantworten, wenn das vom Client gewählte Zeitfenster oder die Treffermenge zu groß ist und die Durchführhung der Suchanfrage das System unverhältnismäßig stark belasten würde. Weitere Details siehe FHIR-Kernspezifikation, Abschnitt _lastUpdated.

SHALLurluri

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

SHALLnamestring

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

SHALLstatustoken

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

SHALLversiontoken

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

MAY_hasstring

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.

MAY_tagtoken

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.

MAYcontext-type-valuecomposite

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.

 
Core FHIR Resource
Coverage
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

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.

SHALL_countnumber

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

SHALL_lastUpdateddate

Beispiel: Suche nach allen Patienten-Ressourcen, die seit dem 1. Januar neu angelegt oder geändert wurden:
GET [base]/Patient?_lastUpdated=ge2026-01-01
Beispiel: Suche nach allen Observations eines Patienten im Zeitraum einer Stunde:
GET [base]/Observation?_lastUpdated=ge2026-03-05T10:20:10.423+02:00&_lastUpdate=lt2026-03-05T11:20:10.423+02:00&patient=Patient/12345
Anwendungshinweis:
Dieser Suchparameter dient dem Datenabgleich zwischen Systemen und ist auch für die patientenübergreifende Suche zugelassen. Server können die Anfrage mit einer OperationOutcome-Ressource und dem Fehlercode too-costly beantworten, wenn das vom Client gewählte Zeitfenster oder die Treffermenge zu groß ist und die Durchführhung der Suchanfrage das System unverhältnismäßig stark belasten würde. Weitere Details siehe FHIR-Kernspezifikation, Abschnitt _lastUpdated.

SHALLstatustoken

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

SHALLtypetoken

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

SHALLbeneficiaryreference

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

SHALLpayorreference

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

MAY_hasstring

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.

MAY_tagtoken

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.

MAYsubscriberreference

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

 
Core FHIR Resource
RelatedPerson
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

ISiKAngehoeriger

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

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.

SHALL_countnumber

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

SHALL_lastUpdateddate

Beispiel: Suche nach allen Patienten-Ressourcen, die seit dem 1. Januar neu angelegt oder geändert wurden:
GET [base]/Patient?_lastUpdated=ge2026-01-01
Beispiel: Suche nach allen Observations eines Patienten im Zeitraum einer Stunde:
GET [base]/Observation?_lastUpdated=ge2026-03-05T10:20:10.423+02:00&_lastUpdate=lt2026-03-05T11:20:10.423+02:00&patient=Patient/12345
Anwendungshinweis:
Dieser Suchparameter dient dem Datenabgleich zwischen Systemen und ist auch für die patientenübergreifende Suche zugelassen. Server können die Anfrage mit einer OperationOutcome-Ressource und dem Fehlercode too-costly beantworten, wenn das vom Client gewählte Zeitfenster oder die Treffermenge zu groß ist und die Durchführhung der Suchanfrage das System unverhältnismäßig stark belasten würde. Weitere Details siehe FHIR-Kernspezifikation, Abschnitt _lastUpdated.

SHALLpatientreference

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

MAY_hasstring

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.

MAY_tagtoken

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.

MAYnamestring

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

MAYaddressstring

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

MAYaddress-citystring

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

MAYaddress-countrystring

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

MAYaddress-postalcodestring

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

 
Core FHIR Resource
Account
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

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.

SHALL_countnumber

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

SHALL_lastUpdateddate

Beispiel: Suche nach allen Patienten-Ressourcen, die seit dem 1. Januar neu angelegt oder geändert wurden:
GET [base]/Patient?_lastUpdated=ge2026-01-01
Beispiel: Suche nach allen Observations eines Patienten im Zeitraum einer Stunde:
GET [base]/Observation?_lastUpdated=ge2026-03-05T10:20:10.423+02:00&_lastUpdate=lt2026-03-05T11:20:10.423+02:00&patient=Patient/12345
Anwendungshinweis:
Dieser Suchparameter dient dem Datenabgleich zwischen Systemen und ist auch für die patientenübergreifende Suche zugelassen. Server können die Anfrage mit einer OperationOutcome-Ressource und dem Fehlercode too-costly beantworten, wenn das vom Client gewählte Zeitfenster oder die Treffermenge zu groß ist und die Durchführhung der Suchanfrage das System unverhältnismäßig stark belasten würde. Weitere Details siehe FHIR-Kernspezifikation, Abschnitt _lastUpdated.

SHALLidentifiertoken

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

SHALLstatustoken

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

SHALLtypetoken

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

SHALLpatientreference

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

MAY_hasstring

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.

MAY_tagtoken

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.

 
Core FHIR Resource
Device
Reference Policy
Interaction summary
  • MAY support
    read

    Sofern die Ressource Device unterstützt wird, KANN die REST-Interaktion read implementiert werden.

    search-type

    Sofern die Ressource Device unterstützt wird, KANN die REST-Interaktion search implementiert werden.

Supported Profiles

ISiKImplantat

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

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.

SHALL_countnumber

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

SHALL_lastUpdateddate

Beispiel: Suche nach allen Patienten-Ressourcen, die seit dem 1. Januar neu angelegt oder geändert wurden:
GET [base]/Patient?_lastUpdated=ge2026-01-01
Beispiel: Suche nach allen Observations eines Patienten im Zeitraum einer Stunde:
GET [base]/Observation?_lastUpdated=ge2026-03-05T10:20:10.423+02:00&_lastUpdate=lt2026-03-05T11:20:10.423+02:00&patient=Patient/12345
Anwendungshinweis:
Dieser Suchparameter dient dem Datenabgleich zwischen Systemen und ist auch für die patientenübergreifende Suche zugelassen. Server können die Anfrage mit einer OperationOutcome-Ressource und dem Fehlercode too-costly beantworten, wenn das vom Client gewählte Zeitfenster oder die Treffermenge zu groß ist und die Durchführhung der Suchanfrage das System unverhältnismäßig stark belasten würde. Weitere Details siehe FHIR-Kernspezifikation, Abschnitt _lastUpdated.

SHALLstatustoken

Beispiel:
GET [base]/Device?status=active GET [base]/Device?status=inactive GET [base]/Device?status=entered-in-error
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALLtypetoken

Beispiel:
GET [base]/Device?type=http://snomed.info/sct|14106009
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALLpatientreference

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

MAY_hasstring

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.

MAY_tagtoken

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.