Dokumenthistorik

Datum	Version	Namn	Förändring

Datum	Version	Namn	Förändring
Apr 22, 2021	1.0	@Former user (Deleted)	Dokumenterat svarskoder i och med omskrivning av samtyckestjänsten

Innehåll

1 Gemensamt för alla kontrakt
- 1.1 Systemloggar
- 1.2 Resultatobjekt i WS-svar
2 Samtyckestjänsten

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)

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: assertionType scopeType	Valideringsfel: ogiltig element
	patientId är odefinierad extension i patientId är odefinierad eller tom root i patientId är odefinierad eller tom careProviderId är odefinierad eller tom careUnit är odefinierad eller tom root i representedBy är odefinierad eller tom(om representedBy är definierad) extension i representedBy i patientId är odefinierad eller tom (om representedBy är definierad) registrationAction är odefinierad requestDate i registrationAction i registrationAction är odefinerad eller tom requestedBy i registrationAction registrationAction är odefinerad registrationDate i registrationAction i registrationAction är odefinerad eller tom registerBy i registrationAction i registrationAction är odefinerad employeeId i registrationAction.requestedBy är odefinerad eller tom employeeId i registrationAction.registeredBy är odefinerad eller tom	Valideringsfel: element är obligatoriskt.
	root i patientId är ogiltig root i representedBy är ogiltig (om representedBy är definierad)	Valideringsfel: Angiven typ för personidentitet element finns ej i systemet
	extension i patientId är ogiltig för root extension i representedBy är ogiltig för root (om representedBy är definierad)	Ogiltigt format på personidentitet för angiven typ element
	Inkompatibla värden på root och extension för patientId Inkompatibla värden på root och extension för representedBy (om representedBy är definierad)	Angiven OID element är inte giltig för identitet
	Något av följande fält är ogiltigt: careProviderId careUnitId employeeId (valideras om angiven) employeeId i registrationAction.requestedBy employeeId i registrationAction.registerBy assignmentId i registrationAction.requestedBy (om angivet) assignmentId i registrationAction.registerBy (om angivet)	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: employeeId (valideras om angiven) employeeId i registrationAction.requestedBy employeeId i registrationAction.registerBy assignmentId i registrationAction.requestedBy (om angivet) assignmentId i registrationAction.registerBy (om angivet)	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: assignmentName i registrationAction.requestedBy (om angivet) assignmentName i registrationAction.registerBy (om angivet)	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	patientId är odefinierad extension i patientId är odefinierad eller tom root i patientId är odefinierad eller tom careProviderId är odefinierad	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
	deleteAction är odefinerad deleteAction.requestDate är odefinerad, tom eller ogiltig deleteAction.requestedBy är odefinerad deleteAction.registerBy är odefinerad, tom eller ogiltig deleteAction.registerBy är odefinerad	Valideringsfel: element är obligatoriskt
	Något av följande fält är odefinierade eller tom: employeeId i deleteAction.requestedBy employeeId i deleteAction.registerBy	Valideringsfel: element är obligatoriskt
	Någon av följande fält är ogiltiga: employeeId i deleteAction.requestedBy employeeId i deleteAction.registerBy assignmentId i deleteAction.requestedBy (om angivet) assignmentId i deleteAction.registerBy.assignmentId (om angivet)	Valideringsfel: angivet id för element har ogiltigt format
	Någon av följande fält har felaktig längd: employeeId i deleteAction.requestedBy employeeId i deleteAction.registerBy assignmentId i deleteAction.requestedBy (om angivet) assignmentId i deleteAction.registerBy(om angivet)	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: assignmentName i deleteAction.requestedBy (om angivet) assignmentName i deleteAction.registerBy (om angivet)	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
	cancellationAction är odefinerad requestDate i cancellationAction är odefinerad, tom eller ogiltig requestedBy i cancellationAction är odefinerad registerDate i cancellationAction är odefinerad, tom eller ogiltig registerBy i cancellationAction är odefinerad	Valideringsfel: element obligatoriskt
	Något av följande fält är odefinierade eller tom: employeeId i cancellationAction.requestedBy employeeId i cancellationAction.registerBy	Valideringsfel: element är obligatoriskt
	Någon av följande fält är ogiltiga: employeeId i cancellationAction.requestedBy employeeId i cancellationAction.registerBy assignmentId i cancellationAction.requestedBy (om angivet) assignmentId i cancellationAction.registerBy.assignmentId (om angivet)	Valideringsfel: angivet id för element har ogiltigt format
	Någon av följande fält har felaktig längd: employeeId i cancellationAction.requestedBy employeeId i cancellationAction.registerBy assignmentId i cancellationAction.requestedBy (om angivet) assignmentId i cancellationActionion.registerBy(om angivet)	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: assignmentName i cancellationAction .requestedBy (om angivet) assignmentName i cancellationAction .registerBy (om angivet)	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: patientId är odefinierad extension i patientId root i patientId employeeId i accessingActor careProviderId i accessingActor careUnitId i accessingActor	Valideringsfel: element är obligatoriskt.
	Något av följande fält har felaktig längd: employeeId i accessingActor careProviderId i accessingActor careUnitId i accessingActor	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	patientId är odefinierad extension i patientId är odefinierad eller tom root i patientId är odefinierad eller tom careProviderId är odefinierad	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

Svarskoder och systemloggar för WS-kontrakt i Samtyckestjänsten

Gemensamt för alla kontrakt

Systemloggar

Resultatobjekt i WS-svar

Samtyckestjänsten