addConsent
Fügt Einwilligungsinformationen für einen Patienten hinzu. Es darf sich um einen neuen Patienten handeln.
Zurückgegeben wird der errechnete strukturierte Consent.
Voraussetzung
- Spezifizierte Domäne muss angelegt sein
Aufruf und Rückgabe
Invocations
URL: [base]/$addConsent
This operation changes content
Parameters (In)
Name | Cardinality | Type | Documentation |
patient | 1..1 | Patient | Patient-Ressource, entsprechend dem Profil http://fhir.de/ConsentManagement/StructureDefinition/Patient |
domain | 1..1 | string | Angabe der Einwilligungsdomaene |
questionnaireResponse | 1..1 | QuestionnaireResponse | QuestionnaireResponse-Ressource zum Patienten, die sich auf ein entsprechendes QuestionnaireComposed bezieht. Entsprechend dem Profil http://fhir.de/ConsentManagement/StructureDefinition/QuestionnaireComposed. |
documentReference | 0..* | DocumentReference | unstrukturiertes Originaldokument (entsprechend dem Profil http://fhir.de/ConsentManagement/StructureDefinition/DocumentReference) |
provenance | 0..1 | Provenance | Herkunftsinformationen (entsprechend dem Profil http://fhir.de/ConsentManagement/StructureDefinition/Provenance). Umsetzungshinweis: mehrere Unterschriften für ein Dokument sind ggf. als mehrere signature-Elemente in der selben Provenance-Ressource abzubilden. |
_profile | 0..1 | canonical | Angabe um Ausgabeprofil festzulegen. Default ist die gics-Variante; alternativ das Profil aus dem IG Einwilligungsmanagement. |
Return Values (Out)
Name | Cardinality | Type | Documentation |
return | 1..1 | Bundle | Bundle vom Typ collection, das die errechneten Consent-Ressourcen enthält. |
Liefert alle Consente einer Person einer spezifischen Einwilligungsdomaene, die sich aus den übermittelten Informationen ergeben. Die Rückgabe erfolgt als Bundle vom Typ "collection". Das Bundle enthält je Consent einen BundleEntry, der alle für den spezifischen Consent relevanten Ressourcen (z.B. TemplateFrame, QuestionnaireComposed, QuestionnaireResponse, Provenance) enthält. Details zu den verwendeten Profilen unter https://simplifier.net/guide/einwilligungsmanagement/igeinwilligungsmanagement . Hinweis: gICS verwirft eventuell in den übermittelten Ressourcen gesetzte id-Werte und ersetzt sie durch eigene.
Beispiel
(Q3/2022)
Error Codes
Beschreibung | HTTP Error Code |
---|---|
Fehlende Parameter | 400 Bad Request |
Parameter mit unbekanntem Inhalt | 404 Not found |
Leere Ergebnismenge trotz gültiger Parameter | 200 Ok |