Dokumenthistorik

Datum	Version	Namn	Förändring

Datum	Version	Namn	Förändring
Jun 26, 2020	1.0	@Former user (Deleted)	Dokumenterat svarskoder i och med omskrivning av spärrtjänsten

Innehåll

1 Gemensamt för alla kontrakt
- 1.1 Systemloggar
- 1.2 Resultatobjekt i WS-svar
2 Spärrtjänsten (Nationella kontrakt)
3 Spärradministration (Lokala kontrakt)

Gemensamt för alla kontrakt

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.

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>

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)

Kontrakt	Felorsak	Felmeddelande	Felkod (resultCode)
CheckBlocks	patientId är odefinierad extension i patientId är odefinierad eller tom root i patientId är odefinierad eller tom	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
	accessingActor är odefinierad eller tom careProviderId i accessingActor är odefinierad eller tom careUnitId i accessingActor är odefinierad eller tom employeeId i accessingActor är odefinierad eller tom	Valideringsfel: Alla aktörsuppgifter måste vara angivna för objektet accessingActor
	careProviderId i accessingActor överstiger maxlängden för HSA-ID careUnitId i accessingActor överstiger maxlängden för HSA-ID employeeId i accessingActor överstiger maxlängden för HSA-ID	Valideringsfel: värdet för parameter careProviderId/careUnitId/employeeId får inte överstiga hsaIdMaxLängd tecken
	careProviderId i accessingActor har ogiltigt format careUnitId i accessingActor har ogiltigt format employeeId i accessingActor har ogiltigt format	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; informationCareProviderId är odefinierad eller tom informationCareUnitId är odefinierad eller tom informationType är inte en giltig typ informationStartDate är odefinierad eller ogiltig informationEndDate är odefinierad eller ogiltig informationEndDate är innan informationStartDate	Informationsresurs(er) innehåller valideringsfel	INFO
RegisterBlock	informationCareProviderId är odefinierad eller tom extension i patientId är odefinierad eller tom root i patientId är odefinierad eller tom blockType är av typen Inner och informationCareUnitId är odefinierad eller tom	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
	Angivet temporaryRevokdeId är inte ett giltigt UUID	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
	revokedForCareUnitId har en ogiltig längd för HSA-ID revokedForEmployeeId har en ogiltig längd för HSA-ID	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

Spärradministration (Lokala kontrakt)