Implementierungsleitfaden ISiK-Basismodul

CapabilityStatement für Rolle "ISiKCapabilityStatementGesundheitsstatusRolle" - 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 "ISiKCapabilityStatementGesundheitsstatusRolle". Diese Rolle beschreibt verpflichtende Interaktionen zum Abruf und der Verarbeitung von ISiKObservation-Ressourcen.

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

Anforderungen an die FHIR-API

Modus	server

Interaktionen

Ressourcentyp	Verbindlichkeit	READ	SEARCH
AllergyIntolerance	SHALL	SHALL	SHALL
Observation	SHALL	SHALL	SHALL

Profile

Ressourcentyp	Profile	Verbindlichkeit
AllergyIntolerance	https://gematik.de/fhir/isik/StructureDefinition/ISiKAllergieUnvertraeglichkeit	SHALL
Observation	https://gematik.de/fhir/isik/StructureDefinition/ISiKLebensZustand	SHALL
Observation	https://gematik.de/fhir/isik/StructureDefinition/ISiKSchwangerschaftsstatus	SHALL
Observation	https://gematik.de/fhir/isik/StructureDefinition/ISiKSchwangerschaftErwarteterEntbindungstermin	SHALL
Observation	https://gematik.de/fhir/isik/StructureDefinition/ISiKAlkoholAbusus	SHALL
Observation	https://gematik.de/fhir/isik/StructureDefinition/ISiKRaucherStatus	SHALL
Observation	https://gematik.de/fhir/isik/StructureDefinition/ISiKStillstatus	SHALL

Ressourcentyp-spezifische Operations

Globale Operations

Dokumenten-Endpunkt

Suchparameter

RessourcenTyp	SuchParameter	Verbindlichkeit	Hinweise	Definition
Observation	_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
Observation	_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
Observation	_count	SHALL	Beispiel: `GET [base]/[Resourcetype]?_count=100` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.
Observation	_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.
Observation	status	SHALL	Beispiel: `GET [base]/Observation?status=http://hl7.org/fhir/observation-status\|final` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/Observation-status
Observation	category	SHALL	Beispiel: `GET [base]/Observation?category=http://terminology.hl7.org/CodeSystem/observation-category\|social-history` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/Observation-category
Observation	code	SHALL	Beispiel: `GET [base]/Observation?code=http://loinc.org\|82810-3` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/clinical-code
Observation	patient	SHALL	Beispiel: `GET [base]/Observation?patient=Patient/123` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/clinical-patient
Observation	subject	MAY	Beispiel: `GET [base]/Observation?subject=Patient/123` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/Observation-subject
Observation	date	SHALL	Beispiel: `GET [base]/Observation?date=ge2013-01-14&date=le2021-12-31` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/clinical-date
Observation	combo-code	SHALL	Beispiel: `GET [base]/Observation?combo-code=85354-9` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/Observation-combo-code
Observation	combo-code-value-quantity	SHALL	Beispiel: `GET [base]/Observation?combo-code-value-quantity=http://loinc.org\|8480-6$120\|http://unitsofmeasure.org\|mm[Hg]` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/Observation-combo-code-value-quantity
Observation	component-code	SHALL	Beispiel: `GET [base]/Observation?component-code=http://loinc.org\|85354-9` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/Observation-component-code
Observation	encounter	SHALL	Beispiel: `GET [base]/Observation?encounter=Encounter/234` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/clinical-encounter
AllergyIntolerance	_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
AllergyIntolerance	_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
AllergyIntolerance	_count	SHALL	Beispiel: `GET [base]/[Resourcetype]?_count=100` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.
AllergyIntolerance	_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.
AllergyIntolerance	clinical-status	SHALL	Beispiel: `GET [base]/AllergyIntolerance?clinical-status=active` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status
AllergyIntolerance	patient	SHALL	Beispiel: `GET [base]/AllergyIntolerance?patient=Patient/123` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/clinical-patient
AllergyIntolerance	onset	SHALL	Beispiel: `GET [base]/AllergyIntolerance?onset=2015-01-01T12:00:23Z+02:00` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/AllergyIntolerance-onset
AllergyIntolerance	date	SHALL	Beispiel: `GET [base]/AllergyIntolerance?date=2015-01-01T12:00:23Z+02:00` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/conformance-date
AllergyIntolerance	category	SHALL	Beispiel: `GET [base]/AllergyIntolerance?category=environment` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/AllergyIntolerance-category
AllergyIntolerance	type	SHALL	Beispiel: `GET [base]/AllergyIntolerance?type=allergy` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.	http://hl7.org/fhir/SearchParameter/clinical-type

(Reverse-)Include

RessourcenTyp	Include
Observation	Observation:encounter (SHALL); Observation:patient (SHALL); Observation:subject (MAY)
AllergyIntolerance	AllergyIntolerance:patient (SHALL); AllergyIntolerance:encounter (SHALL); AllergyIntolerance:recorder (MAY); AllergyIntolerance:asserter (MAY)