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/EmigaEINRVCapabilityStatementRequirementsrequirementsactive0.1.0

Anforderungen an die FHIR-API

server

Interaktionen

RessourcentypREADSEARCHCREATEUPDATEPATCHDELETEVREADHistoryInstanceHistoryType
HealthcareServiceSHALLSHALLSHALLSHALLSHALLSHALLSHALLSHALLSHALL
LocationSHALLSHALLSHALLSHALLSHALLSHALLSHALLSHALLSHALL
OrganizationSHALLSHALLSHALLSHALLSHALLSHALLSHALLSHALLSHALL
PractitionerSHALLSHALLSHALLSHALLSHALLSHALLSHALLSHALLSHALL
PractitionerRoleSHALLSHALLSHALLSHALLSHALLSHALLSHALLSHALLSHALL

Profile

RessourcentypProfile
HealthcareServicehttps://emiga.rki.de/fhir/vzd/StructureDefinition/EmigaHealthcareService
Locationhttps://emiga.rki.de/fhir/vzd/StructureDefinition/EmigaHospitalFacilityLocation
Locationhttps://emiga.rki.de/fhir/vzd/StructureDefinition/EmigaHospitalLocation
Locationhttps://emiga.rki.de/fhir/vzd/StructureDefinition/EmigaHospitalRoomLocation
Locationhttps://emiga.rki.de/fhir/vzd/StructureDefinition/EmigaLocation
Locationhttps://emiga.rki.de/fhir/vzd/StructureDefinition/EmigaPublicHealthLocation
Organizationhttps://emiga.rki.de/fhir/vzd/StructureDefinition/EmigaHospitalOrganization
Organizationhttps://emiga.rki.de/fhir/vzd/StructureDefinition/EmigaOrganization
Organizationhttps://emiga.rki.de/fhir/vzd/StructureDefinition/EmigaPublicHealthOrganization
Organizationhttps://emiga.rki.de/fhir/vzd/StructureDefinition/EmigaDepartmentOrganization
Practitionerhttps://emiga.rki.de/fhir/vzd/StructureDefinition/EmigaPractitioner
PractitionerRolehttps://emiga.rki.de/fhir/vzd/StructureDefinition/EmigaPractitionerRole

Ressourcentyp-spezifische Operations

RessourcenTypNameSpezifikation
HealthcareServicevalidatehttps://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/Multi-it-validate
Locationvalidatehttps://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/Multi-it-validate
Organizationset-active-flaghttps://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/Organization-i-set-active-flag
Organizationduplicate-checkhttps://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/Organization-t-duplicate-check
Organizationvalidatehttps://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/Multi-it-validate
Practitionervalidatehttps://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/Multi-it-validate
PractitionerRolevalidatehttps://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/Multi-it-validate

Globale Operations

NameSpezifikationVerbindlichkeit
fetch-org-detailshttps://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/-s-fetch-org-detailsSHALL
fetch-department-details-for-orghttps://orgvz.ref.emiga-rki.de/fhir/OperationDefinition/-s-fetch-department-details-for-orgSHALL

Systeminteraktionen

InteraktionVerbindlichkeitHinweise
transactionSHALL

Beispiel: POST [base]

Der Server unterstützt FHIR-Transaktionen auf Systemebene.

history-systemMAY

Beispiel: GET [base]/_history

Der Server unterstützt die systemweite Historie.

Suchparameter

RessourcenTypSuchParameterVerbindlichkeitHinweiseDefinition
HealthcareServicespecialtySHALL

Beispiel: GET [base]/HealthcareService?specialty=<code>

Anwendungshinweis: Die Fachrichtung der von diesem Gesundheitsdienst angebotenen Leistung

http://hl7.org/fhir/SearchParameter/HealthcareService-specialty
HealthcareServiceservice-categorySHALL

Beispiel: GET [base]/HealthcareService?service-category=<code>

Anwendungshinweis: Die Kategorie der Leistung des Gesundheitsdienstes

http://hl7.org/fhir/SearchParameter/HealthcareService-service-category
HealthcareServiceservice-typeSHALL

Beispiel: GET [base]/HealthcareService?service-type=<code>

Anwendungshinweis: Die Art der von diesem Gesundheitsdienst angebotenen Leistung

