Flytningen af basal response-information fra Response body til header

[Rikke Madsbjerg]

Der er kommet feedback fra udvikler af klientsystem, som ikke mener at flytningen af indhold som paginering, advarsler, privatmarkering fra request/response body til header i FMK 1.6.0 er hensigtsmæssig.

Bekymringen er, at det er lettere at lave fejl, når det klinisk relevante indhold af et service-kald ikke står direkte i kaldets strukturer, men i stedet i en header. Dette giver en dårlig type-sikkerhed, da det ikke længere fremgår direkte fra request og response og sætter i stedet krav til dokumentationen.
Derudover vil det potentielt kunne give klienter ekstra arbejde, da disse headers typisk spiller dårligt sammen med klient-frameworks baseret på automatisk kode-generering og automatisk validering af fx request-indhold.
Klienten vurderer, at ændringen både giver dårligere validering og mere arbejde for mange klienter. Såfremt disse headers beholdes, vil det være nødvendigt med dokumentation af relevante request og response-headers på alle service-beskrivelser.

Da det er en større ændring i den allerede udmeldte 1.6.0 snitflade, som potentielt vil kunne forsinke tidsplanen, vil FMK-teamet meget gerne have tilbagemeldinger fra klientsystemer vedr. om de ser de samme udfordringer som de førnævnte. En større ændring af snitflade og tidsplan skal være begrundet i et udbredt ønske om ændringer og ikke kun fra et enkelt system.

Tilbagemelding skal ske til Åse: aags@sundhedsdata.dk

Tidsfrist for tilbagemelding: 30. juni 2026

På vegne af FMK-teamet

[aags]

Kære Alle

Tak for jeres feedback på vores forespørgsel om at flytte den basale responsinformation fra Response Body til Header.

Vi har modtaget en række velbegrundede argumenter, som både taler for og imod en sådan ændring. På baggrund af tilbagemeldingerne har vi bedt vores udvikler undersøge mulighederne for at introducere en Context Header som et alternativ. Med en Context Header ser vi på muligheden for at samle responsrelateret information (fx paginering) i en dedikeret header indlejret i responset, hvor tværgående information (såsom whitelisting og consent) holdes som allerede skitseret i Request/Response headers udenfor responset. Formålet er at gøre det lettere for klienterne at identificere status, advarsler og øvrig metadata uden at skulle analysere indholdet af selve Response Body, men samtidig holde response-relateret information tæt på responset men på en ensartet måde på tværs af kaldene.
Vi forventer at publicere en nærmere beskrivelse primo august. Herefter vil der blive gennemført en høring, hvorefter der udarbejdes en indstilling til FMK-styregruppen.
Der er ikke planlagt ændringer på nuværende tidspunkt, og vi fortsætter derfor arbejdet efter de gældende principper, mens de forskellige muligheder undersøges nærmere.


Mvh Åse Grønborg
Pva. FMK-teamet