Richtlijn uitwerken en toepassen voor empty narratives in definitional resources

Description

Volgens de FHIR spec zou elke resource een narrative moeten hebben. De nieuwste versie van de HL7 Validator klaagt hier ook specifiek over.

Na intern overleg zijn we echter tot de conclusie gekomen dat het onwenselijk is om een narrative te gebruiken voor definitional resources zoals profielen, ValueSets, CapabilityStatements, etc. Hier liggen meerdere overwegingen aan ten grondslag:

  • Het doel van een narrative is om in een “clinically safe” fallback te voorzien voor resources die uitgewisseld worden maar niet (volledig) worden ondersteund door de ontvanger. Definitional resources zijn echter niet bedoeld voor uitwisseling en zijn juist expliciet bedoeld voor hun machine-readable inhoud; wij kunnen geen situatie bedenken waar een gebruiker wel geïnteresseerd is in een menselijk leesbare tekst en niet in de gestructureerde content.

  • Een narrative zou compleet moeten zijn in zijn dekking van de gestructureerde content. We denken dat dit bijzonder lastig te realiseren is zonder simpelweg de hele gestructureerde content over te nemen. Dit is echter onzinnig, aangezien deze resources statisch zijn en inzichtelijk gemaakt worden op de plek van publicatie.

  • Een narrative toevoegen is niet zonder kosten. Er moet tijd in worden gestoken en er moet onderhoud op gedaan worden. Er bestaat ook een risico dat de narrative uit de pas gaat lopen met de gestructureerde inhoud als dit onderhoud niet goed geregeld wordt.

Om wel zo veel mogelijk in lijn te blijven met de FHIR-spec, is het voorstel om definitional resources te voorzien van een narrative met .status = empty en een inhoud die kort beschrijft waarom de inhoud afwezig is.

Deze richtlijn moet worden opgenomen in de profiling guidelines en toegepast worden in alle FHIR R4-resources.

Proposed solution (NL)

In de profiling guidelines wordt opgenomen dat definitional resources een narrative met .status = empty krijgen. Deze narrative wordt toegevoegd aan alle definitional resources.

Proposed solution (EN)

The profiling guidelines will state that definitional resources should have a narrative with .status = empty. This narrative will be added to all definitional resources.

Release notes (NL)

In de profiling guidelines is beschreven dat definitional resources (profielen, ValueSets, CodeSystems, etc.) een narrative met .status = empty krijgen. Deze narrative is toegevoegd aan alle definitional resources.

Release notes (EN)

The profiling guidelines now state that definitional resources (profiles, ValueSets, CodeSystems, etc.) should have a narrative with .status = empty. This narrative has been added to all definitional resources.

100% Done
Loading...

Activity

Show:
Resolved
Pinned fields
Click on the next to a field label to start pinning.

Details

Assignee

Reporter

Classification

Patch (Z)

Informatiestandaard onderdelen

FHIR-package

Delegated responsibility

Yes

Rejection

No

Package

zib2020-package
nl-core (2020)

Fix versions

Priority

Better Excel Exporter

Created January 30, 2024 at 4:19 PM
Updated October 17, 2024 at 12:01 PM
Resolved October 17, 2024 at 12:01 PM