http://hl7.org/fhir/SearchParameter/HealthcareService-service-type
HealthcareServiceactiveSHALL

Beispiel: GET [base]/HealthcareService?active=true

Anwendungshinweis: Der Gesundheitsdienst ist derzeit als aktiv gekennzeichnet

http://hl7.org/fhir/SearchParameter/HealthcareService-active
HealthcareServiceorganizationSHALLhttp://hl7.org/fhir/SearchParameter/HealthcareService-organization
HealthcareServicenameSHALL

Beispiel: GET [base]/HealthcareService?name=Gesundheitsamt

Anwendungshinweis: Ein Teil des Namens des Gesundheitsdienstes

http://hl7.org/fhir/SearchParameter/HealthcareService-name
HealthcareServicelocationSHALL

Beispiel: GET [base]/HealthcareService?location=Location/123

Anwendungshinweis: Der Standort des Gesundheitsdienstes

http://hl7.org/fhir/SearchParameter/HealthcareService-location
HealthcareService_idSHALL

Beispiel: GET [base]/HealthcareService?_id=123

Anwendungshinweis: Logische ID dieses Artefakts

http://hl7.org/fhir/SearchParameter/Resource-id
LocationidentifierSHALL

Beispiel: GET [base]/Location?identifier=https://emiga.rki.de/fhir/sid/EmigaFileNumber|[Standort][1.][2026]-[87654321]

Anwendungshinweis: Ein Identifikator für den Standort

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

Beispiel: GET [base]/Location?partof=Location/123

Anwendungshinweis: Ein Standort, zu dem dieser Standort gehört

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

Beispiel: GET [base]/Location?address=Berlin

Anwendungshinweis: Die Adresse oder ein Teil der Adresse des Standorts

http://hl7.org/fhir/SearchParameter/Location-address
Locationaddress-stateSHALL

Beispiel: GET [base]/Location?address-state=Berlin

Anwendungshinweis: Ein in einer Adresse angegebenes Bundesland bzw. eine angegebene Region

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

Beispiel: GET [base]/Location?operational-status=<code>

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
LocationtypeSHALL

Beispiel: GET [base]/Location?type=<code>

Anwendungshinweis: Ein Code für die Art des Standorts

http://hl7.org/fhir/SearchParameter/Location-type
Locationaddress-postalcodeSHALL

Beispiel: GET [base]/Location?address-postalcode=10115

Anwendungshinweis: Eine in einer Adresse angegebene Postleitzahl

http://hl7.org/fhir/SearchParameter/Location-address-postalcode
Locationaddress-countryMAY

Beispiel: GET [base]/Location?address-country=DE

Anwendungshinweis: Ein in einer Adresse angegebenes Land

http://hl7.org/fhir/SearchParameter/Location-address-country
LocationorganizationMAY

Beispiel: GET [base]/Location?organization=Organization/123

Anwendungshinweis: Sucht nach Standorten, die von der angegebenen Organisation verwaltet werden

http://hl7.org/fhir/SearchParameter/Location-organization
Locationaddress-useSHALL

Beispiel: GET [base]/Location?address-use=work

Anwendungshinweis: Ein in einer Adresse angegebener Verwendungscode

http://hl7.org/fhir/SearchParameter/Location-address-use
LocationnameSHALL

Beispiel: GET [base]/Location?name=Gesundheitsamt

Anwendungshinweis: Ein Teil des Namens oder Alias des Standorts

http://hl7.org/fhir/SearchParameter/Location-name
Location_idMAY

Beispiel: GET [base]/Location?_id=123

Anwendungshinweis: Logische ID dieses Artefakts

http://hl7.org/fhir/SearchParameter/Resource-id
LocationnearMAY

Beispiel: GET [base]/Location?near=52.5200|13.4050|5|km

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
Locationaddress-cityMAY

Beispiel: GET [base]/Location?address-city=Berlin

Anwendungshinweis: Eine in einer Adresse angegebene Stadt

http://hl7.org/fhir/SearchParameter/Location-address-city
LocationstatusSHALL

Beispiel: GET [base]/Location?status=active

Anwendungshinweis: Sucht nach Standorten mit einem bestimmten Status

http://hl7.org/fhir/SearchParameter/Location-status
OrganizationidentifierSHALL

Beispiel: GET [base]/Organization?identifier=https://example.org/fhir/sid/example|12345

