Innhold i "Den gode implementasjonsguide"

[rockphotog]

Jeg har begynt å rydde på Den gode implementasjonsguide (DGI), som språk, kladdete innhold og ting som passer bedre i metode for områdeprofiler.

https://github.com/HL7Norway/best-practice/blob/master/docs/dgi/index.md

Ønsker en diskusjon om hva som BØR (!) ligge i DGI, hvor detaljert den bør være, hva som er gode erfaringer fra (internasjonale IGer) for ting som faktisk er implementert (som Argonaut) og så videre.

Eneste mål jeg har satt er at vi har en versjon 0.9 og så en 1.0 i år som vi kan presentere diskutere med fagmiljø, TSK, E-helse etc.

Kjør debatt!

@kennethmyhra @thomiz @oaassv @micer2004 @HL7Norway/tsk

[thomiz]

Noen ideer

• Krav til hva som skal dokumenteres

  • Definition elementet i Conformance Ressurser må fylles ut med definisjon, spesiellt detaljerte regler for profiler og extensions
  • Dokumentasjon av koding
  • Dokumentasjon av alle endringer i profiler med begrunnelser knyttet til brukerscenario

• Innholdskrav for en god implementasjonsguide

  • brukerhistorie som besvares av løsning/profil
  • Krav om figurer som viser overordnet arkitektur og overordnet løsningsbeskrivelse for klienter/servere som tilfredstiller kravene i løsningen
  • Hvilke samhandlingsformer som er relevante (meldinger, dokumenter, REST, services)
  • Krav om å vise strukturer og sammenhenger mellom conformance ressursene som er profilert/utviklet
  • Krav til beskrivelse av alle extensions og hvordan disse benyttes sammen med hvilke profiler
  • Krav til CapabilityStatement og eksempler på hvordan grensesnittene som spesifiseres kan benyttes i praksis (praktiske eksempler)
  • Krav til eksempler på ressurs instanser som tilfredstiller profilene som er utviklet, minst ett eksempel pr profil
  • Beskrivelse av testverktøy som kan benyttes for å teste eventuelle utviklede løsninger