Konfigurasjon av EDI 2.0

NB! Denne funksjonaliteten er under utvikling, og kan gjennomgå brekkende endringer. Benytt "api-version"-headeren 3 i dine API-kall for å teste det ut.

Detaljert API-avtrykk finnes på Swagger-siden.

Du kan konfigurere deler av hvordan EDI 2.0 skal oppføre seg som din meldingstjener. Det kreves en konfigurasjon per HER-Id.

Konfigurasjon bør oppdateres regelmessig. Vi anbefaler at du definerer ønsket konfigurasjon deklarativt, og sender denne inn ved hver oppstart av applikasjonen.

Send inn meldingstjener-konfigurasjon

POST /MshConfiguration

Skriver de oppgitte konfigurasjonene til EDI 2.0 sin meldingstjener.

Reserver HER-id

Sett feltet ClientLocked til 'true' om du ønsker å være den enenste klienten som skal kunne bruke EDI 2.0 på vegne av den aktuelle HER-id'en.

Når en HER'id er reservert vil andre klienter som forsøker å hente/sende meldinger for denne HER-id'en bli avvist med en 423-Locked statuskode. Den samme feilmeldingen vil du få om du forsøker å endre en konfigurasjon som allerede er reservert.

For å frigjøre en HER-id som er resrvert må det sendes inn en ny konfigurasjon hvor ClientLocked er satt til 'false', eller benytte DELETE-endepunktet.

Hvilken måte vil du motta beskjed om nye meldinger på?

Bruk feltet receiveNotificationChannel. Denne vil fortløpende utvides med flere mulige verdier.

• ApiPolling: Du "poller" med kall til endepunktet /Messages (Les mer om endepunktet på siden for API-endepunkt).
• Kafka: Du konsumerer en kafka-topic. NB! Kafka-topic er bare tilgjengelig internt i NHN.

Vil du vite om meldinger til deg som er avvist eller som ikke kunne leveres på grunn av feil?

Bruk feltet receiveRefusedMessageNotices. Hvis denne er true, vil du kunne hente ut informasjon om meldinger som er adressert til din HER-id, men som ikke vil bli levert videre av EDI 2.0.

Du kan motta informasjon om avviste og ikke-leverte meldinger ved å benytte endepunktet GET /Messages/notices. Les mer på siden for Hente informasjon om innkommende meldinger.

Vil du avvise visse meldinger?

Bruk feltet rejectMessageFilters. Her kan du oppgi nøkler (dictionary/key) som indikerer hva slags felt du vil avvise, og verdier (dictionary/value) som indikerer hvilke av verdiene i feltet som skal avvises. I øyeblikket tilbys kun filteret MessageFunction som nøkkel:

• MessageFunction - Oppgi koder fra Helsedirektoratets kodeverk 8279 - "Meldingens funksjon".
  • For en melding mottatt over tradisjonell EDI sjekkes dette mot Action fra EbXml-konvolutten, som benytter kodeverk 8279 (spesifisert i HIS1209:2018). Merk at Action strengt tatt kan være feilmarkert eller mangle verdi. I slike tilfeller vil Meldingstjener ikke avvise meldingen.
  • For en melding mottatt fra en annen API-bruker av EDI 2.0 sjekkes dette mot feltet i fagmeldingen der meldingens funksjon spesifiseres, som varierer per meldingstype. For meldinger som implementerer standarden for hodemelding (HIS80601:2006) vil dette ligge under MsgHead/MsgInfo/Type.

Når EDI 2.0 avviser en melding fra en EDI-avsender, sendes negativ transportkvittering (MessageError) med feilkode NotSupported. Når EDI 2.0 avviser en melding fra en EDI 2.0-avsender, settes mottakerstatus til Rejected.

Eksempel på bruk av rejectMessageFilters:

Her spesifiseres det at vi vil avvise en rekke verdier fra kodeverk 8279 som sendes i sektor, men som ligger utenfor standarden for Svarrapport versjon 1.4:

{
    MessageFunction: ["SVAR_KKL", "SVAR_CYT", "SVAR_MBIO", "SVAR_HIST", "SVAR_OBD", "IMTR", "SVAR_IMTR"]
}

Slette meldingstjener-konfigurasjoner

DELETE /MshConfiguration

Sletter de konfigurasjonen for de oppgitte HER-id'ene. Alle oppgitte HER-id'er må ha en konfigurasjon, og ingen av de oppgitte HER-id'ene kan være reservert av andre klienter.