Svarskoder och systemloggar för WS-kontrakt i Samtyckestjänsten
- Peter Leader
Owned by Peter Leader
nov. 13, 2023
4 min read
Loading data...
Dokumenthistorik
| Datum | Version | Namn | Förändring |
|---|---|---|---|
| 1.0 | Former user (Deleted) | Dokumenterat svarskoder i och med omskrivning av samtyckestjänsten |
Innehåll
Gemensamt för alla kontrakt
Systemloggar
När något går fel i anropet info-loggas följande meddelande: Consent service exception: felmeddelande.
Den fetstilade texten byts ut mot de felmeddelande som genererades när anropet gjordes.
Resultatobjekt i WS-svar
Vid normalt systemflöde returneras resultatkoder som indikerar om förfrågan gick bra eller om det fanns saker att anmärka på.
De resultatkoder som finns definierade/används vid fel är som följer:
INFO - En delmängd av de efterfrågade artefakterna har valideringsfel vilka måste åtgärdas för att få ett komplett svar från begärd tjänst.
VALIDATIONERROR - En eller flera av de angivna artefakterna har valideringsfel och måste åtgärdas för att utföra begärd tjänst.
INVALIDSTATE - Den efterfrågade handlingen är redan utförd
NOTFOUND - Angiven artefakt finns inte lagrad i databasen. Begärd tjänst utfördes inte.
ALREADYEXISTS - Angiven artefakt finns redan lagrad i databasen. Begärd tjänst utfördes inte.
ACCESSDENIED - Behörighet saknas för att utföra begärd handling
Ett beskrivande felmeddelande skickas även med om frågan inte gick igenom.
<ns2:result>
<ns2:resultCode>INFO</ns2:resultCode>
<ns2:resultText>Beskrivande felmeddelande</ns2:resultText>
</ns2:result>
<ns2:result>
<ns2:resultCode>VALIDATIONERROR</ns2:resultCode>
<ns2:resultText>Beskrivande felmeddelande</ns2:resultText>
</ns2:result>
<ns2:result>
<resultCode>NOTFOUND</resultCode>
<resultText>Beskrivande felmeddelande</resultText>
</ns2:result>
<ns2:result>
<resultCode>ALREADYEXISTS</resultCode>
<resultText>Beskrivande felmeddelande</resultText>
</ns2:result>
<ns2:result>
<resultCode>INVALIDSTATE</resultCode>
<resultText>Beskrivande felmeddelande</resultText>
</ns2:result>
Samtyckestjänsten
OBS!
Understruken text visar namn på felaktigt element i anropet
element(1,2,3.....) ersätts med värdet från det understrukna felaktiga elementet i anropet
| Kontrakt | Felorsak | Felmeddelande | Felkod (resultCode) |
|---|---|---|---|
| RegisterExtendedConsent | assertionId är odefinierad, tom eller ogiltig | Valideringsfel: är inte ett giltigt UUID för element | VALIDATION_ERROR |
Någon av följande fält är odefinerade, tom eller ogiltig:
| Valideringsfel: ogiltig element | ||
| Valideringsfel: element är obligatoriskt. | ||
| Valideringsfel: Angiven typ för personidentitet element finns ej i systemet | ||
| Ogiltigt format på personidentitet för angiven typ element | ||
| Angiven OID element är inte giltig för identitet | ||
Något av följande fält är ogiltigt:
| Valideringsfel: angivet id för element har ogiltigt format | ||
| Datumspannet startDate - endDate är ogiltigt | Valideringsfel: angivet datumspann är ogiltigt | ||
Någon av följande fält har felaktig längd:
| Valideringsfel: värdet för parameter element får inte överstiga hsaIdMaxLängd tecken | ||
Något av följande fält har felaktig längd:
| Valideringsfel: värdet för parameter element får inte överstiga 256 tecken | ||
| reasonText har felaktig längd i registerAction (om angiven) | Valideringsfel: värdet för parameter element får inte överstiga 1024 tecken | ||
| Angivet assertionId finns redan registrerat | Samtycke med assertionId element finns redan registrerad | ALREADYEXISTS | |
| GetExtendedConsentsForPatient |
| Valideringsfel: element är obligatoriskt. | VALIDATION_ERROR |
| Angiven root i patientId är ogiltig | Valideringsfel: Angiven typ för personidentitet finns ej i systemet | ||
| Angiven extension i patientId är ogiltig för root | Ogiltigt format på personidentitet för angiven typ element | ||
| Inkompatibla värden på root och extension | Angiven OID element är inte giltig för identitet | ||
| DeleteExtendedConsent | Angivet assertionId är odefinierad, tom eller ogiltig | Valideringsfel: element är inte ett giltigt UUID för assertionId | VALIDATION_ERROR |
| Valideringsfel: element är obligatoriskt | ||
Något av följande fält är odefinierade eller tom:
| Valideringsfel: element är obligatoriskt | ||
Någon av följande fält är ogiltiga:
| Valideringsfel: angivet id för element har ogiltigt format | ||
Någon av följande fält har felaktig längd:
| Valideringsfel: värdet för parameter element får inte överstiga hsaIdMaxLängd tecken | ||
Något av följande fält har felaktig längd:
| Valideringsfel: värdet för parameter element får inte överstiga 256 tecken | ||
| reasonText har felaktig längd i deleteAction (om angiven) | Valideringsfel: värdet för parameter element får inte överstiga 1024 tecken | ||
| Samtycke med angivet assertionId saknas | Inget samtycke med id finns registrerad | NOTFOUND | |
| Samtycke med assertionId är bottaget | Samtycket med assertionId är redan borttagen | INVALIDSTATE | |
| Samtycke med assertionId är återkallat | Samtycket med assertionId är redan återkallad | INVALIDSTATE | |
| CancelExtendedConsent | Angivet assertionId är odefinierad, tom eller ogiltig | Valideringsfel: element är inte ett giltigt UUID för assertionId | VALIDATION_ERROR |
| Valideringsfel: element obligatoriskt | ||
Något av följande fält är odefinierade eller tom:
| Valideringsfel: element är obligatoriskt | ||
Någon av följande fält är ogiltiga:
| Valideringsfel: angivet id för element har ogiltigt format | ||
Någon av följande fält har felaktig längd:
| Valideringsfel: värdet för parameter element får inte överstiga hsaIdMaxLängd tecken | ||
Något av följande fält har felaktig längd:
| Valideringsfel: värdet för parameter element får inte överstiga 256 tecken | ||
| reasonText har felaktig längd i cancellationAction (om angiven) | Valideringsfel: värdet för parameter element får inte överstiga 1024 tecken | ||
| Samtycke med angivet assertionId saknas | Inget samtycke med id finns registrerad | NOTFOUND | |
| Samtycke med assertionId är bottaget | Samtycket med assertionId är redan borttagen | INVALIDSTATE | |
| Samtycke med assertionId är återkallat | Samtycket med assertionId är redan återkallad | INVALIDSTATE | |
| CheckConsent | AccessingActor är odefinierad | Valideringsfel: Alla uppgifter måste vara angivna för accessingActor | VALIDATION_ERROR |
Något av följande fält är odefinierad eller tom:
| Valideringsfel: element är obligatoriskt. | ||
Något av följande fält har felaktig längd:
| Valideringsfel: värdet för parameter element får inte överstiga hsaIdMaxLängd | ||
| Angiven root i patientId är ogiltig | Valideringsfel: Angiven typ för personidentitet finns ej i systemet | ||
| Angiven extension i patientId är ogiltig för root | Ogiltigt format på personidentitet för angiven typ element | ||
| Inkompatibla värden på root och extension | Angiven OID element är inte giltig för identitet | ||
| GetConsentsForPatient |
| Valideringsfel: element är obligatoriskt. | VALIDATION_ERROR |
Angiven root i patientId är ogiltig | Valideringsfel: Angiven typ för personidentitet finns ej i systemet | ||
| Angiven extension i patientId är ogiltig för root | Ogiltigt format på personidentitet för angiven typ element | ||
| Inkompatibla värden på root och extension | Angiven OID element är inte giltig för identitet | ||
| GetConsentsForCareProvider | careProviderId är odefinierad eller tom | Valideringsfel: element är obligatoriskt | VALIDATION_ERROR |
| careProviderId är ogiltig | Valideringsfel: angivet id element har ogiltigt format | ||
| careProviderId har felaktig längd | Valideringsfel: värdet för parameter element får inte överstiga hsaIdMaxLängd | ||
| createdOnOrAfter ogiltigt format | Valideringsfel: är inte ett giltigt datum för element |