Pasientens journaldokumenter (PJD) med relevante spesifikasjoner er nå i utprøving. Spesifikasjonene for PJD understøtter krav i tillitsrammeverket for PJD og er klare til å prøves ut.
NHN vil i samarbeid med helsevirksomhetene og EPJ leverandørene som deltar i utprøvingen forbedre og oppdatere spesifikasjonene underveis i utprøvingsperioden basert på erfaringer.
Vi har valgt å bruke versjonskontrollverktøyet Github til å skrive dokumentasjon og spesifikasjoner av flere årsaker:
Utviklingen av spesifikasjonene vil foregå over flere iterasjoner, hvor hver iterasjon fører til en ny versjon av spesifikasjonen. NHN skal sørge for framdrift og vil fungere som reviewer av pull-requests, sørger for framdrift i viktige diskusjoner og vil håndtere eventuelle tilbakemeldinger via issues.
Hvis det ikke oppstår nye diskusjoner eller issues som peker på feil, eller dersom endringene kun består av språklige endringer skal det gjennomføres en avstemning om hvorvidt spesifikasjonen skal publiseres som versjon 1.0.
Alle som har interesse oppfordres til å gi innspill og bidrag til spesifikasjonene som utvikles i forbindelse med etablering av tillitsrammeverket. For å sørge for framdrift i utviklingen av spesifikasjoner opprettes det en arbeidsgruppe som består av fageksperter fra sektoren, NHN og direktoratet.
Arbeidsgruppa sin oppgave er å sørge for framdrift i utviklingen av spesifikasjoner knyttet til tilgangsstyring og sporbarhet som skal benyttes av tjenesteleverandører og programvareleverandører ved deling av helseopplysninger mellom helsepersonell på tvers av virksomheter i sektoren.
Arbeidsgruppa treffes regelmessig, og har det redaksjonelle ansvaret for spesifikasjonene. Arbeidsgruppa må også sørge for å få nødvendige tilbakemeldinger fra involverte parter, slik at spesifikasjonene reflekterer det reelle behovet.
Spesifikasjonene vil bli basert på diskusjoner og innspill gjort i Github. Diskusjoner og innspill i andre kanaler vil ikke bli behandlet. Derfor er det viktig at diskusjoner som foregår utenfor dette repositoriet blir dokumentert skriftlig, enten som diskusjon, eller som issues eller pull-requests.
Når du oppdager feil eller mangler i spesifikasjonen må du opprette en issue i Github. Dersom det er behov for å diskutere eller på annen måte behandle en registrert issue skal dette gjøres skriftlig ved å legge inn kommentarer. Dersom en issue fører til en endring i spesifikasjonen skal denne endringen gjøres via en pull-request, eller som en merge mot den branchen man jobber mot.
Dersom du ønsker å gjøre endringer direkte i spesifikasjonen skal du benytte pull-requests i Github. Hvis en pull-request er knyttet til en issue ønsker vi at du lenker pull-requesten til issuet.
Norsk Helsenett vil fungere som reviewer av pull-requests, og vil gjøre en kvalitetskontroll og håndtere eventuelle diskusjoner knyttet til innsjekkingen.
Vi anser det som sannsynlig at det vil bli behov for å gjennomføre møter, men legger ikke opp til en fast møteserie med mindre det viser seg å bli et behov. Dersom det viser seg at bidragsyterne til spesifikasjonene har behov for å gjennomføre møter vil disse møtene fasiliteres av NHN og avtales fortløpende.
Spesifikasjonen vil versjoneres etter hver iterasjon, hvor versjonen indikeres av et suffix, f.eks. "-1", "-2", osv.
Når spesifikasjonen ansees som ferdig skal den publiseres som versjon 1.0.
Github har god dokumentasjon som beskriver arbeidsflyten. Les brukerveiledningen på Github for å få en forståelse for de grunnleggende prinsippene.
Markdown er et språk som kan brukes for å generere html. Det er enkelt i bruk, og krever ingen spesiell programvare.
Innføring til markdown på Github
Vi anbefaler to verktøy for å skrive .md filer:
Det finnes mange andre teksteditorer som man også tilbyr forhåndsvisning av HTML koden som blir generert. Ta en titt på nettet for å se om du finner noen som passer for deg.
Vi har valgt å bruke diskusjoner på Github for dialog mellom de som bidrar. På den måten er alle diskusjoner synlige for de som deltar, samtidig som vi ivaretar historikken på en god måte.
Github har støtte for å lage diagram i markdown dokumenter ved bruk av Mermaid. Se her for en introduksjon.