Konformitätserklärung (CapabilityStatement)
Jede Instanz eines bestätigungsrelevanten Systems MUSS an ihrem Endpunkt eine CapabilityStatement-Ressource bereitstellen.
Hierzu MUSS die capabilities-Interaktion gemäß FHIR-Spezifikation unterstützt werden. Der "MODE"-Parameter kann ignoriert werden.
Das CapabilityStatement in dieser Spezifikation stellt 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.
Eine Server-Instanz MUSS ihrerseits ein CapabilityStatement vom kind= "instance" liefern und im Element software den Namen und die Versionsnummer angeben.
Das CapabilityStatement der Instanz MUSS alle Funktionalitäten auflisten, die im folgenden CapabilityStatement mit "SHALL" gekennzeichnet sind. Das CapabilityStatement KANN darüber hinaus die mit "MAY" gekennzeichneten Funktionalitäten, sowie weitere Funktionalitäten auflisten, sofern diese in der Instanz implementiert wurden.
Die Verwendung der CapabilityStatement-Expectation-Extension ist im CapabilityStatement der Server-Instanz nicht erforderlich.
CapabilityStatement (Requirement) ISiK-Terminplanung
Das nachfolgende CapabilityStatement repräsentiert die Anforderungen an ein Termin-Repository.
Link Simplifier Profil Übersicht
REST Capabilities Server
| Mode | Server |
Resource Interactions
| Resource Type | Supported Profiles | Read | SearchType | Patch | Create | Update |
|---|---|---|---|---|---|---|
| Schedule | SHALL | SHALL | ||||
| Slot | SHALL | SHALL | ||||
| Appointment | SHALL | SHALL | SHALL | |||
| Communication | SHALL | SHALL | SHALL | SHALL | ||
| HealthcareService | SHALL | SHALL | ||||
| Binary | SHALL | SHALL |
Operations per resource type
Schedule
No operations are stated for this resource type
Slot
No operations are stated for this resource type
Appointment
| Operation | Reference | Documentation | Level |
|---|---|---|---|
| book | Book | Die $book-Operation ermöglicht einem Termin-Requestor einen Termin in einem Termin-Repository zu buchen bzw. zu verschieben. | SHALL |
Communication
No operations are stated for this resource type
HealthcareService
No operations are stated for this resource type
Binary
No operations are stated for this resource type
Search Parameters per resource type
Schedule
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | **Beispiel:** `GET [base]/[Resourcetype]?_id=103270` **Anwendungshinweis:** Der Parameter `_id` wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource... | SHALL |
| _tag | token | **Beispiel:** `GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review` **Anwendungshinweis:** Weitere Details siehe FHIR-Kernspezifikation, Abschnitt ... | SHALL |
| _count | number | **Beispiel:** `GET [base]/[Resourcetype]?_count=100` **Anwendungshinweis:** Weitere Details siehe FHIR-Kernspezifikation, Abschnitt [Page Count](https://www.hl7.org/... | SHALL |
| _has | string | **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 al... | MAY |
| active | token | **Beispiel:** `GET [base]/Schedule?active=true` **Anwendungshinweis:** Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/search.html#token). | SHALL |
| service-type | token | **Beispiel:** `GET [base]/Schedule?service-type=http://example.org/fhir/CodeSystem/ScheduleServiceType|CT` **Anwendungshinweis:** Weitere Details siehe [FHIR-Kernspe... | SHALL |
| specialty | token | **Beispiel:** `GET [base]/Schedule?specialty=urn:oid:1.2.276.0.76.5.114|535` **Anwendungshinweis:** Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fh... | SHALL |
| actor | reference | **Beispiel:** `GET [base]/Schedule?actor=Practitioner/ISiKPractitionerExample` **Anwendungshinweis:** Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/... | SHALL |
Supported Reverse Includes:
- Slot:schedule
- Schedule:actor
Slot
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | **Beispiel:** `GET [base]/[Resourcetype]?_id=103270` **Anwendungshinweis:** Der Parameter `_id` wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource... | SHALL |
| _tag | token | **Beispiel:** `GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review` **Anwendungshinweis:** Weitere Details siehe FHIR-Kernspezifikation, Abschnitt ... | SHALL |
| _count | number | **Beispiel:** `GET [base]/[Resourcetype]?_count=100` **Anwendungshinweis:** Weitere Details siehe FHIR-Kernspezifikation, Abschnitt [Page Count](https://www.hl7.org/... | SHALL |
| _has | string | **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 al... | MAY |
| schedule | reference | **Beispiel:** `GET [base]/Slot?schedule=Schedule/ISiKKalenderExample&start=2022-12-10T09:00:00Z` `GET [base]/Slot?schedule=Schedule/ISiKKalenderExample` **Anwendungsh... | SHALL |
| status | token | **Beispiel:** `GET [base]/Slot?status=free&schedule=Schedule/ISiKTerminExample` `GET [base]/Slot?status=free&schedule.actor:Practitioner.name=Musterarzt` **Anwendungshi... | SHALL |
| start | date | **Beispiel:** `GET [base]/Slot?start=2022-12-10T09:00:00Z&schedule=Schedule/ISiKTerminExample` `GET [base]/Slot?start=2022-12-10T09:00:00Z&schedule.actor:Practitioner.name=Muster... | SHALL |
Supported Includes:
- Slot:schedule
Supported Reverse Includes:
- Appointment:slot
Appointment
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | **Beispiel:** `GET [base]/[Resourcetype]?_id=103270` **Anwendungshinweis:** Der Parameter `_id` wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource... | SHALL |
| _tag | token | **Beispiel:** `GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review` **Anwendungshinweis:** Weitere Details siehe FHIR-Kernspezifikation, Abschnitt ... | SHALL |
| _count | number | **Beispiel:** `GET [base]/[Resourcetype]?_count=100` **Anwendungshinweis:** Weitere Details siehe FHIR-Kernspezifikation, Abschnitt [Page Count](https://www.hl7.org/... | SHALL |
| _has | string | **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 al... | MAY |
| status | token | **Beispiel:** `GET [base]/Appointment?status=booked` **Anwendungshinweis:** Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/search.html#token)... | SHALL |
| service-type | token | **Beispiel:** `GET [base]/Appointment?service-type=http://example.org/fhir/CodeSystem/ScheduleServiceType|CT` **Anwendungshinweis:** Anwendungshinweise: Bei einer Su... | SHALL |
| specialty | token | **Beispiel:** `GET [base]/Appointment?specialty=urn:oid:1.2.276.0.76.5.114|535` **Anwendungshinweis:** Anwendungshinweise: Bei einer Suche mit dem `:not`-Modifier MÜSS... | SHALL |
| date | date | **Beispiel:** `GET [base]/Appointment?date=2022-12-10T09:00:00Z` **Anwendungshinweis:** Die Suche wird gegen das Element `Appointment.start` ausgewertet. Wei... | SHALL |
| slot | reference | **Beispiel:** `GET [base]/Appointment?slot=Slot/ISiKSlotExample` **Anwendungshinweis:** Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/search... | SHALL |
| actor | reference | **Beispiel:** `GET [base]/Appointment?actor=Patient/ISiKPatientExample` **Anwendungshinweis:** Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4... | SHALL |
Supported Includes:
- Appointment:slot
- Appointment:actor
Communication
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | **Beispiel:** `GET [base]/[Resourcetype]?_id=103270` **Anwendungshinweis:** Der Parameter `_id` wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource... | SHALL |
| _tag | token | **Beispiel:** `GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review` **Anwendungshinweis:** Weitere Details siehe FHIR-Kernspezifikation, Abschnitt ... | SHALL |
| _count | number | **Beispiel:** `GET [base]/[Resourcetype]?_count=100` **Anwendungshinweis:** Weitere Details siehe FHIR-Kernspezifikation, Abschnitt [Page Count](https://www.hl7.org/... | SHALL |
| _has | string | **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 al... | MAY |
| subject | reference | **Beispiel:** `GET [base]/Communication?subject=Patient/ISiKPatientExample` **Anwendungshinweis:** Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhi... | MAY |
| patient | reference | **Beispiel:** `GET [base]/Communication?patient=Patient/ISiKPatientExample` **Anwendungshinweis:** Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhi... | SHALL |
| recipient | reference | **Beispiel:** `GET [base]/Communication?recipient=Practitioner/ISiKPractitionerExample` **Anwendungshinweis:** Weitere Details siehe [FHIR-Kernspezifikation](https:/... | SHALL |
| sender | reference | **Beispiel:** `GET [base]/Communication?sender=Practitioner/ISiKPractitionerExample` **Anwendungshinweis:** Weitere Details siehe [FHIR-Kernspezifikation](https://hl... | SHALL |
Supported Includes:
- Communication:recipient
- Communication:sender
- Communication:subject
HealthcareService
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | **Beispiel:** `GET [base]/[Resourcetype]?_id=103270` **Anwendungshinweis:** Der Parameter `_id` wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource... | SHALL |
| _tag | token | **Beispiel:** `GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review` **Anwendungshinweis:** Weitere Details siehe FHIR-Kernspezifikation, Abschnitt ... | SHALL |
| _count | number | **Beispiel:** `GET [base]/[Resourcetype]?_count=100` **Anwendungshinweis:** Weitere Details siehe FHIR-Kernspezifikation, Abschnitt [Page Count](https://www.hl7.org/... | SHALL |
| _has | string | **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 al... | MAY |
| active | token | **Beispiel:** `GET [base]/HealthcareService?active=true` **Anwendungshinweis:** Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/search.html#to... | SHALL |
| service-type | token | **Beispiel:** `GET [base]/HealthcareService?service-type=http://example.org/fhir/CodeSystem/ScheduleServiceType|CT` **Anwendungshinweis:** Weitere Details siehe [FHI... | SHALL |
| specialty | token | **Beispiel:** `GET [base]/HealthcareService?specialty=urn:oid:1.2.276.0.76.5.114|535` **Anwendungshinweis:** Weitere Details siehe [FHIR-Kernspezifikation](https://h... | SHALL |
| name | string | **Beispiel:** `GET [base]/HealthcareService?name=Medizinische Behandlungseinheit Des Fachbereichs 0100` **Anwendungshinweis:** Weitere Details siehe [FHIR-Kernspezif... | SHALL |
Supported Includes:
- Schedule:actor
- Communication:recipient
- Appointment:actor
Binary
No search parameters are stated for this resource type