providePatientData

Zweck

Ein Standort liefert an die fTTP die angeforderten Patientendaten. Der Standort hat zuvor seine Tasks abgerufen (vgl. requestTasks) und eine Aufgabe "send-idat" zugewiesen bekommen.

Voraussetzung
  • Der spezifizierte API-KEY muss valide sein und über die nötigen Rechte zum Aufruf der Funktion verfügen.
  • Die übermittelten IDAT müssen valide sein
  • Die TaskId muss valide sein
Aufruf und Rückgabe

Die bereitgestellte Funktionalität kann per POST-Request aufgerufen werden. Die erforderlichen Angaben werden per POST-BODY in Form von FHIR Parameters übermittelt.

<HOST>:<PORT>/ttp-fhir/fhir/dispatcher/$providePatientData

Der Funktionsaufruf liefert eine Parameters-Ressource bestehend aus multiplen Multi-Part-Parametern zurück.

Invocations

URL: [base]/$providePatientData

This operation changes content

Parameters (In)

NameCardinalityTypeDocumentation
taskId1..1id

Identifikator der Aufgabe; Rückreferenzierung auf die aus der providePatientData Operation erhaltene Aufgabe.

target1..1string

Angabe der Ziel-Domain (Standort)

apikey1..1string

Gültiger API-KEY zur Authentifizierung und Authorisierung des aufrufenden Systems gegenüber dem verarbeitenden Workflow-Manager

patient1..1Patient(IDAT)

Patient-Ressource die, soweit bekannt, die in der der taskId assoziierten Aufgabe definierten identifizierenden Datenelemente eines Patienten enthält.

Ein Standort liefert an die fTTP die angeforderten Patientendaten. Der Standort hat zuvor Tasks abgerufen und die hier mittels taskId referenzierte Aufgabe 'send-idat' zugewiesen bekommen.

Der Parameter "patient" enthält eine Patient-Ressource entsprechend dem IDAT-Profil:

url1..1System.StringFixed Value
useΣ ?!0..0codeBinding
typeΣ0..0codeBinding
textΣ0..0string
lineΣ0..0string
cityS Σ1..1string
districtΣ0..0string
stateΣ0..0string
postalCodeΣ0..0string
countryΣ0..0string
periodΣ I0..0Period
url1..1uriFixed Value
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
url1..1System.StringFixed Value
identifierΣ0..0Identifier
activeΣ ?!0..0boolean
useS Σ ?!0..1codeBinding
textΣ0..0string
familyS Σ0..1string
givenS Σ0..*string
url1..1System.StringFixed Value
valueCodecode
suffixS Σ0..*string
periodΣ I0..0Period
telecomΣ I0..0ContactPoint
genderS Σ0..1codeBinding
birthDateS Σ0..1date
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..0string
lineS Σ0..*string
cityS Σ0..1string
districtΣ0..0string
stateΣ0..0string
postalCodeS Σ0..1string
countryΣ0..0string
periodΣ I0..0Period
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textS Σ1..1string
photoI0..0Attachment
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
preferredS1..1booleanFixed Value
generalPractitionerI0..0Reference(Organization | Practitioner | PractitionerRole)
managingOrganizationΣ I0..0Reference(Organization)

Im Erfolgsfall wird er HTTP Statuscode 200 zurückgegeben.

Im Fehlerfall wird einer der folgenden HTTP Statuscodes in Verbindung mit einer OperationOutcome-Ressource zurückgegeben:

  • 400: Fehlende oder fehlerhafte Parameter.
  • 401: Fehlende Authentifizierung oder Autorisierung.
  • 422: Fehlende oder falsche IDAT-Attribute.
Beispiel

Beispielhafter Request-Body:

<Parameters xmlns="http://hl7.org/fhir">
    <parameter>
        <name value="taskId" />
        <valueId value="064ddebf-b20e-468a-97fd-88097bcdbc11" />
    </parameter>
    <parameter>
        <name value="target" />
        <valueString value="codex" />
    </parameter>
    <parameter>
        <name value="apikey" />
        <valueString value="abcdef12345" />
    </parameter>
    <parameter>
        <name value="patient" />
        <resource>
            <Patient>
                <extension url="http://hl7.org/fhir/StructureDefinition/patient-birthPlace">
                    <valueAddress>
                        <city value="Musterhausen" />
                    </valueAddress>
                </extension>
                <name>
                    <family value="Mustermann" />
                    <given value="Martin" />
                    <prefix value="Dr. med.">
                        <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier">
                            <valueCode value="AC" />
                        </extension>
                    </prefix>
                </name>
                <gender value="male" />
                <birthDate value="1965-12-03" />
            </Patient>
        </resource>
    </parameter>
</Parameters>