Operation: Patientenankunft dokumentieren

Inhalt

Beschreibung und fachlicher Kontext
FHIR-Operation
Request
Response

Beschreibung und fachlicher Kontext

Beim Dokumentieren der Patientenankunft handelt es sich um eine custom operation in FHIR.

Mit dieser Operation kann dem 116117 Terminservice die Information übermittelt werden, ob ein Patient zu einem Termin erschienen ist oder nicht. Dabei handelt es sich um eine Änderung des Status' der Terminbuchung.

FHIR-Operation

Name	KBV_OD_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Appointment_Patient_Arrival_Update
Type	OperationDefinition
Kind	`operation`
Code	`patientenankunft_update`
Canonical URL	`https://fhir.kbv.de/OperationDefinition/KBV_OD_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Appointment_Patient_Arrival_Update`

Invocations

URL: [base]/Appointment/[id]/$patientenankunft_update

Parameters (In)

Name	Cardinality	Type	Binding	Documentation
status	1..1	code	KBV_VS_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Appointment_Patient_Arrival_Update (required)	Angabe, ob der Patient erschienen ist oder nicht arrived = Patient erschienen noshow = Patient nicht erschienen

BITTE BEACHTEN: Diese Operation hat keinen Output-Parameter. Im Erfolgsfall kommt also eine Antwort ohne Response Body zurück. Im Fehelrfall kommt dennoch ein OperationOutcome im Response Body zurück.

Request

Die FHIR-Operation zum Dokumentieren der Patientenankunft erfordert einen POST-Request.

Die ID der Terminbuchung, für die die Patientenankunft dokumentiert werden soll, muss in der URL übergeben werden. In der folgenden Tabelle ist für die Terminbuchungs-ID der Platzhalter [id] in der Zeile URL eingetragen. Die Terminbuchungs-ID ist im Feld Appointment.id der Appointment-Ressource zu finden.

Die FHIR-Operation erfordert den Eingabeparameter status. Dieser Eingabeparameter muss in einer Parameters-Ressource im Request Body übergeben werden (siehe hierzu Abschnitt Request Body).

HTTP Method	`POST`
URL	`https://terminsynchronisation.eterminservice.kv-safenet.de/tvs/terminsynchronisation/api/Appointment/[id]/$patientenankunft_update`
Request Body	`[parameters]`

Request Header

Folgende Request Header werden von den Systemen des 116117 Terminservices unterstützt und verarbeitet:

Header	Verpflichtend?	Beschreibung	Wert
`Authorization`	ja	Im Authentisierungsverfahren erhaltener ACCESS_TOKEN als Bearer Token	`Bearer ey...`
`Content-Type`	ja	Gibt den ursprünglichen Medien- bzw. Dateitypen der Ressource an. Der 116117 Terminservice unterstützt die Werte `fhir+xml` und `xml`. Es wird empfohlen, den Wert `fhir+xml` für diesen Header zu setzen.	`application/fhir+xml`
`Accept`	nein	Gibt an, welche Inhaltstypen die Systeme des Anfragenden verstehen. Der 116117 Terminservice unterstützt die Werte `fhir+xml` und `xml`. Es wird empfohlen, den Wert `fhir+xml` für diesen Header zu setzen.	`application/fhir+xml`

Request Body

Der Request Body muss eine Parameters-Ressource mit dem Eingabeparameter status enthalten. status muss den Wert des neuen Status' der Terminbuchung besitzen.

Für das Dokumentieren der Patientenankunft gibt es zwei zulässige Status:

Status in FHIR	Fachliche Bedeutung	Erklärung
`arrived`	erschienen	Der Patient ist zum Termin erschienen.
`noshow`	nicht erschienen	Der Patient ist NICHT zum Termin erschienen.

Eine ausführliche Beschreibung des Parameters-Profils ist hier in der offiziellen HL7-Dokumentation zu finden.

Beispiel

# Dokumentiere die Patientenankunft für die Terminbuchung mit der ID "1ec4f924-cd75-45eb-97df-8848ff792fd5"
POST https://terminsynchronisation.eterminservice.kv-safenet.de/tvs/terminsynchronisation/api/Appointment/1ec4f924-cd75-45eb-97df-8848ff792fd5/$patientenankunft_update
Content-Type: application/fhir+xml

WICHTIG: Der Request Body mit der Parameters-Ressource ist in diesem Beispiel NICHT enthalten. Ein Beispiel für eine Parameters-Ressource ist hier im vorliegenden Projekt zu finden. Das Beispiel ist auch noch einmal am Ende dieser Seite dargestellt.

Response

Die FHIR-Operation gibt bei Erfolg den HTTP-Statuscode 200 OK und die neue Version der aktualisierten Terminbuchung als Response Header zurück. Auf eine Rückgabe der geänderten Ressource wird hierbei verzichtet, da nur der Status der Terminbuchung entsprechend des Eingabeparameters geändert wird.

Im Fehlerfall wird ein dem Fehler entsprechender HTTP-Statuscode (bspw. 400 Bad Request oder 500 Internal Server Error) sowie ein OperationOutcome im Response Body zurückgegeben. Dieses OperationOutcome enthält Details zum aufgetretenen Fehler.

Response Header

Folgende Response Header werden von den Systemen des 116117 Terminservices gesetzt und an den Anfragenden zurückgesendet:

Header	Beschreibung	Wert
`Content-Type`	Gibt den ursprünglichen Medien- bzw. Dateitypen der Ressource an.	`application/fhir+xml`
`ETag`	Gibt die Version der aktualisierten Ressource an.	`2`

Response Body

Im Erfolgsfall wird KEIN Response Body zurückgegeben.

Im Fehlerfall ist im Response Body ein OperationOutcome enthalten. Details hierzu sind unter Profil: Fehler (OperationOutcome) zu finden.

Beispiele

Alle Beispiele für den Fehlerfall sind hier im vorliegenden Projekt zu finden.

<Parameters xmlns="http://hl7.org/fhir">
    <parameter>
        <name value="status" />
        <valueCode value="arrived" />
    </parameter>
</Parameters>

<OperationOutcome xmlns="http://hl7.org/fhir">
    <id value="cc8e9f90-31ad-4021-9639-e5b940a88a94" />
    <meta>
        <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_OperationOutcome_Error|1.0.0" />
    </meta>
    <text>
        <status value="extensions" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <issue>
        <severity value="fatal" />
        <code value="value" />
        <details>
            <coding>
                <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Errors" />
                <code value="TVSTS0000" />
                <display value="Sonstiger Fehler. Unter diagnostics finden Sie n&#228;here Informationen zum Fehler." />
            </coding>
        </details>
        <diagnostics value="Ung&#252;ltiger Input-Parameter" />
    </issue>
</OperationOutcome>

<OperationOutcome xmlns="http://hl7.org/fhir">
    <id value="81758936-362c-411f-9d95-7fac5b19deb6" />
    <meta>
        <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_OperationOutcome_Error|1.0.0" />
    </meta>
    <text>
        <status value="extensions" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <issue>
        <severity value="fatal" />
        <code value="value" />
        <details>
            <coding>
                <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Errors" />
                <code value="TVSTS0018" />
                <display value="Die Dringlichkeit ist ung&#252;ltig." />
            </coding>
        </details>
    </issue>
</OperationOutcome>