ISiK Formularmodul Implementation Guide
Version 6.0.0-rc - ci-build

CapabilityStatement: Akteur "ISiKCapabilityStatementFormularDatenQuelleAkteur" (Expanded)

Official URL: https://gematik.de/fhir/isik/CapabilityStatement/ISiKCapabilityStatementFormularDatenQuelleAkteur Version: 6.0.0-rc
Active as of 2025-12-17 Computable Name: ISiK-CapabilityStatementFormularDatenQuelleAkteurExpanded

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 "ISiKCapabilityStatementFormularDatenQuelleAkteur". Dieser Akteur aggregiert die Rollen zur Abfrage von ausgefüllten Formularen, zur Datenbereitstellung für die Formularvorbelegung und zur Rückübermittlung von aus Formularen extrahierten Daten. Verpflichtend ist in diesem Kontext nur die Rolle "FormularDatenQuelleRolle" und "CompositionKonsumentenRolle", die weiteren Rollen sind optional, da sie ggf. auch von anderen Akteuren bereitgestellt werden können.

Akteur "ISiKCapabilityStatementFormularDatenQuelleAkteur" (Expanded)

  • Implementation Guide Version: 6.0.0-rc
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Published on: 2025-12-17
  • 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-Formularmodul

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
QuestionnaireResponseSupported Profiles
  Ausgefülltes ISiK-Formular		YY_id, _tag, _count, _has, identifier, questionnaire, status, patient, authored
PatientSupported Profiles
  ISiKPatient		YY_id, _tag, _count, _has, identifier, family, given, birthdate, gender
EncounterSupported Profiles
  ISiKKontaktGesundheitseinrichtung		YY_id, _tag, _count, _has, identifier, status, class, type, patient, account, date, date-start, end-dateEncounter:patient
ObservationSupported Profiles
  ISiKLebensZustand
  ISiK Schwangerschaftsstatus
  ISiK Schwangerschaft - Erwarteter Entbindungstermin
  ISiK Alkohol Abusus
  ISiK Raucherstatus
  ISiKStillstatus
  ISiKKoerpergewicht
  ISiKKoerpergroesse
  ISiKAtemfrequenz
  ISiKBlutdruckSystemischArteriell
  ISiKHerzfrequenz
  ISiKKoerpertemperatur
  ISiKKopfumfang
  ISiKSauerstoffsaettigungArteriell
  ISiKGCS
  ISiKEKG
  ISiKLaboruntersuchungSerumkreatinin
  ISiKLaboruntersuchungPCT
  ISiKLaboruntersuchungCRP
  ISiKLaboruntersuchungHb
  ISiKLaboruntersuchungTroponin
  ISiKLaboruntersuchungGFR
  ISiKLaboruntersuchungThrombozyten
  ISiKLaboruntersuchungTSH
  SD MII ICU Pulmonalarterieller Wedge Druck
  SD MII ICU Sauerstoffsaettigung Im Blut Preduktal Durch Pulsoxymetrie
  SD MII ICU Sauerstoffsaettigung Im Blut Postduktal Durch Pulsoxymetrie
  SD MII ICU Linksventrikulaeres Schlagvolumenindex
  SD MII ICU Linksventrikulaerer Schlagvolumenindex Durch Indikatorverduennung
  SD MII ICU Linksventrikulaeres Schlagvolumen
  SD MII ICU Linksventrikulaeres Schlagvolumen Durch Indikatorverduennung
  SD MII ICU Pulmonalvaskulaerer Widerstandsindex
  SD MII ICU Systemischer Vaskulaerer Widerstandsindex
  SD MII ICU Linksventrikulaerer Herzindex
  SD MII ICU Herzzeitvolumen
  SD MII ICU Linksventrikulaerer Herzindex durch Indikatorverduennung
  SD MII ICU Linksventrikulaeres Herzzeitvolumen Durch Indikatorverduennung
  SD MII ICU Zentralvenoeser Blutdruck
  SD MII ICU Linksatrialer Druck
  SD MII ICU Rechtsatrialer Druck
  SD MII ICU Rechtsventrikulaerer Druck
  SD MII ICU Linksventrikulaerer Druck
  SD MII ICU Pulmonalarterieller Blutdruck
  SD MII ICU Koerpertemperatur Brustwirbelsaeule
  SD MII ICU Koerpertemperatur Lendenwirbelsaeule
  SD MII ICU Koerpertemperatur Halswirbelsaeule
  SD MII ICU Koerpertemperatur Brust
  SD MII ICU Koerpertemperatur Myokard
  SD MII ICU Koerpertemperatur Atemwege
  SD MII ICU Koerpertemperatur Blut
  SD MII ICU Koerpertemperatur Nasen-Rachen-Raum
  SD MII ICU Koerpertemperatur Speiseroehre
  SD MII ICU Intrakranieller Druck ICP
  SD MII ICU Koerpergewicht Percentil Altersabhaengig
  SD MII ICU Koerpergroesse Percentil
  SD MII ICU Ideales Koerpergewicht
  SD MII ICU Sauerstoffsaettigung Im Arteriellen Blut Durch Pulsoxymetrie
  SD MII ICU Puls
  SD MII ICU Koerpertemperatur Kern
  SD MII ICU Koerpertemperatur Gelenk
  SD MII ICU Koerpertemperatur Stirn
  SD MII ICU Koerpertemperatur nasal
  SD MII ICU Koerpertemperatur Leiste
  SD MII ICU Koerpertemperatur Achsel
  SD MII ICU Koerpertemperatur unter der Zunge
  SD MII ICU Koerpertemperatur vaginal
  SD MII ICU Koerpertemperatur Harnblase
  SD MII ICU Koerpertemperatur rektal
  SD MII ICU Koerpertemperatur Trommelfell		YY_id, _tag, _count, _has, status, category, code, patient, subject, date, combo-code, combo-code-value-quantity, component-code, encounterObservation:encounter, Observation:patient, Observation:subject
