ISiKKalender (Schedule)
Motivation
Das Datenobjekt ISiKKalender bietet die Möglichkeit Kalender für verschiedene Akteure (Practitoner, Device, HealthcareService) zu exponieren, sodass für die Ressourcen Termine gebucht werden können.
Kompabilität
Siehe Kompabilität.
FHIR-Profil
Name | Canonical |
---|---|
ISiKKalender | https://gematik.de/fhir/isik/v2/Terminplanung/StructureDefinition/ISiKKalender |
Schedule | I | Schedule | |
extension | S I | 0..* | Extension |
Name | S I | 0..1 | Extension(string) |
identifier | Σ | 0..* | Identifier |
active | S Σ ?! | 1..1 | boolean |
serviceCategory | Σ | 0..* | CodeableConcept |
serviceType | S Σ | 1..* | CodeableConcept |
specialty | S Σ | 1..* | CodeableConceptBinding |
Fachrichtung | S Σ | 1..1 | CodeableConceptBinding |
actor | S Σ I | 1..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | S Σ | 0..1 | Identifier |
display | S Σ | 1..1 | string |
Akteur | S Σ I | 0..1 | Reference(Practitioner | HealthcareService) |
reference | S Σ I | 1..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | Σ | 0..1 | string |
planningHorizon | Σ I | 0..1 | Period |
comment | 0..1 | string |
Folgende FHIRPath-Constraints sind im Profil zu beachten:
Terminology Bindings
Path | Name | Strength | URL |
---|---|---|---|
Schedule.specialty | he-d.de/ValueSets/IHEXDSauthorSpeciality | required | http://ihe-d.de/ValueSets/IHEXDSauthorSpeciality |
Anmerkungen zu Must-Support-Feldern
Schedule.extension:name
Bedeutung: Gebräuchlicher Name des Kalenders
Hinweis: Im alltäglichen Kontext besitzen Kalender neben der Zugehörigkeit zu einer Ressource teilweise einen Namen. Dieser muss nicht zwingend ein eineindeutiger Identifier sein. Aufgrund dessen kann dieser Name zusätzlich abgebildet werden.
Schedule.active
Bedeutung: Ist der Kalender in aktiver Verwendung?
Hinweis: Historische Kalender können ebenfalls über die ISiK-Schnittstelle ausgetauscht werden. Für diese dürfen jedoch keine Termine vereinbart werden. Das terminführende System MUSS dies bei der Buchung überprüfen.
Schedule.serviceType
Bedeutung: Welche Besuchsgründe / Behandlungsleistungen werden durch diesen Kalender erfasst?
Hinweis: Die Besuchsgründe / Behandlungsleistungen sollten im Schedule angegeben werden, falls unter Schedule.actor nur Referenzen mit Referenz.display angegeben werden oder direkt auf einen Practitioner referenziert wird. Im Falle, dass ein HealthcareService referenziert wird, SOLLTEN die gleichen Informationen wie in HealthcareService.type angegeben werden. Seitens der aktuellen Spezifikation werden keine Vorgaben bezüglich der zu verwendenden Terminologie gemacht. Entsprechend verwendete Kataloge müssen als CodeSystem-Ressource exponiert werden.
Schedule.specialty
Bedeutung: Welche Fachrichtung(en) führen die Behandlungsleistungen, die durch diesen Kalender erfasst werden, aus?
Hinweis: Die Fachrichtung(en) sollte(n) im Schedule angegeben werden, falls unter Schedule.actor nur Referenzen mit Referenz.display angegeben werden oder direkt auf einen Practitioner referenziert wird. Im Falle, dass ein HealthcareService referenziert wird, SOLLTEN die gleichen Informationen wie in HealthcareService.specialty angegeben werden.
Schedule.actor
Bedeutung: Für welche Akteure wird der Kalender geführt?
Hinweis: Nicht alle Target-Ressourcen dieser Referenz existieren als Profil innerhalb des ISiK-Basismoduls oder ISiK-Terminplanung. Für alle Target-Ressourcen sollte ein Displaywert für die Referenz angegeben werden. Nur für HealthcareService und Practitioner MUSS Reference.reference angegeben werden.
Interaktionen
Für die Ressource Schedule MUSS die REST-Interaktion "READ" implementiert werden.
Der Suchparameter "_id" MUSS unterstützt werden:
Beispiele:
GET [base]/Schedule?_id=103270
Anwendungshinweise: Weitere Informationen zur Suche nach "_id" finden sich in der FHIR-Basisspezifikation - Abschnitt "Parameters for all resources".
Der Suchparameter "active" MUSS unterstützt werden:
Beispiele:
GET [base]/Schedule?active=true
Anwendungshinweise: Weitere Informationen zur Suche nach "Schedule.active" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "service-type" MUSS unterstützt werden:
Beispiele:
GET [base]/Schedule?service-type=http://example.org/fhir/CodeSystem/ScheduleServiceType|CT
Anwendungshinweise: Weitere Informationen zur Suche nach "Schedule.serviceType" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "specialty" MUSS unterstützt werden:
Beispiele:
GET [base]/Schedule?specialty=urn:oid:1.2.276.0.76.5.114|535
Anwendungshinweise: Weitere Informationen zur Suche nach "Schedule.specialty" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "actor" MUSS unterstützt werden:
Beispiele:
GET [base]/Schedule?actor=Practitioner/ISiKPractitionerExample
Anwendungshinweise: Weitere Informationen zur Suche nach "Schedule.actor" finden sich in der FHIR-Basisspezifikation - Abschnitt "reference".
Beispiele
{ "resourceType": "Schedule", "id": "ISiKKalenderExample", "meta": { "profile": [ "https://gematik.de/fhir/isik/v2/Terminplanung/StructureDefinition/ISiKKalender" ] }, "active": true, "serviceType": [ { "coding": [ { "code": "124", "system": "http://terminology.hl7.org/CodeSystem/service-type" } ] } ], "specialty": [ { "coding": [ { "code": "010", "system": "urn:oid:1.2.276.0.76.5.114" } ] } ], "actor": [ { "reference": "Practitioner/example", "display": "Dr. Fleming" } ] }