Referenz
Endpunkte
Abschnitt betitelt „Endpunkte“| Methode | Pfad | Auth | Zweck |
|---|---|---|---|
POST |
/api/v1/token/login |
nein | Anmelden, Token erhalten |
POST |
/api/v1/token/refresh |
nein | Token erneuern |
GET |
/api/v1/token/status |
nein | Erreichbarkeit prüfen |
GET |
/api/v1/kliniken |
ja | Teilnehmende Kliniken und Fachabteilungen |
GET |
/api/v1/subscriptions |
ja | Eigene Subscriptions auflisten |
GET |
/api/v1/subscriptions/{id} |
ja | Einzelne Subscription |
POST |
/api/v1/subscriptions |
ja | Subscription anlegen oder aktualisieren |
PUT |
/api/v1/subscriptions/{id} |
ja | Adresse ändern |
DELETE |
/api/v1/subscriptions/{id} |
ja | Subscription entfernen |
POST |
/api/v2/fhir/Bundle |
ja | Anfrage oder Dokument senden |
GET |
/api/v2/fhir/Task |
ja | Stand einer Anfrage abfragen |
Die FHIR-Endpunkte sprechen application/fhir+json, die übrigen application/json.
Profile
Abschnitt betitelt „Profile“| Profil | URL |
|---|---|
| AdmissionRequestBundle | https://belegung-api.median-kliniken.de/fhir/StructureDefinition/AdmissionRequestBundle |
| DocumentBundle | https://belegung-api.median-kliniken.de/fhir/StructureDefinition/DocumentBundle |
| AdmissionResponseMessage | https://belegung-api.median-kliniken.de/fhir/StructureDefinition/AdmissionResponseMessage |
Identifier-Systeme
Abschnitt betitelt „Identifier-Systeme“| System | URL | Verwendung |
|---|---|---|
| Globale URI | urn:ietf:rfc:3986 |
ServiceRequest.identifier, Patient.identifier |
| IK-Nummer | http://fhir.de/sid/arge-ik/iknr |
Organization.identifier und alle Verweise auf Kliniken |
| Deep-Link | https://belegung-api.median-kliniken.de/fhir/sid/performer-deep-link |
optionaler Verweis auf die Anfrage beim Zuweiser |
CodeSystems
Abschnitt betitelt „CodeSystems“| CodeSystem | URL | Verwendung |
|---|---|---|
| Service-Type | .../fhir/CodeSystem/bedrequest-service-type |
ServiceRequest.code |
| Specialty | .../fhir/CodeSystem/specialty |
ServiceRequest.performerType |
| DKG-Fachabteilungsschlüssel | http://fhir.de/CodeSystem/dkgev/Fachabteilungsschluessel-erweitert |
ServiceRequest.performerType |
| Order-Detail-Type | .../fhir/CodeSystem/order-detail-type |
ServiceRequest.orderDetail |
| Message-Event | .../fhir/CodeSystem/message-event |
MessageHeader.eventCoding |
| Response-Status | .../fhir/CodeSystem/admission-response-status |
Task.businessStatus |
| Rejection-Reason | .../fhir/CodeSystem/admission-rejection-reason |
Task.statusReason bei Ablehnung |
| Need-Data-Reason | .../fhir/CodeSystem/admission-need-data-reason |
Task.statusReason bei Datenbedarf |
| Output-Type | .../fhir/CodeSystem/admission-output |
Task.output.type |
| Input-Type | .../fhir/CodeSystem/admission-input |
Task.input.type |
Die Kurzform .../fhir/ steht für https://belegung-api.median-kliniken.de/fhir/.
Art der Maßnahme
Abschnitt betitelt „Art der Maßnahme“CodeSystem bedrequest-service-type, verwendet in ServiceRequest.code.
| Code | Bedeutung |
|---|---|
inpatient-rehabilitation |
Vollstationäre Rehabilitation |
partial-inpatient-rehabilitation |
Teilstationäre Rehabilitation |
outpatient-rehabilitation |
Ambulante Rehabilitation |
home-based-rehabilitation |
Mobile Rehabilitation |
Fachrichtung
Abschnitt betitelt „Fachrichtung“ServiceRequest.performerType enthält mindestens ein Coding: aus dem Fachabteilungsschlüssel der Deutschen Krankenhausgesellschaft (dkgev), aus dem CodeSystem specialty des Portals oder aus beiden. Der dkgev-Schlüssel ist in Deutschland allgemein bekannt; die Specialty unterscheidet die Fachrichtung feiner, als es der dkgev-Schlüssel allein leistet.
Für die Zuordnung zur Fachabteilung wertet das Portal das Specialty-Coding vorrangig aus, weil es präziser ist als der dkgev-Schlüssel (der Schlüssel 2800 steht etwa für Neurologie oder Phase D). Der dkgev-Schlüssel greift, wenn keine Specialty angegeben ist. Widersprechen sich beide, gewinnt die Specialty.
| Code | Bedeutung | Fachabteilungscode |
|---|---|---|
addiction |
Entwöhnungsbehandlungen | 8501 |
angiology |
Angiologie | 3750 |
cardiology |
Kardiologie | 0300 |
dermatology |
Dermatologie | 3400 |
endocrinology |
Endokrinologie | 0600 |
gastroenterology |
Gastroenterologie | 0700 |
geriatrics |
Geriatrie | 0200 |
gynaecology |
Gynäkologie | 2400 |
internal-medicine |
Innere Medizin | 0100 |
nephrology |
Nephrologie | 0400 |
neuro-pediatrics |
Neuropädiatrie | 2810 |
neuro-phase-b |
Neurologie Phase B | 2852 |
neuro-phase-c |
Neurologie Phase C | 2891 |
neuro-phase-d |
Neurologie Phase D | 2800 |
neurology |
Neurologie | 2800 |
oncology |
Onkologie | 0500 |
orthopedics |
Orthopädie | 2300 |
parents-and-child-rehab |
Begleitete Kinder | 1090 |
pediatrics |
Pädiatrie | 1000 |
pneumology |
Pneumologie | 0800 |
psychosomatic |
Psychosomatik/Psychotherapie | 3100 |
rheumatology |
Rheumatologie | 0900 |
urology |
Urologie | 2200 |
Welche Fachabteilungen eine Klinik anbietet, liefert der Endpunkt Kliniken.
Status der Antwort
Abschnitt betitelt „Status der Antwort“CodeSystem admission-response-status, verwendet in Task.businessStatus.
| Code | Bedeutung |
|---|---|
accepted |
Aufnahme zugesagt |
declined |
Aufnahme abgelehnt |
declined-with-alternative |
Aufnahme abgelehnt, Alternative vorgeschlagen |
question |
Rückfrage |
information-requested |
Weitere Informationen benötigt |
provider-selected |
Provider ausgewählt |
Ablehnungsgründe
Abschnitt betitelt „Ablehnungsgründe“CodeSystem admission-rejection-reason, verwendet in Task.statusReason, wenn eine Klinik ablehnt.
| Code | Bedeutung |
|---|---|
no-capacity |
Keine freie Kapazität |
no-indication |
Keine Indikation |
wrong-specialty |
Falsche Fachabteilung |
patient-not-suitable |
Patient nicht geeignet |
payer |
Kostenträger |
other |
Sonstiger Grund |
Ergänzende Erläuterungen stehen in statusReason.text.
Rückfragegründe
Abschnitt betitelt „Rückfragegründe“CodeSystem admission-need-data-reason, verwendet in Task.statusReason, wenn eine Klinik weitere Angaben benötigt. Mehrere Codings sind möglich.
| Code | Bedeutung |
|---|---|
medical-records |
Zusenden von medizinischen Unterlagen |
barthel-index |
Aktueller Barthel-Index |
consultation |
Rücksprache |
medication |
Angabe von verordneten Medikamenten |
weight-bmi |
Gewichtsangabe/BMI |
epicrisis |
Epikrise |
Die Gründe bilden die Rückfrage der Klinik ab; ergänzende Erläuterungen stehen als Freitext in Task.note.
Order-Detail-Type
Abschnitt betitelt „Order-Detail-Type“CodeSystem order-detail-type, verwendet in ServiceRequest.orderDetail, wenn der Zuweiser mit intent: order eine Klinik auswählt oder die Auswahl zurückzieht.
| Code | Bedeutung |
|---|---|
selected-provider |
Auswahl einer Klinik |
selected-provider-cancelled |
Rückzug der Auswahl |
Weitere Codes
Abschnitt betitelt „Weitere Codes“| CodeSystem | Code | Verwendung |
|---|---|---|
message-event |
admission-request-response |
MessageHeader.eventCoding jeder Antwort |
admission-output |
offered-admission-date |
Angebotenes Aufnahmedatum bei Zusage. Die Klinik legt dieses Datum frei fest; es kann vom ursprünglich angefragten Aufnahmedatum abweichen. |
admission-input |
comment |
Kommentar oder Rückfrage der Klinik |