Anwendungshinweis: Ein beliebiger Identifikator der Organisation (nicht der Identifikator der Akkreditierungsstelle)

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

Beispiel: GET [base]/Organization?partof=Organization/123

Anwendungshinweis: Eine Organisation, zu der diese Organisation gehört

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

Beispiel: GET [base]/Organization?address=Berlin

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
Organizationaddress-stateSHALL

Beispiel: GET [base]/Organization?address-state=Berlin

Anwendungshinweis: Ein in einer Adresse angegebenes Bundesland bzw. eine angegebene Region

http://hl7.org/fhir/SearchParameter/Organization-address-state
OrganizationactiveSHALL

Beispiel: GET [base]/Organization?active=true

Anwendungshinweis: Gibt an, ob der Organisationseintrag aktiv ist

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

Beispiel: GET [base]/Organization?type=<code>

Anwendungshinweis: Ein Code für die Art der Organisation

http://hl7.org/fhir/SearchParameter/Organization-type
Organizationaddress-postalcodeSHALL

Beispiel: GET [base]/Organization?address-postalcode=10115

Anwendungshinweis: Eine in einer Adresse angegebene Postleitzahl

http://hl7.org/fhir/SearchParameter/Organization-address-postalcode
Organizationaddress-countryMAY

Beispiel: GET [base]/Organization?address-country=DE

Anwendungshinweis: Ein in einer Adresse angegebenes Land

http://hl7.org/fhir/SearchParameter/Organization-address-country
OrganizationphoneticSHALL

Beispiel: GET [base]/Organization?phonetic=Mustermann

Anwendungshinweis: Ein Teil des Organisationsnamens unter Verwendung eines phonetischen Abgleichverfahrens

http://hl7.org/fhir/SearchParameter/Organization-phonetic
Organizationaddress-useSHALL

Beispiel: GET [base]/Organization?address-use=work

Anwendungshinweis: Ein in einer Adresse angegebener Verwendungscode

http://hl7.org/fhir/SearchParameter/Organization-address-use
OrganizationnameSHALL

Beispiel: GET [base]/Organization?name=Gesundheitsamt

Anwendungshinweis: Ein Teil des Namens oder Alias der Organisation

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

Beispiel: GET [base]/Organization?_id=123

Anwendungshinweis: Logische ID dieses Artefakts

http://hl7.org/fhir/SearchParameter/Resource-id
Organizationaddress-cityMAY

Beispiel: GET [base]/Organization?address-city=Berlin

Anwendungshinweis: Eine in einer Adresse angegebene Stadt

http://hl7.org/fhir/SearchParameter/Organization-address-city
PractitionerphoneticSHALL

Beispiel: GET [base]/Practitioner?phonetic=Mustermann

Anwendungshinweis: Mehrere Ressourcen:

  • Patient: Ein Teil des Familien- oder Vornamens unter Verwendung eines phonetischen Abgleichverfahrens
  • Person: Ein Teil des Namens unter Verwendung eines phonetischen Abgleichverfahrens
  • Practitioner: Ein Teil des Familien- oder Vornamens unter Verwendung eines phonetischen Abgleichverfahrens
  • RelatedPerson: Ein Teil des Namens unter Verwendung eines phonetischen Abgleichverfahrens
http://hl7.org/fhir/SearchParameter/individual-phonetic
PractitionertelecomSHALL

Beispiel: GET [base]/Practitioner?telecom=info@example.org

Anwendungshinweis: Mehrere Ressourcen:

  • Patient: Der Wert in beliebigen Telekommunikations-Kontaktdaten des Patienten
  • Person: Der Wert in beliebigen Kontaktdaten
  • Practitioner: Der Wert in beliebigen Kontaktdaten
  • PractitionerRole: Der Wert in beliebigen Kontaktdaten
  • RelatedPerson: Der Wert in beliebigen Kontaktdaten
http://hl7.org/fhir/SearchParameter/individual-telecom
PractitioneremailSHALL

Beispiel: GET [base]/Practitioner?email=info@example.org

Anwendungshinweis: Mehrere Ressourcen:

http://hl7.org/fhir/SearchParameter/individual-email
PractitionergivenSHALL

Beispiel: GET [base]/Practitioner?given=Erika

Anwendungshinweis: Mehrere Ressourcen:

