Hente melding
Detaljert API-avtrykk finnes på Swagger-siden.
Hente informasjon om uavleste meldinger
GET /Messages
Søker etter uleste (ukvitterte) meldinger. Søket spesifiseres med query-parametre i URL-en:
- Hvilke (mottaker-)HER-Id-er som skal inkluderes i spørringen. Denne må oppgis, mens alle andre query-parametre kan stå tomme.
- Hvilken avsender-HER-Id meldingene skal ha (hvis du bare vil hente fra en bestemt avsender).
- Hvilken fagmeldings-Id forretningsdokumentet skal ha (hvis du ser etter en bestemt melding).
- Hvor mange meldinger som skal hentes ut av gangen.
- Om meldingene sorteres med nyeste eller eldste først.
- Om metadata for meldingen skal inkluderes i returobjektet, eller bare en Id-referanse (
AssignedId).
Uten metadata valgt returneres en liste med Id-referanse (AssignedId) og mottaker-HER-Id per uleste melding. Med metadata valgt vil de øvrige feltene i returobjektet bli populert. Metadataen angår domenet for meldingsutveksling av medisinske meldinger.
Det er polling av dette endepunktet som er korrekt måte å sjekke om du har fått en ny melding (I framtiden vil en callback-mekanisme tilbys som alternativ til polling). Polling-intervallet bør være minst et par minutter.
Hente metadata om en melding
GET /Messages/{AssignedId}
Henter ut domene-metadata om en melding, gitt en Id-referanse (AssignedId).
Hente forretningsdokument fra melding
GET /Messages/{AssignedId}/BusinessDocument
Henter ut forretningsdokumentet til en melding, gitt en Id-referanse (AssignedId). Returnerer den byte-arrayen som Meldingstjener fikk hentet inn under mottak, med teknisk metadata om selve innpakkingen. Den vanligste situasjonen er at responsen inneholder en base64-enkodet byte-array av et Xml-dokument.
Markere melding som lest
PUT /Messages/{AssignedId}/Read/{HerId}
Markerer meldingen med en viss Id-referanse (AssignedId) som lest/kvittert av en viss mottaker (HerId). Etter at meldingen er markert som lest av en mottaker, vil den ikke lenger dukke opp ved henting av uleste meldinger. Da en melding kan ha mer enn en mottaker, må du oppgi hvem (av de potensielt flere) som nå har lest meldingen.
Å markere som lest regner vi som ekvivalent med å sende Acknowledgement i EbXml-standarden. Du bekrefter overfor avsender at du er i besittelse av meldingen.
Forsikre deg at forretningsdokumentet er lagret hos klienten din før du markerer som lest. Forretningsdokumentet vil markeres for sletting når alle mottakere har kvittert.
Eksempel på flyt
Hent en liste over alle uleste meldinger.
Hvis du vil gjøre en pre-filtrering (f.eks. hvilken klient som henter hva), bruk metadata som en del av steg 1 eller eget endepunkt til å gjøre denne logikken på klientsiden.
Hent forretningsdokumentet.
Marker meldingen som lest.