Implementierungsleitfaden ISiK-Basismodul

CapabilityStatement für Rolle "ISiKCapabilityStatementVersicherungsverhaeltnisRolle" - 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 "ISiKCapabilityStatementVersicherungsverhaeltnisRolle". Diese Rolle beschreibt verpflichtende Interaktionen zum Abruf von ISiKVersicherungsverhaeltnis-Ressourcen.

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

Anforderungen an die FHIR-API

Modus	server

Interaktionen

Ressourcentyp	Verbindlichkeit	READ	SEARCH
Account	SHALL	SHALL	SHALL
Coverage	SHALL	SHALL	SHALL
RelatedPerson	SHALL	SHALL	SHALL

Profile

Ressourcentyp	Profile
Account	https://gematik.de/fhir/isik/StructureDefinition/ISiKAbrechnungsfall
Coverage	https://gematik.de/fhir/isik/StructureDefinition/ISiKVersicherungsverhaeltnisGesetzlich
Coverage	https://gematik.de/fhir/isik/StructureDefinition/ISiKVersicherungsverhaeltnisSelbstzahler
Coverage	https://gematik.de/fhir/isik/StructureDefinition/ISiKVersicherungsverhaeltnisSonstige
RelatedPerson	https://gematik.de/fhir/isik/StructureDefinition/ISiKAngehoeriger

Ressourcentyp-spezifische Operations

Globale Operations

Dokumenten-Endpunkt

Suchparameter

RessourcenTyp	SuchParameter	Verbindlichkeit	Hinweise	Definition
Coverage	_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
Coverage	_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
Coverage	_count	SHALL	Beispiel: `GET [base]/[Resourcetype]?_count=100` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.
Coverage	_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.
Coverage	status	SHALL	Beispiel: `GET [base]/Coverage?status=active` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/Coverage-status
Coverage	type	SHALL	Beispiel: `GET [base]/Coverage?type=http://fhir.de/CodeSystem/versicherungsart-de-basis\|GKV` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/Coverage-type
Coverage	beneficiary	SHALL	Beispiel: `GET [base]/Coverage?beneficiary=Patient/123` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/Coverage-beneficiary
Coverage	payor	SHALL	Beispiel: `GET [base]/Coverage?payor:identifier=0123456789` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/Coverage-payor
Coverage	subscriber	MAY	Beispiel: `GET [base]/Coverage?subscriber=Patient/123` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/Coverage-subscriber
RelatedPerson	_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
RelatedPerson	_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
RelatedPerson	_count	SHALL	Beispiel: `GET [base]/[Resourcetype]?_count=100` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.
RelatedPerson	_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.
RelatedPerson	patient	SHALL	Beispiel: `GET [base]/RelatedPerson?patient=Patient/123` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/RelatedPerson-patient
RelatedPerson	name	MAY	Beispiel: `GET [base]/RelatedPerson?name=Heidi` `GET [base]/RelatedPerson?name=Alpenzauber` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/RelatedPerson-name
RelatedPerson	address	MAY	Beispiel: `GET [base]/RelatedPerson?address=Berlin` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/individual-address
RelatedPerson	address-city	MAY	Beispiel: `GET [base]/RelatedPerson?address-city=Berlin` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/individual-address-city
RelatedPerson	address-country	MAY	Beispiel: `GET [base]/RelatedPerson?address-country=DE` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/individual-address-country
RelatedPerson	address-postalcode	MAY	Beispiel: `GET [base]/RelatedPerson?address-postalcode=10117` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/individual-address-postalcode
Account	_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
Account	_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
Account	_count	SHALL	Beispiel: `GET [base]/[Resourcetype]?_count=100` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.
Account	_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.
Account	identifier	SHALL	Beispiel: `GET [base]/Account?identifier=http://test.krankenhaus.de/fhir/sid/fallnr\|123456` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/clinical-identifier
Account	status	SHALL	Beispiel: `GET [base]/Account?status=active` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/Account-status
Account	type	SHALL	Beispiel: `GET [base]/Account?type=http://terminology.hl7.org/CodeSystem/v3-ActCode\|AMB` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/clinical-type
Account	patient	SHALL	Beispiel: `GET [base]/Account?patient=Patient/123` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/clinical-patient

(Reverse-)Include

RessourcenTyp	Include
Coverage	Coverage:subscriber (MAY); Coverage:patient (SHALL); Coverage:payor (MAY); Coverage:beneficiary (MAY)
RelatedPerson	RelatedPerson:patient (SHALL)
Account