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

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.

Zweck

CapabilityStatement für die Rolle "ISiKCapabilityStatementAufbaustrukturRolle". Diese Rolle stellt Interaktionen zur Abfrage von Informationen zur Aufbaustruktur bereit. Die Aufbaustruktur umfasst die Organisationseinheiten, Standorte und deren Zuordnungen.

CanonicalURLhttps://gematik.de/fhir/isik/CapabilityStatement/ISiKCapabilityStatementAufbaustrukturRolle
Intentionrequirements
Statusactive
Version5.0.0-rc

Anforderungen an die FHIR-API

Modusserver

Interaktionen

RessourcentypVerbindlichkeitREADSEARCHUPDATE
LocationMAYSHOULDSHOULDSHOULD
OrganizationMAYSHOULDSHOULD

Profile

RessourcentypProfileVerbindlichkeit
Locationhttps://gematik.de/fhir/isik/StructureDefinition/ISiKStandortMAY
Locationhttps://gematik.de/fhir/isik/StructureDefinition/ISiKStandortRaumMAY
Locationhttps://gematik.de/fhir/isik/StructureDefinition/ISiKStandortBettenstellplatzMAY
Organizationhttps://gematik.de/fhir/isik/StructureDefinition/ISiKOrganisationMAY
Organizationhttps://gematik.de/fhir/isik/StructureDefinition/ISiKOrganisationFachabteilungMAY

Ressourcentyp-spezifische Operations

Globale Operations

Dokumenten-Endpunkt

Suchparameter

RessourcenTypSuchParameterVerbindlichkeitHinweiseDefinition
Organization_idSHALL

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
Organization_tagSHALL

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
Organization_countSHALL

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

Organization_hasMAY

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.

OrganizationidentifierSHALL

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.

http://hl7.org/fhir/SearchParameter/Organization-identifier
OrganizationactiveSHALL

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.

http://hl7.org/fhir/SearchParameter/Organization-active
OrganizationtypeSHALL

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

http://hl7.org/fhir/SearchParameter/Organization-type
OrganizationnameSHALL

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

http://hl7.org/fhir/SearchParameter/Organization-name
OrganizationaddressMAY

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

http://hl7.org/fhir/SearchParameter/Organization-address
OrganizationpartofSHALL

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

http://hl7.org/fhir/SearchParameter/Organization-partof
OrganizationendpointMAY

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

http://hl7.org/fhir/SearchParameter/Organization-endpoint
Location_idSHALL

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
Location_tagSHALL

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
Location_countSHALL

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

Location_hasMAY

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.

LocationidentifierMAY

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

http://hl7.org/fhir/SearchParameter/Location-identifier
LocationaddressMAY

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

http://hl7.org/fhir/SearchParameter/Location-address
Locationoperational-statusMAY

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

http://hl7.org/fhir/SearchParameter/Location-operational-status
LocationorganizationMAY

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

http://hl7.org/fhir/SearchParameter/Location-organization
LocationtypeMAY

Beispiel zur Suche nach Typ eines Standorts:
GET [base]/Location?type=bed
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Location-type
LocationpartofMAY

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.

http://hl7.org/fhir/SearchParameter/Location-partof
LocationnearMAY

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

http://hl7.org/fhir/SearchParameter/Location-near

(Reverse-)Include

RessourcenTyp
Organization
Location