http://hl7.org/fhir/SearchParameter/individual-given
PractitioneractiveSHALL

Beispiel: GET [base]/Practitioner?active=true

Anwendungshinweis: Gibt an, ob der Practitioner-Eintrag aktiv ist

http://hl7.org/fhir/SearchParameter/Practitioner-active
PractitionerphoneSHALL

Beispiel: GET [base]/Practitioner?phone=+49-30-123456

Anwendungshinweis: Mehrere Ressourcen:

http://hl7.org/fhir/SearchParameter/individual-phone
PractitionernameSHALL

Beispiel: GET [base]/Practitioner?name=Gesundheitsamt

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_idSHALL

Beispiel: GET [base]/Practitioner?_id=123

Anwendungshinweis: Logische ID dieses Artefakts

http://hl7.org/fhir/SearchParameter/Resource-id
PractitionerfamilySHALL

Beispiel: GET [base]/Practitioner?family=Mustermann

Anwendungshinweis: Mehrere Ressourcen:

http://hl7.org/fhir/SearchParameter/individual-family
PractitionerRoledateSHALL

Beispiel: GET [base]/PractitionerRole?date=2026-09-16

Anwendungshinweis: Der Zeitraum, in dem die tätige Person berechtigt ist, diese Rolle bzw. Rollen auszuüben

http://hl7.org/fhir/SearchParameter/PractitionerRole-date
PractitionerRoleroleSHALL

Beispiel: GET [base]/PractitionerRole?role=<code>

Anwendungshinweis: Die tätige Person kann diese Rolle für die Organisation ausüben

http://hl7.org/fhir/SearchParameter/PractitionerRole-role
PractitionerRolepractitionerSHALL

Beispiel: GET [base]/PractitionerRole?practitioner=Practitioner/123

Anwendungshinweis: Eine tätige Person, die die definierten Leistungen für die Organisation erbringen kann

http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner
PractitionerRoleactiveMAY

Beispiel: GET [base]/PractitionerRole?active=true

Anwendungshinweis: Gibt an, ob dieser PractitionerRole-Eintrag aktiv verwendet wird

http://hl7.org/fhir/SearchParameter/PractitionerRole-active
PractitionerRoleserviceSHALL

Beispiel: GET [base]/PractitionerRole?service=HealthcareService/123

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
PractitionerRoleorganizationSHALL

Beispiel: GET [base]/PractitionerRole?organization=Organization/123

Anwendungshinweis: Die Organisation, die die tätige Person vertritt bzw. in deren Auftrag sie handelt

http://hl7.org/fhir/SearchParameter/PractitionerRole-organization
PractitionerRolelocationMAY

Beispiel: GET [base]/PractitionerRole?location=Location/123

Anwendungshinweis: Einer der Standorte, an denen die tätige Person Leistungen erbringt

http://hl7.org/fhir/SearchParameter/PractitionerRole-location
PractitionerRole_idSHALL

Beispiel: GET [base]/PractitionerRole?_id=123

Anwendungshinweis: Logische ID dieses Artefakts

http://hl7.org/fhir/SearchParameter/Resource-id

Includes

RessourcenTypIncludeVerbindlichkeit
HealthcareService*SHALL
HealthcareServiceHealthcareService:locationSHALL
HealthcareServiceHealthcareService:organizationSHALL
Location*MAY
LocationLocation:organizationSHALL
LocationLocation:partofSHALL
Organization*MAY
OrganizationSHALL
OrganizationOrganization:partof
Practitioner*MAY
PractitionerRole*MAY
PractitionerRoleMAY
PractitionerRolePractitionerRole:locationSHALL
PractitionerRolePractitionerRole:organizationSHALL
PractitionerRolePractitionerRole:practitionerMAY
PractitionerRolePractitionerRole:service

Reverse-Includes

RessourcenTypReverseIncludeVerbindlichkeit
HealthcareServicePractitionerRole:serviceMAY
LocationHealthcareService:coverage-areaMAY
LocationHealthcareService:locationMAY
LocationLocation:partofMAY
LocationPractitionerRole:locationMAY
OrganizationHealthcareService:organizationMAY
OrganizationLocation:organizationMAY
OrganizationOrganization:partofMAY
OrganizationPractitionerRole:organizationMAY
PractitionerPractitionerRole:practitionerMAY