AllergyIntoleranceSupported Profiles
  ISiKAllergieUnvertraeglichkeit		YY_id, _tag, _count, _has, clinical-status, patient, onset, date, category, typeAllergyIntolerance:patient, AllergyIntolerance:encounter, AllergyIntolerance:recorder, AllergyIntolerance:asserter
RiskAssessmentSupported Profiles
  ISiK AMTS-Bewertung		YYYY_id, date, encounter, patient, riskRiskAssessment:condition, RiskAssessment:encounter, RiskAssessment:patient
ProcedureSupported Profiles
  ISiKProzedur		YY_id, _tag, _count, _has, status, category, code, patient, subject, encounter, dateProcedure:patient, Procedure:subject, Procedure:encounterEncounter:diagnosis
ConditionSupported Profiles
  ISiKDiagnose		YY_id, _tag, _count, _has, clinical-status, patient, subject, encounter, recorded-date, related, categoryCondition:patient, Condition:subject, Condition:encounterEncounter:diagnosis
Core FHIR Resource
QuestionnaireResponse
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

Ausgefülltes ISiK-Formular

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_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.

SHALL_countnumber

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

SHALLidentifiertoken

Beispiel:
GET [base]/QuestionnaireResponse?identifier=http://example.org/fhir/sid/response|qr-001
Anwendungshinweis:
Eindeutige Identifizierungsnummer für die Formularantwort. Weitere Details siehe FHIR-Kernspezifikation.

SHALLquestionnairereference

Beispiel:
GET [base]/QuestionnaireResponse?questionnaire=Questionnaire/ISiKFormularDefinition
Anwendungshinweis:
Verweis auf die zugrunde liegende Formulardefinition. Weitere Details siehe FHIR-Kernspezifikation.

SHALLstatustoken

Beispiel:
GET [base]/QuestionnaireResponse?status=completed
GET [base]/QuestionnaireResponse?status=in-progress
Anwendungshinweis:
Gültige Werte: in-progress | completed | amended | entered-in-error | stopped. Weitere Details siehe FHIR-Kernspezifikation.

SHALLpatientreference

Beispiel:
GET [base]/QuestionnaireResponse?patient=Patient/12345
Anwendungshinweis:
Der Patient, für den das Formular ausgefüllt wurde. Weitere Details siehe FHIR-Kernspezifikation.

SHALLauthoreddate

Beispiel:
GET [base]/QuestionnaireResponse?authored=2024-01-15
GET [base]/QuestionnaireResponse?authored=ge2024-01-01&authored=le2024-12-31
Anwendungshinweis:
Zeitstempel wann die Formularantwort zuletzt bearbeitet wurde. 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.

 
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_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.

SHALL_countnumber

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

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.

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.

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

Supported Profiles

ISiKKontaktGesundheitseinrichtung

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_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.

SHALL_countnumber

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

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.

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.

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

Supported Profiles

