Query API: RelatedPerson
Profile: EPARelatedPerson
Voraussetzungen
Dem Medication Service MÜSSEN zur Auswertung in Operationen für jede Aktivität die folgenden Informationen bereitstehen:
- Name des Nutzers
- Nutzergruppe/Rolle ((profession-)oid)
- Kennung (Telematik-ID oder KVNR)
- Hinweis auf eine gültige Befugnis des aktuellen Benutzers (requestor)
HTTP Header-Parameter
Ein ePA-Client MUSS die folgenden HTTP Header bei einer Anfrage an den Medication Service setzen:
| Name | Anforderung | Datentyp | Beschreibung |
|---|---|---|---|
| x-insurantid | MUSS | String | Health Record Identifier |
| x-useragent | KANN | String | User Agent Information |
| X-Request-ID | MUSS | String | UUID der Nachricht |
Wiederholungsintervalle
Die folgenden Wiederholungsintervalle werden im Falle einer Fehlerantwort definiert:
- '409' Conflict (statusMismatch)
- etwa 24 Stunden
- '500' Internal Error
- etwa 10 Minuten
Erlaubte Nutzergruppen
| professionOID |
|---|
| oid_versicherter |
| oid_praxis_arzt |
| oid_krankenhaus |
| oid_institution |
| oid_krankenhaus |
| oid_institution-vorsorge-reha |
| oid_zahnarztpraxis |
| oid_praxis_psychotherapeut |
| oid_institution-oegd |
| oid_öffentliche_apotheke |
| oid_institution-pflege |
| oid_institution-geburtshilfe |
| oid_praxis-physiotherapeut |
| oid_institution-arbeitsmedizin |
Interaktion (Query RelatedPerson)
GET [base]/epa/medication/api/v1/fhir/RelatedPerson
OperationId: listRelatedPerson_MedicationSvc
Anfragen an die RelatedPerson-Ressource können über die RESTful API mittels HTTP GET-Anfragen durchgeführt werden. Dabei können spezifische Suchparameter genutzt werden, um die Anfragen zu verfeinern.
Bei Anfragen an die QueryAPI für die RelatedPerson-Ressource wird die Antwort als ein FHIR Bundle des Typs searchset zurückgegeben. Dieses Bundle enthält eine Sammlung von Einträgen, die jeweils eine Instanz der RelatedPerson-Ressource oder weitere Ressourcen im Zusammenhang mit der Abfrage enthalten können.
Suchparameter
| Parameter | Type | Definition | Beschreibung | Anforderung |
|---|---|---|---|---|
| _id | token | http://hl7.org/fhir/SearchParameter/Resource-id | Resource.id | MUSS |
| _lastUpdated | date | http://hl7.org/fhir/SearchParameter/Resource-lastUpdated | Resource.meta.lastUpdated | MUSS |
| name | string | http://hl7.org/fhir/SearchParameter/RelatedPerson-name | RelatedPerson.name | MUSS |
Suche per Include oder RevInclude
| RevInclude |
|---|
| Provenance.agent |
Antwort-Status-Codes
| Status Code | Bedingung | Error Code | Bemerkung |
|---|---|---|---|
| 200 | Successful operation | ||
| 400 | Unknown search parameter | EPA OperationOutcome | |
| 400 | Invalid query parameter(s) | EPA OperationOutcome | |
| 400 | Invalid request | EPA OperationOutcome | |
| 403 | Requestor role is not in the list of allowed user groups | invalidOid | |
| 403 | Requestor is not entitled | notEntitled | |
| 403 | ID-Token or Insurant-ID mismatch | EPA OperationOutcome | |
| 404 | Unknown resource type | EPA OperationOutcome | |
| 404 | Health record is in state UNKNOWN or INITIALIZED | noHealthRecord | (siehe 'Wiederholungsintervalle') |
| 409 | Health record is in state SUSPENDED | statusMismatch | (siehe 'Wiederholungsintervalle') |
| 423 | If the insurant objected to the medication process or objected to the submission of prescription and dispensation data into the ePA system, the Medication Service is locked. | locked | |
| 500 | Any other error | internalError | (siehe 'Wiederholungsintervalle') |
Serviceübergreifende Error Codes ohne Verweis auf EPA OperationOutcome MÜSSEN mit dem entsprechenden HTTP Status Code vom Medication Service mit dem Media Type application/json nach folgendem Schema zurückgegeben werden:
{
"errorCode": "statusMismatch"
}
Interaktion (RelatedPerson Instance API)
GET [base]/epa/medication/api/v1/fhir/RelatedPerson/[id]
OperationId: getRelatedPersonById_MedicationSvc
Um spezifische Details zu einer einzelnen RelatedPerson mittels der RESTful API zu erhalten, kann die RelatedPerson Instance API verwendet werden, sodass eine HTTP GET-Anfrage an den Endpunkt /RelatedPerson/[id] gerichtet wird.
Antwort-Status-Codes
| Status Code | Bedingung | Error Code | Bemerkung |
|---|---|---|---|
| 200 | Successful operation | ||
| 400 | Unknown search parameter | EPA OperationOutcome | |
| 400 | Invalid query parameter(s) | EPA OperationOutcome | |
| 400 | Invalid request | EPA OperationOutcome | |
| 403 | Requestor role is not in the list of allowed user groups | invalidOid | |
| 403 | Requestor is not entitled | notEntitled | |
| 403 | ID-Token or Insurant-ID mismatch | EPA OperationOutcome | |
| 404 | Resource is not known | EPA OperationOutcome | |
| 404 | Unknown resource type | EPA OperationOutcome | |
| 404 | Health record is in state UNKNOWN or INITIALIZED | noHealthRecord | (siehe 'Wiederholungsintervalle') |
| 409 | Health record is in state SUSPENDED | statusMismatch | (siehe 'Wiederholungsintervalle') |
| 423 | If the insurant objected to the medication process or objected to the submission of prescription and dispensation data into the ePA system, the Medication Service is locked. | locked | |
| 500 | Any other error | internalError | (siehe 'Wiederholungsintervalle') |
Serviceübergreifende Error Codes ohne Verweis auf EPA OperationOutcome MÜSSEN mit dem entsprechenden HTTP Status Code vom Medication Service mit dem Media Type application/json nach folgendem Schema zurückgegeben werden:
{
"errorCode": "statusMismatch"
}