Dokumenthistorik
| Datum | Version | Namn | Förändring |
|---|---|---|---|
| 1.0 | Dokumenterat svarskoder i och med omskrivning av spärrtjänsten | |
Innehåll
1. Gemensamt för alla kontrakt
1.1. Systemloggar
När något går fel i anropet info-loggas följande meddelande: Block service exception: felmeddelande.
Den fetstilade texten byts ut mot de felmeddelande som genererades när anropet gjordes.
1.2. 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>
2. Spärrtjänsten (Nationella kontrakt)
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) |
|---|---|---|---|
| CheckBlocks |
| Valideringsfel: patientId/extension/root är obligatoriskt. | VALIDATIONERROR |
| Angiven root i patientId är ogiltig | 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 | ||
| Valideringsfel: Alla aktörsuppgifter måste vara angivna för objektet accessingActor | ||
| Valideringsfel: värdet för parameter careProviderId/careUnitId/employeeId får inte överstiga hsaIdMaxLängd tecken | ||
| Valideringsfel: angivet id element har ogiltigt format. | ||
Några av de angivna informationEntities-elementen innehåller samma värde på rowNumber | Valideringsfel: värdet för rowNumber är duplicerat. Felaktigt rowNumber: element | ||
Några av de angivna informationEntities-elementen innehåller något av följande valideringsfel;
| Informationsresurs(er) innehåller valideringsfel | INFO | |
| RegisterBlock |
| Valideringsfel: informationCareProviderId/extension/root/informationCareUnitId är obligatoriskt. | VALIDATIONERROR |
Angivet blockId är inte ett giltigt UUID | Valideringsfel: element är inte ett giltigt UUID för blockId | ||
| patientId är odefinierad | Valideringsfel: patientId är obligatoriskt. | ||
Angiven root i patientId finns inte i systemet | Angiven typ för personidentitet element 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 | ||
blockType är ogiltig, odefinierad eller tom | Valideringsfel: ogiltig spärrtyp | ||
| Datumspannet informationStartDate - informationEndDate är ogiltigt | Valideringsfel: angivet datumspann är ogiltigt | ||
| Angivet informationStartDate eller informationEndDate har ogiltigt format | Valideringsfel: element är inte ett giltigt datum för informationStartDate/informationEndDate | ||
| excludedInformationTypes är inte en giltig informationstyp | Valideringsfel: informationstypen element är ogiltig | ||
| Angivet blockId eller temporaryRevokeId i någon av de angivna temporaryRevokeRegistration elementen är inte ett giltigt UUID | Valideringsfel: element1 är inte ett giltigt UUID för blockId/temporaryRevokeId | ||
| Angivet endDate eller revokedForCareUnitId i någon av de angivna temporaryRevokeRegistration elementen är odefinierad eller tom | Valideringsfel: endDate/revokedForCareUnitId är obligatoriskt | ||
| Angivet endDate har ogiltigt format | Valideringsfel: element är inte ett giltigt datum för endDate | ||
| Angiven revokedForCareUnitId i någon av de angivna temporaryRevokeRegistration elementen har en ogiltig längd för HSA-ID | Valideringsfel: längden på revokedForCareUnitId är ogiltig, förväntad längd är mellan hsaIdMinLängd och hsaIdMaxLängd | ||
revokedForEmployeeId är angiven i någon av de angivna temporaryRevokeRegistration elementen men har en ogiltig längd för HSA-ID | Valideringsfel: längden på revokedForEmployeeId är ogiltig, förväntad längd är mellan hsaIdMinLängd och hsaIdMaxLängd | ||
| blockType är av typen Outer och informationCareUnitId är inte odefinierad eller tom | Valideringsfel: informationCareUnitId ska inte anges tillsammans med spärrtyp OUTER | ||
| Angivet blockId finns redan registrerat och ingen temporär hävning fanns att registrera | Spärren finns redan registrerad för blockId element | ALREADYEXISTS | |
| Angivet blockId finns inte i databasen | Ingen spärr med id element finns registrerad | NOTFOUND | |
| GetBlocks | Ogiltig root i patientId | Angiven typ för personidentitet element finns ej i systemet | VALIDATIONERROR |
| Ogiltig extension i patientId för annars korrekt 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 | ||
| GetPatientIds | careProviderId är odefinierad eller tom | Valideringsfel: careProviderId är obligatoriskt | VALIDATIONERROR |
| careProviderId överstiger giltig längd för HSA-ID | Valideringsfel: värdet för parameter careProviderId får inte överstiga hsaIdMaxLängd tecken | ||
| careProviderId har ogiltigt format | Valideringsfel: angivet id element har ogiltigt format | ||
| RegisterTemporaryRevoke | Angivet blockId finns inte i databasen | Ingen spärr med id element finns registrerad | NOTFOUND |
| Angivet temporaryRevokeId finns redan i databasen | Den tillfälliga hävningen finns redan registrerad | ALREADYEXISTS | |
| Valideringsfel: element är inte ett giltigt UUID för temporaryRevokdeId | VALIDATIONERROR | |
| endDate är odenfinierad eller tom | Valideringsfel: endDate är obligatoriskt. | ||
| Angivet endDate har ogiltigt format | Valideringsfel: element är inte ett giltigt datum för endDate | ||
| Valideringsfel: längden på revokedForCareUnitId/revokedForEmployeeId är ogiltig, förväntad längd är mellan hsaIdMinLängd och hsaIdMaxLängd | ||
| revokedForCareUnitId är odefinierad eller tom | Valideringsfel: revokedForCareUnit är obligatoriskt | ||
| UnregisterTemporaryRevoke | Angivet temporaryRevokeId finns inte i databasen | Ingen tillfällig hävning med id element finns registrerad | NOTFOUND |
3. Spärradministration (Lokala kontrakt)
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) |
|---|---|---|---|
| CheckBlocks/GetBlocks/GetPatientId | Samma som nationella | ||
| CancelTemporaryExtendedRevoke | Något av följande fält är odefinierat
| Valideringsfel: cancellationInfo/requestedBy/registeredBy är obligatoriskt | VALIDATIONERROR |
Något av följande fält är odefinierat eller tomt
| Valideringsfel: cancellationInfo.registrationDate/cancellationInfo.requestDate är obligatoriskt | ||
Något av följande datumfält är inte ett giltigt datum
| Valideringsfel: element är inte ett giltigt datum för registrationDate/requestDate | ||
Något av följande fält har inte ett giltigt HSA-id mönster
| Valideringsfel: angivet id element har ogiltigt format | ||
Något av följande fält har inte en giltig längd för HSA-id
| Valideringsfel: värdet för parameter registeredBy.employeeId/requestedBy.employeeId får inte överstiga hsaIdMaxLängd tecken | ||
| Den eftersökta hävningen är redan hävd | Den temporära hävningen är redan hävd | INVALIDSTATE | |
| Angivet temporaryRevokeId finns inte i databasen | Ingen tillfällig hävning med id element finns registrerad | NOTFOUND | |
ReplicationTimeout -1 (vänta på svar)
ReplicationTimeout >0 (vänta på svar angiven tid)
| Replikering till Nationell spärrtjänst fungerar inte för tillfället Replikering till Nationell spärrtjänst är ej aktiverad Replikering av spärrdata till nationell nod slutfördes ej inom given tidsram Resultat: Tillfälliga hävning är hävd lokalt men ändringen är inte replikerad till Nationell spärrtjänst. | ||
| DeleteExtendedBlock | deleteAction/deleteAction.requestedBy/deleteAction.registeredBy är odefinierad | Valideringsfel: deleteAction/deleteAction.requestedBy/deleteAction.registeredBy är obligatoriskt | VALIDATIONERROR |
Något av följande fält är odefinierad eller tom
| Valideringsfel: deleteAction.requestDate/ deleteAction.registrationDate/ deleteAction.requestedBy.employeeId/ deleteAction.registeredBy.employeeId är obligatoriskt | ||
Något av följande HSA-IDn har ogiltig längd;
| Valideringsfel: värdet för parameter deleteAction.requestedBy.employeeId/ deleteAction.registeredBy.employeeId får inte överstiga hsaIdMaxLängd tecken | ||
Något av följande HSA-IDn har ogiltigt format;
| Valideringsfel: angivet id element har ogiltigt format | ||
Något av följande datum är inte ett giltigt datum
| Valideringsfel: element är inte ett giltigt datum för requestDate/registrationDate | ||
| Angivet blockId finns inte registrerat i databasen | Ingen spärr med id element finns registrerad | NOTFOUND | |
| Spärren med angivet blockId är redan borttagen | Spärren är redan borttagen för blockId element | INVALIDSTATE | |
ReplicationTimeout -1 (vänta på svar)
ReplicationTimeout >0 (vänta på svar angiven tid)
| Replikering till Nationell spärrtjänst fungerar inte för tillfället Replikering till Nationell spärrtjänst är ej aktiverad Replikering av spärrdata till nationell nod slutfördes ej inom given tidsram Resultat: Spärren är borttagen lokalt men är inte replikerad till Nationell spärrtjänst. | INFO | |
| GetExtendedBlocksForPatient |
| Valideringsfel: careProvider/patientId/extension/root är obligatoriskt | VALIDATIONERROR |
| Inkompatibla värden på root och extension | Ogiltigt format på personidentitet för angiven typ element | ||
| Angiven root finns inte i systemet | Angiven typ för personidentitet finns ej i systemet | ||
| RegisterExtendedBlock | Angivet blockId är inte ett giltigt UUID | Valideringsfel: element är inte ett giltigt UUID för blockId | VALIDATIONERROR |
| Valideringsfel: informationCareProvider/extension/root/informationCareUnitId/patientId är obligatoriskt | ||
| Angiven root finns inte i systemet | Angiven typ för personidentitet finns ej i systemet | ||
| Angiven extension i patientId är ogiltig för root | Angiven OID element är inte giltig för identitet | ||
| Inkompatibla värden på root och extension | Ogiltigt format på personidentitet för angiven typ element | ||
| blockType är ogiltig, odefinierad eller tom | Valideringsfel: ogiltig spärrtyp | ||
| Datumspannet informationStartDate - informationEndDate är ogiltigt | Valideringsfel: angivet datumspann är ogiltigt | ||
Någon av följande datum har felaktigt format;
| Valideringsfel: element är inte ett giltigt datum för informationStartDate/informationEndDate/requestDate/registrationDate | ||
| excludedInformationTypes är inte en giltig informationstyp | Valideringsfel: informationstypen element är ogiltig | ||
| blockType är av typen Outer och informationCareUnitId är inte odefinierad eller tom | Valideringsfel: informationCareUnitId ska inte anges tillsammans med spärrtyp OUTER | ||
Någon av följande fält är odefinierade;
| Valideringsfel: registerAction/registerAction.requestedBy/registerAction.registeredBy är obligatoriskt | ||
Något av följande fält är odefinierade eller tomma
| Valideringsfel: registerAction.registrationDate/ registerAction.requestDate/ registerAction.requestedBy.employeeId/ registerAction.registeredBy.employeeId är obligatoriskt | ||
Något av följande HSA-IDn har ogiltig längd;
| Valideringsfel: värdet för parameter registerAction.requestedBy.employeeId/ registerAction.registeredBy.employeeId får inte överstiga hsaIdMaxLängd tecken | ||
Något av följande HSA-IDn har ogiltigt format;
| Valideringsfel: angivet id element har ogiltigt format | ||
| Angivet blockId finns redan registrerat | Spärren finns redan registrerad för blockId element | ALREADYEXISTS | |
ReplicationTimeout -1 (vänta på svar)
ReplicationTimeout >0 (vänta på svar angiven tid)
| Replikering till Nationell spärrtjänst fungerar inte för tillfället Replikering till Nationell spärrtjänst är ej aktiverad Replikering av spärrdata till nationell nod slutfördes ej inom given tidsram Resultat: Spärren är registrerad lokalt men är inte replikerad till Nationell spärrtjänst. | INFO | |
| RegisterTemporaryExtendedRevoke | Någon av följande fält är odefinierade;
| Valideringsfel: registerAction/registerAction.requestedBy/registerAction.registeredBy är obligatoriskt | VALIDATIONERROR |
Något av följande fält är odefinierade eller tomma;
| Valideringsfel: registerAction.registrationDate/ | ||
| revokeReason är odefinierad | Valideringsfel: ogiltig revokeringsanledning | ||
Något av följande HSA-IDn har ogiltigt längd;
| Valideringsfel: värdet för parameter | ||
Något av följande HSA-IDn har ogiltigt format;
| Valideringsfel: angivet id element har ogiltigt format | ||
Något av följande datum har felaktigt format;
| Valideringsfel: element är inte ett giltigt datum för endDate/requestDate/registrationDate | ||
| temporaryExtendedRevokeId har ogiltigt format | Valideringsfel: element är inte ett giltigt UUID för temporaryExtendedRevokeId | ||
| revocationReasonText har ogiltig längd | Valideringsfel: längden på revocationReasonText är ogiltig, förväntad längd är mellan revokationReasonTextMinLength och revokationReasonTextMaxLength | ||
| Angivet blockId finns inte registrerat i databasen | Ingen spärr med id element finns registrerad | NOTFOUND | |
| Angivet temporaryRevokeId finns redan registrerat i databasen | Den tillfälliga hävningen finns redan registrerad | ALREADYEXISTS | |
ReplicationTimeout -1 (vänta på svar)
ReplicationTimeout >0 (vänta på svar angiven tid)
| Replikering till Nationell spärrtjänst fungerar inte för tillfället Replikering till Nationell spärrtjänst är ej aktiverad Replikering av spärrdata till nationell nod slutfördes ej inom given tidsram Resultat: Tillfälliga hävningen är registrerad lokalt men är inte replikerad till Nationell spärrtjänst. | INFO | |
| RevokeExtendedBlock | Något av följande fält är odefinierat
| Valideringsfel: revokeAction/revokeAction.registeredBy/revokeAction.requestedBy är obligatoriskt | VALIDATIONERROR |
Något av följande datum har felaktigt format;
| Valideringsfel: element är inte ett giltigt datum för registrationDate/requestDate | ||
Något av följande fält är odefinierade eller tomma;
| Valideringsfel: revokeAction.registrationDate/ revokeAction.requestDate/ revokeAction.registeredBy.employeeId/ revokeAction.requestedBy.employeeId är obligatoriskt | ||
Något av följande HSA-IDn har felaktigt format;
| Valideringsfel: angivet id element har ogiltigt format | ||
Något av följande HSA-IDn har ogiltig längd;
| Valideringsfel: värdet för parameter revokeAction.registeredBy.employeeId/ revokeAction.requestedBy.employeeId får inte överstiga 32 tecken | ||
| revocationReasonText har ogiltig längd | Valideringsfel: längden på revocationReasonText är ogiltig, förväntad längd är mellan revokationReasonTextMinLength och revokationReasonTextMaxLength | ||
| Spärren med angivet blockId är redan hävd | Spärren är redan hävd för blockId element | INVALIDSTATE | |
| Angivet blockId finns inte registrerat i databasen | Ingen spärr med id element finns registrerad | NOTFOUND | |
ReplicationTimeout -1 (vänta på svar)
ReplicationTimeout >0 (vänta på svar angiven tid)
| Replikering till Nationell spärrtjänst fungerar inte för tillfället Replikering till Nationell spärrtjänst är ej aktiverad Replikering av spärrdata till nationell nod slutfördes ej inom given tidsram Resultat: Hävningen av spärren är registrerad lokalt men är inte replikerad till Nationell spärrtjänst. | INFO | |