Implementierungsleitfaden ISiK-Basismodul

CapabilityStatement für Rolle "StammdatenRolle" - Konformitätserklärung (CapabilityStatement)

Beschreibung

Beschreibung
Dieses CapabilityStatement beschreibt alle Interaktionen, die ein System unterstützen MUSS, welches diese Rolle implementiert. Die CapabilityStatements in dieser Spezifikation stellen die Anforderungen seitens der gematik dar (`kind = requirements`). Zur Unterscheidung von Anforderungen, die erfüllt werden MÜSSEN gegenüber jenen, die erfüllt werden KÖNNEN, wird die CapabilityStatement-Expectation-Extension mit den möglichen Werten `SHALL` (=MUSS) und `MAY` (=KANN) verwendet.

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

Die CapabilityStatements in dieser Spezifikation stellen die Anforderungen seitens der gematik dar (kind = requirements). Zur Unterscheidung von Anforderungen, die erfüllt werden MÜSSEN gegenüber jenen, die erfüllt werden KÖNNEN, wird die CapabilityStatement-Expectation-Extension mit den möglichen Werten SHALL (=MUSS) und MAY (=KANN) verwendet.

Zweck
CapabilityStatement für die Rolle "ISiKCapabilityStatementStammdatenRolle". Diese Rolle beschreibt Interaktionen zum Abruf und der Verarbeitung grundlegender Stammdaten.

CanonicalURL	https://gematik.de/fhir/isik/CapabilityStatement/ISiKCapabilityStatementStammdatenRolle
Intention	requirements
Status	active
Version	5.0.0-rc2

Anforderungen an die FHIR-API

Modus	server

Interaktionen

Ressourcentyp	Verbindlichkeit	READ	SEARCH
Encounter	SHALL	SHALL	SHALL
Patient	SHALL	SHALL	SHALL

Profile

Ressourcentyp	Profile
Encounter	https://gematik.de/fhir/isik/StructureDefinition/ISiKKontaktGesundheitseinrichtung
Patient	https://gematik.de/fhir/isik/StructureDefinition/ISiKPatient

Ressourcentyp-spezifische Operations

Globale Operations

Dokumenten-Endpunkt

Suchparameter

RessourcenTyp	SuchParameter	Verbindlichkeit	Hinweise	Definition
Patient	_id	SHALL	Beispiel: `GET [base]/[Resourcetype]?_id=103270` Anwendungshinweis: Der Parameter `_id` wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der `id` die `READ`-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem `_include` weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten: `GET [base]/Encounter?_id=103270&_include=Encounter:patient` Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources. Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.	http://hl7.org/fhir/SearchParameter/Resource-id
Patient	_tag	SHALL	Beispiel: `GET [base]/[Resourcetype]?_tag=https://example.org/codes\|needs-review` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.	http://hl7.org/fhir/SearchParameter/Resource-tag
Patient	_count	SHALL	Beispiel: `GET [base]/[Resourcetype]?_count=100` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.
Patient	_has	MAY	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.
Patient	identifier	SHALL	Beispiel: `GET [base]/Patient?identifier=http://fhir.krankenhaus.example\|1032702` `GET [base]/Patient?identifier=1032702` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.	http://hl7.org/fhir/SearchParameter/Patient-identifier
Patient	family	SHALL	Beispiel: `GET [base]/Patient?family=Musterfrau` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.	http://hl7.org/fhir/SearchParameter/individual-family
Patient	given	SHALL	Beispiel: `GET [base]/Patient?given=Erika` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.	http://hl7.org/fhir/SearchParameter/individual-given
Patient	birthdate	SHALL	Beispiel: `GET [base]/Patient?birthdate=1964-12-08` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/individual-birthdate
Patient	gender	SHALL	Beispiel: `GET [base]/Patient?birthdate=1964-12-08` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.	http://hl7.org/fhir/SearchParameter/individual-gender
Encounter	_id	SHALL	Beispiel: `GET [base]/[Resourcetype]?_id=103270` Anwendungshinweis: Der Parameter `_id` wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der `id` die `READ`-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem `_include` weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten: `GET [base]/Encounter?_id=103270&_include=Encounter:patient` Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources. Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.	http://hl7.org/fhir/SearchParameter/Resource-id
Encounter	_tag	SHALL	Beispiel: `GET [base]/[Resourcetype]?_tag=https://example.org/codes\|needs-review` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.	http://hl7.org/fhir/SearchParameter/Resource-tag
Encounter	_count	SHALL	Beispiel: `GET [base]/[Resourcetype]?_count=100` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.
Encounter	_has	MAY	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.
Encounter	identifier	SHALL	Beispiel: `GET [base]/Encounter?identifier=http://test.krankenhaus.de/fhir/sid/fallnr\|123456` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/clinical-identifier
Encounter	status	SHALL	Beispiel: `GET [base]/Encounter?status=finished` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/Encounter-status
Encounter	class	SHALL	Beispiel: `GET [base]/Encounter?class=IMP` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/Encounter-class
Encounter	type	SHALL	Beispiel: `GET [base]/Encounter?type=http://fhir.de/CodeSystem/kontaktart-de\|stationaer` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/clinical-type
Encounter	patient	SHALL	Beispiel: `GET [base]/Encounter?patient=Patient/123` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Dieser Suchparameter ist für die Umsetzung des IHE QEDm Profils verpflichtend.	http://hl7.org/fhir/SearchParameter/clinical-patient
Encounter	account	SHALL	Beispiel: `GET [base]/Encounter?account=Account/123` `GET [base]/Encounter?account:identifier=123456` `GET [base]/Encounter?account:identifier=https://example.org/fhir/sid/abrechnungsfallnr\|123456` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/Encounter-account
Encounter	date	SHALL	Beispiel: `GET [base]/Encounter?date=lt2020-26-10` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Bei der Formulierung der Suche sollten die Vorgaben aus der Definition der Such-Prefixe - und hier insbesondere die Unterschiede zwischen `lt` und `eb` bzw. `gt` und `sa` - beachtet werden.	http://hl7.org/fhir/SearchParameter/clinical-date
Encounter	date-start	SHALL	Beispiel: `GET [base]/Encounter?end-date=lt2020-26-10` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Bei diesem Suchparameter handelt es sich um eine Präadoption eines Suchparameters, der in FHIR R5 hinzugefügt wurde.	https://gematik.de/fhir/isik/SearchParameter/Encounter-date-start
Encounter	end-date	SHALL	Beispiel: `GET [base]/Encounter?end-date=lt2020-26-10` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Bei diesem Suchparameter handelt es sich um eine Präadoption eines Suchparameters, der in FHIR R5 hinzugefügt wurde.	https://gematik.de/fhir/isik/SearchParameter/Encounter-end-date

(Reverse-)Include

RessourcenTyp	Include
Patient
Encounter	Encounter:patient (SHALL)