CapabilityStatement
EMIGA Einrichtungsverzeichnis - Konformitätserklärung
Es gilt zur Umsetzung der Funktionalität für die EINRV-Schnittstelle insbesondere die Anforderungen aus dem Capability Statement.
Beschreibung
Dieses Konformitätserklärung (CapabilityStatement) beschreibt die normativen FHIR-REST-Anforderungen für EMIGA VZD.
Es ist vom Typ requirements. Zur Kennzeichnung der Verbindlichkeit wird die
CapabilityStatement-Expectation-Extension mit den möglichen Werten 'SHALL' (=MUSS) 'SHOULD' (=SOLL) 'MAY' (=KANN) 'SHOULD-NOT' (=SOLL NICHT) verwendet.
Die aufgeführten Interaktionen entsprechen den vom geprüften HAPI-FHIR-Referenzserver
unterstützten Interaktionen und sind in diesem Requirements-CapabilityStatement als SHALL
gekennzeichnet. Suchparameter, Includes, Reverse-Includes und Operationen werden für den
VZD-spezifischen Anwendungsbereich ausgewiesen.
Zweck
Dieses CapabilityStatement definiert die für EMIGA VZD vorgesehenen Server-Fähigkeiten. Es dient als normative Grundlage für Implementierung und Imlementierungs-Leitfaden-Dokumentation.
| https://emiga.rki.de/fhir/vzd/CapabilityStatement/EmigaEINRVCapabilityStatementRequirements | requirements | active | 0.1.0 |
Anforderungen an die FHIR-API
| server |
Interaktionen
| Ressourcentyp | READ | SEARCH | CREATE | UPDATE | PATCH | DELETE | VREAD | HistoryInstance | HistoryType |
|---|---|---|---|---|---|---|---|---|---|
| HealthcareService | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL |
| Location | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL |
| Organization | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL |
| Practitioner | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL |
| PractitionerRole | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL | SHALL |
Profile
Ressourcentyp-spezifische Operations
| RessourcenTyp | Name | Spezifikation |
|---|---|---|
| HealthcareService | validate | https://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/Multi-it-validate |
| Location | validate | https://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/Multi-it-validate |
| Organization | set-active-flag | https://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/Organization-i-set-active-flag |
| Organization | duplicate-check | https://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/Organization-t-duplicate-check |
| Organization | validate | https://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/Multi-it-validate |
| Practitioner | validate | https://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/Multi-it-validate |
| PractitionerRole | validate | https://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/Multi-it-validate |
Globale Operations
| Name | Spezifikation | Verbindlichkeit |
|---|---|---|
| fetch-org-details | https://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/-s-fetch-org-details | SHALL |
| fetch-department-details-for-org | https://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/-s-fetch-department-details-for-org | SHALL |
Systeminteraktionen
| Interaktion | Verbindlichkeit | Hinweise |
|---|---|---|
| transaction | SHALL | Beispiel:
Der Server unterstützt FHIR-Transaktionen auf Systemebene. |
| history-system | MAY | Beispiel:
Der Server unterstützt die systemweite Historie. |
Suchparameter
| RessourcenTyp | SuchParameter | Verbindlichkeit | Hinweise | Definition |
|---|---|---|---|---|
| HealthcareService | specialty | SHALL | Beispiel:
Anwendungshinweis: Die Fachrichtung der von diesem Gesundheitsdienst angebotenen Leistung | http://hl7.org/fhir/SearchParameter/HealthcareService-specialty |
| HealthcareService | service-category | SHALL | Beispiel:
Anwendungshinweis: Die Kategorie der Leistung des Gesundheitsdienstes | http://hl7.org/fhir/SearchParameter/HealthcareService-service-category |
| HealthcareService | service-type | SHALL | Beispiel:
Anwendungshinweis: Die Art der von diesem Gesundheitsdienst angebotenen Leistung | http://hl7.org/fhir/SearchParameter/HealthcareService-service-type |
| HealthcareService | active | SHALL | Beispiel:
Anwendungshinweis: Der Gesundheitsdienst ist derzeit als aktiv gekennzeichnet | http://hl7.org/fhir/SearchParameter/HealthcareService-active |
| HealthcareService | organization | SHALL | http://hl7.org/fhir/SearchParameter/HealthcareService-organization | |
| HealthcareService | name | SHALL | Beispiel:
Anwendungshinweis: Ein Teil des Namens des Gesundheitsdienstes | http://hl7.org/fhir/SearchParameter/HealthcareService-name |
| HealthcareService | location | SHALL | Beispiel:
Anwendungshinweis: Der Standort des Gesundheitsdienstes | http://hl7.org/fhir/SearchParameter/HealthcareService-location |
| HealthcareService | _id | SHALL | Beispiel:
Anwendungshinweis: Logische ID dieses Artefakts | http://hl7.org/fhir/SearchParameter/Resource-id |
| Location | identifier | SHALL | Beispiel:
Anwendungshinweis: Ein Identifikator für den Standort | http://hl7.org/fhir/SearchParameter/Location-identifier |
| Location | partof | SHALL | Beispiel:
Anwendungshinweis: Ein Standort, zu dem dieser Standort gehört | http://hl7.org/fhir/SearchParameter/Location-partof |
| Location | address | SHALL | Beispiel:
Anwendungshinweis: Die Adresse oder ein Teil der Adresse des Standorts | http://hl7.org/fhir/SearchParameter/Location-address |
| Location | address-state | SHALL | Beispiel:
Anwendungshinweis: Ein in einer Adresse angegebenes Bundesland bzw. eine angegebene Region | http://hl7.org/fhir/SearchParameter/Location-address-state |
| Location | operational-status | SHALL | Beispiel:
Anwendungshinweis: Es wird im Profile 'EmigaHospitalRoomLocation' verwendet. Sucht nach Standorten (typischerweise Bett/Zimmer), die einen Betriebsstatus aufweisen (z. B. kontaminiert, Reinigung) | http://hl7.org/fhir/SearchParameter/Location-operational-status |
| Location | type | SHALL | Beispiel:
Anwendungshinweis: Ein Code für die Art des Standorts | http://hl7.org/fhir/SearchParameter/Location-type |
| Location | address-postalcode | SHALL | Beispiel:
Anwendungshinweis: Eine in einer Adresse angegebene Postleitzahl | http://hl7.org/fhir/SearchParameter/Location-address-postalcode |
| Location | address-country | MAY | Beispiel:
Anwendungshinweis: Ein in einer Adresse angegebenes Land | http://hl7.org/fhir/SearchParameter/Location-address-country |
| Location | organization | MAY | Beispiel:
Anwendungshinweis: Sucht nach Standorten, die von der angegebenen Organisation verwaltet werden | http://hl7.org/fhir/SearchParameter/Location-organization |
| Location | address-use | SHALL | Beispiel:
Anwendungshinweis: Ein in einer Adresse angegebener Verwendungscode | http://hl7.org/fhir/SearchParameter/Location-address-use |
| Location | name | SHALL | Beispiel:
Anwendungshinweis: Ein Teil des Namens oder Alias des Standorts | http://hl7.org/fhir/SearchParameter/Location-name |
| Location | _id | MAY | Beispiel:
Anwendungshinweis: Logische ID dieses Artefakts | http://hl7.org/fhir/SearchParameter/Resource-id |
| Location | near | MAY | Beispiel:
Anwendungshinweis: Sucht nach Standorten, deren location.position sich in der Nähe der angegebenen Koordinaten oder innerhalb einer angegebenen Entfernung davon befindet. Die Koordinaten werden als [Breitengrad]|[Längengrad]|[Entfernung]|[Einheit] angegeben (unter Verwendung des WGS84-Bezugssystems, siehe Hinweise). Wenn die Einheit weggelassen wird, ist von Kilometern auszugehen. Wenn die Entfernung weggelassen wird, kann der Server nach eigenem Ermessen festlegen, welche Entfernungen als „in der Nähe“ gelten; die Einheit ist in diesem Fall nicht relevant. Server können unterschiedliche Suchverfahren verwenden, deren Genauigkeit abhängig von der jeweiligen Implementierung variieren kann. Erfordert zusätzlich die Angabe des Parameters near-distance | http://hl7.org/fhir/SearchParameter/Location-near |
| Location | address-city | MAY | Beispiel:
Anwendungshinweis: Eine in einer Adresse angegebene Stadt | http://hl7.org/fhir/SearchParameter/Location-address-city |
| Location | status | SHALL | Beispiel:
Anwendungshinweis: Sucht nach Standorten mit einem bestimmten Status | http://hl7.org/fhir/SearchParameter/Location-status |
| Organization | identifier | SHALL | Beispiel:
Anwendungshinweis: Ein beliebiger Identifikator der Organisation (nicht der Identifikator der Akkreditierungsstelle) | http://hl7.org/fhir/SearchParameter/Organization-identifier |
| Organization | partof | SHALL | Beispiel:
Anwendungshinweis: Eine Organisation, zu der diese Organisation gehört | http://hl7.org/fhir/SearchParameter/Organization-partof |
| Organization | address | SHALL | Beispiel:
Anwendungshinweis: Eine serverdefinierte Suche, die mit beliebigen Zeichenkettenfeldern der Adresse übereinstimmen kann, einschließlich line, city, district, state, country, postalCode und/oder text | http://hl7.org/fhir/SearchParameter/Organization-address |
| Organization | address-state | SHALL | Beispiel:
Anwendungshinweis: Ein in einer Adresse angegebenes Bundesland bzw. eine angegebene Region | http://hl7.org/fhir/SearchParameter/Organization-address-state |
| Organization | active | SHALL | Beispiel:
Anwendungshinweis: Gibt an, ob der Organisationseintrag aktiv ist | http://hl7.org/fhir/SearchParameter/Organization-active |
| Organization | type | SHALL | Beispiel:
Anwendungshinweis: Ein Code für die Art der Organisation | http://hl7.org/fhir/SearchParameter/Organization-type |
| Organization | address-postalcode | SHALL | Beispiel:
Anwendungshinweis: Eine in einer Adresse angegebene Postleitzahl | http://hl7.org/fhir/SearchParameter/Organization-address-postalcode |
| Organization | address-country | MAY | Beispiel:
Anwendungshinweis: Ein in einer Adresse angegebenes Land | http://hl7.org/fhir/SearchParameter/Organization-address-country |
| Organization | phonetic | SHALL | Beispiel:
Anwendungshinweis: Ein Teil des Organisationsnamens unter Verwendung eines phonetischen Abgleichverfahrens | http://hl7.org/fhir/SearchParameter/Organization-phonetic |
| Organization | address-use | SHALL | Beispiel:
Anwendungshinweis: Ein in einer Adresse angegebener Verwendungscode | http://hl7.org/fhir/SearchParameter/Organization-address-use |
| Organization | name | SHALL | Beispiel:
Anwendungshinweis: Ein Teil des Namens oder Alias der Organisation | http://hl7.org/fhir/SearchParameter/Organization-name |
| Organization | _id | SHALL | Beispiel:
Anwendungshinweis: Logische ID dieses Artefakts | http://hl7.org/fhir/SearchParameter/Resource-id |
| Organization | address-city | MAY | Beispiel:
Anwendungshinweis: Eine in einer Adresse angegebene Stadt | http://hl7.org/fhir/SearchParameter/Organization-address-city |
| Practitioner | phonetic | SHALL | Beispiel:
Anwendungshinweis: Mehrere Ressourcen:
| http://hl7.org/fhir/SearchParameter/individual-phonetic |
| Practitioner | telecom | SHALL | Beispiel:
Anwendungshinweis: Mehrere Ressourcen:
| http://hl7.org/fhir/SearchParameter/individual-telecom |
| Practitioner | SHALL | Beispiel:
Anwendungshinweis: Mehrere Ressourcen:
| http://hl7.org/fhir/SearchParameter/individual-email | |
| Practitioner | given | SHALL | Beispiel:
Anwendungshinweis: Mehrere Ressourcen:
| http://hl7.org/fhir/SearchParameter/individual-given |
| Practitioner | active | SHALL | Beispiel:
Anwendungshinweis: Gibt an, ob der Practitioner-Eintrag aktiv ist | http://hl7.org/fhir/SearchParameter/Practitioner-active |
| Practitioner | phone | SHALL | Beispiel:
Anwendungshinweis: Mehrere Ressourcen:
| http://hl7.org/fhir/SearchParameter/individual-phone |
| Practitioner | name | SHALL | Beispiel:
Anwendungshinweis: Eine serverdefinierte Suche, die mit beliebigen Zeichenkettenfeldern von HumanName übereinstimmen kann, einschließlich family, given, prefix, suffix und/oder text | http://hl7.org/fhir/SearchParameter/Practitioner-name |
| Practitioner | _id | SHALL | Beispiel:
Anwendungshinweis: Logische ID dieses Artefakts | http://hl7.org/fhir/SearchParameter/Resource-id |
| Practitioner | family | SHALL | Beispiel:
Anwendungshinweis: Mehrere Ressourcen:
| http://hl7.org/fhir/SearchParameter/individual-family |
| PractitionerRole | date | SHALL | Beispiel:
Anwendungshinweis: Der Zeitraum, in dem die tätige Person berechtigt ist, diese Rolle bzw. Rollen auszuüben | http://hl7.org/fhir/SearchParameter/PractitionerRole-date |
| PractitionerRole | role | SHALL | Beispiel:
Anwendungshinweis: Die tätige Person kann diese Rolle für die Organisation ausüben | http://hl7.org/fhir/SearchParameter/PractitionerRole-role |
| PractitionerRole | practitioner | SHALL | Beispiel:
Anwendungshinweis: Eine tätige Person, die die definierten Leistungen für die Organisation erbringen kann | http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner |
| PractitionerRole | active | MAY | Beispiel:
Anwendungshinweis: Gibt an, ob dieser PractitionerRole-Eintrag aktiv verwendet wird | http://hl7.org/fhir/SearchParameter/PractitionerRole-active |
| PractitionerRole | service | SHALL | Beispiel:
Anwendungshinweis: Die Liste der Gesundheitsdienstleistungen, die diese tätige Person für die Organisation bzw. den Standort oder die Standorte dieser Rolle erbringt | http://hl7.org/fhir/SearchParameter/PractitionerRole-service |
| PractitionerRole | organization | SHALL | Beispiel:
Anwendungshinweis: Die Organisation, die die tätige Person vertritt bzw. in deren Auftrag sie handelt | http://hl7.org/fhir/SearchParameter/PractitionerRole-organization |
| PractitionerRole | location | MAY | Beispiel:
Anwendungshinweis: Einer der Standorte, an denen die tätige Person Leistungen erbringt | http://hl7.org/fhir/SearchParameter/PractitionerRole-location |
| PractitionerRole | _id | SHALL | Beispiel:
Anwendungshinweis: Logische ID dieses Artefakts | http://hl7.org/fhir/SearchParameter/Resource-id |
Includes
| RessourcenTyp | Include | Verbindlichkeit |
|---|---|---|
| HealthcareService | * | SHALL |
| HealthcareService | HealthcareService:location | SHALL |
| HealthcareService | HealthcareService:organization | SHALL |
| Location | * | MAY |
| Location | Location:organization | SHALL |
| Location | Location:partof | SHALL |
| Organization | * | MAY |
| Organization | SHALL | |
| Organization | Organization:partof | |
| Practitioner | * | MAY |
| PractitionerRole | * | MAY |
| PractitionerRole | MAY | |
| PractitionerRole | PractitionerRole:location | SHALL |
| PractitionerRole | PractitionerRole:organization | SHALL |
| PractitionerRole | PractitionerRole:practitioner | MAY |
| PractitionerRole | PractitionerRole:service |
Reverse-Includes
| RessourcenTyp | ReverseInclude | Verbindlichkeit |
|---|---|---|
| HealthcareService | PractitionerRole:service | MAY |
| Location | HealthcareService:coverage-area | MAY |
| Location | HealthcareService:location | MAY |
| Location | Location:partof | MAY |
| Location | PractitionerRole:location | MAY |
| Organization | HealthcareService:organization | MAY |
| Organization | Location:organization | MAY |
| Organization | Organization:partof | MAY |
| Organization | PractitionerRole:organization | MAY |
| Practitioner | PractitionerRole:practitioner | MAY |