SENDE MELDING TIL INNBYGGER V2

Sist oppdatert 12.12.2019

Innholdsfortegnelse

Sende melding klient-side

Sende melding server-side

Feilsituasjoner

Mottak av status for forsendelse

API-kallet for å sende sensitiv informasjon er i v2 endret slik at man får respons med en gang, uten å vente på at forsendelsen har gått igjennom til Helsenorge/Digipost. Når forsendelsen er fullført (pasienten har fått beskjed og brevet er tilgjengelig) vil ePROM gjøre et kall mot Bestillersystemet med status for forsendelsen. Bestillersystemet må implementere en service som mottar dette kallet.

Hvis man har behov for å sende sensitiv informasjon til pasienten kan man sende dette via ePROM.

Utsending av melding kan gjøres både fra server-side og fra klient-side. Ved kall fra server-side kan man benytte seg av et API utviklet av Hemit og distribuert som NuGet pakke for å forenkle oppkoblingen. Alle URL’ene som er oppgitt i dette dokumentet går mot integrasjonsmiljøet for ePROM

NB! I verson v2 av API’et skal ApiKey sendes som en Authorization parameter som del av HTTP header: headers: {"Authorization": "Basic " + apiKey}

Sende melding klient-side

URL for Web API kall https://proms2.hemit.org/PromsWebApi/api/messagetocitizen

Parametere – Inn

Parametere – Ut

Metode

POST

Sende melding server-side

API

Tilgjenglig som NuGet pakke

NuGet repository: https://hemit.myget.org/F/hemitpublic/api/v3/index.json

Navn: Hemit.Proms.Integration

Eksempelkode (C#)

[HttpPost]
public JsonResult SendMessageToCitizenV2(string nationalId, DocumentCollection documentCollection)
{
// <add key="PromsApiBaseUrl" value="http://mrsdev.helsemn.no/PromsWebApi/" />
var promsApiBaseUrl = ConfigurationManager. AppSettings["PromsApiBaseUrl"]; 
var apikey = ConfigurationManager. AppSettings["ApiKey"]; 
var messageInfo = new MessageInfo {

    title = "Ikkesensitiv tittel på melding",
    description = "Beskrivelse av melding",
    merknad = "Helseundersøkelsene i Nord Trøndelag - HUNT"

}; 
var senderInfo = new SenderInfo {

    organisationName = "Navn på organisasjon",
    organisationNr = "Organisasjon nr"

}; 
var notificationPriorityList = new List<NotificationChannel>
{

    NotificationChannel.Helsenorge,
    NotificationChannel.DigitalMailbox

}; 

    var result = Api.SendMessageToCitizenV2(

promsApiBaseUrl, 
apikey, 
nationalId, 
senderInfo, 
messageInfo, 
documentCollection, 
notificationPriorityList,
false); 

    if (result.HasErrors)
    {
        Response.StatusCode = result.ErrorStatusCode.Value;
        Response.Write(result.ErrorJson);
        return null;
    }

    return Json(new { 
notificationChannel = result.NotificationChannel,
messageToCitizenId = result.messageToCitizenId}); 
}

Parametere - Inn

promsApiBaseUrl skal være https://proms2.hemit.org/PromsWebApi

Parametere – Ut

Feilsituasjoner

Hvis responsen resulterer i "notificationChannel": "0" er det ikke sendt noe melding til innbygger. Dette skjer hvis ePROM ikke kan nå innbygger via helsenorge, digipost. Dette er også tilfelle hvis fødselsnummeret ikke eksisterer.

Ellers kan følgende feilsituasjoner oppstå:

Mottak av status for forsendelse

API-kallet for å sende sensitiv informasjon er i v2 endret slik at man får respons med en gang, uten å vente på at forsendelsen har gått igjennom til Helsenorge/Digipost. Når forsendelsen er fullført (pasienten har fått beskjed og brevet er tilgjengelig) vil ePROM gjøre et kall mot Bestillersystemet med status for forsendelsen. Bestillersystemet må implementere en service som mottar dette kallet.

URL for Web API kall

ApiBaseUrl for web API registreres i ePROM Selvbetjeningsmodul under Bestillersystem: https://proms2.hemit.org/PromsAdministration/

Web API må være tilgjenglig på URL: https:// <ApiBaseUrl> /api/MessageToCitizen

F.eks: https://mrsdev.helsemn.no/PromsTestregisterServices/api/MessageToCitizen/

Parametere - Inn

Parametere - Ut

For parameter inn og ut kan NuGet pakken Hemit.Proms.Integration benyttes. Bruk da Hemit.Proms.Integration.SendMessageToCitizenResult for parameter inn og Hemit.Proms.Integration.SendMessageToCitizenResponse for parameter ut

Metode

PUT

Eksempel request fra Proms (JSON)

{
    "apiKey" : "",
    "messageToCitizenId" : "184738d0-3c39-e611-9c2a-34e6d72e03c7",
    "notificationChannel" : "Helsenorge",
    "sentStatus" : "Sent"
}