ISiKLebensZustand
ISiK Schwangerschaftsstatus
ISiK Schwangerschaft - Erwarteter Entbindungstermin
ISiK Alkohol Abusus
ISiK Raucherstatus
ISiKStillstatus
ISiKKoerpergewicht
ISiKKoerpergroesse
ISiKAtemfrequenz
ISiKBlutdruckSystemischArteriell
ISiKHerzfrequenz
ISiKKoerpertemperatur
ISiKKopfumfang
ISiKSauerstoffsaettigungArteriell
ISiKGCS
ISiKEKG
ISiKLaboruntersuchungSerumkreatinin
ISiKLaboruntersuchungPCT
ISiKLaboruntersuchungCRP
ISiKLaboruntersuchungHb
ISiKLaboruntersuchungTroponin
ISiKLaboruntersuchungGFR
ISiKLaboruntersuchungThrombozyten
ISiKLaboruntersuchungTSH
SD MII ICU Pulmonalarterieller Wedge Druck
SD MII ICU Sauerstoffsaettigung Im Blut Preduktal Durch Pulsoxymetrie
SD MII ICU Sauerstoffsaettigung Im Blut Postduktal Durch Pulsoxymetrie
SD MII ICU Linksventrikulaeres Schlagvolumenindex
SD MII ICU Linksventrikulaerer Schlagvolumenindex Durch Indikatorverduennung
SD MII ICU Linksventrikulaeres Schlagvolumen
SD MII ICU Linksventrikulaeres Schlagvolumen Durch Indikatorverduennung
SD MII ICU Pulmonalvaskulaerer Widerstandsindex
SD MII ICU Systemischer Vaskulaerer Widerstandsindex
SD MII ICU Linksventrikulaerer Herzindex
SD MII ICU Herzzeitvolumen
SD MII ICU Linksventrikulaerer Herzindex durch Indikatorverduennung
SD MII ICU Linksventrikulaeres Herzzeitvolumen Durch Indikatorverduennung
SD MII ICU Zentralvenoeser Blutdruck
SD MII ICU Linksatrialer Druck
SD MII ICU Rechtsatrialer Druck
SD MII ICU Rechtsventrikulaerer Druck
SD MII ICU Linksventrikulaerer Druck
SD MII ICU Pulmonalarterieller Blutdruck
SD MII ICU Koerpertemperatur Brustwirbelsaeule
SD MII ICU Koerpertemperatur Lendenwirbelsaeule
SD MII ICU Koerpertemperatur Halswirbelsaeule
SD MII ICU Koerpertemperatur Brust
SD MII ICU Koerpertemperatur Myokard
SD MII ICU Koerpertemperatur Atemwege
SD MII ICU Koerpertemperatur Blut
SD MII ICU Koerpertemperatur Nasen-Rachen-Raum
SD MII ICU Koerpertemperatur Speiseroehre
SD MII ICU Intrakranieller Druck ICP
SD MII ICU Koerpergewicht Percentil Altersabhaengig
SD MII ICU Koerpergroesse Percentil
SD MII ICU Ideales Koerpergewicht
SD MII ICU Sauerstoffsaettigung Im Arteriellen Blut Durch Pulsoxymetrie
SD MII ICU Puls
SD MII ICU Koerpertemperatur Kern
SD MII ICU Koerpertemperatur Gelenk
SD MII ICU Koerpertemperatur Stirn
SD MII ICU Koerpertemperatur nasal
SD MII ICU Koerpertemperatur Leiste
SD MII ICU Koerpertemperatur Achsel
SD MII ICU Koerpertemperatur unter der Zunge
SD MII ICU Koerpertemperatur vaginal
SD MII ICU Koerpertemperatur Harnblase
SD MII ICU Koerpertemperatur rektal
SD MII ICU Koerpertemperatur Trommelfell

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_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.

SHALL_countnumber

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

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.

SHALLcombo-codetoken

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

SHALLcombo-code-value-quantitycomposite

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.

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.

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.

Supported Profiles

ISiKAllergieUnvertraeglichkeit

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_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.

SHALL_countnumber

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

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.

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

Supported Profiles

ISiK AMTS-Bewertung

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Beispiel:
GET [base]/RiskAssessment?_id=103270

    **Anwendungshinweise:** Weitere Informationen zur Suche nach '_id' finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Parameters for all resources'](https://hl7.org/fhir/R4/search.html#all).
SHALLdatedate

Beispiel:
GET [base]/RiskAssessment?date=2022-03-21

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Date-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Date'](https://hl7.org/fhir/R4/search.html#date).
SHALLencounterreference

Beispiel:
GET [base]/RiskAssessment?encounter=Encounter/123

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Reference-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Reference Search'](https://www.hl7.org/fhir/R4/search.html#reference).
SHALLpatientreference

Beispiel:
GET [base]/RiskAssessment?patient=Patient/123

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Reference-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Reference Search'](https://www.hl7.org/fhir/R4/search.html#reference).
SHALLrisktoken

Beispiel:
GET [base]/RiskAssessment?risk=http://terminology.hl7.org/CodeSystem/risk-probability|high

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Token-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Token Search'](https://hl7.org/fhir/R4/search.html#token).
 
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_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.

SHALL_countnumber

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

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.

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_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.

SHALL_countnumber

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

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.

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.