Skip to content

Commit

Permalink
Update index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rockphotog authored Jan 21, 2025
1 parent 372f652 commit 5cab25a
Showing 1 changed file with 75 additions and 4 deletions.
79 changes: 75 additions & 4 deletions documentation/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,78 @@
# Placeholder
# Hvordan bruke denne repoen som en mal

Dokumentasjon for selve malen vil ligge her
UNDER ARBEID :-D

## Hvordan komme igang...
- Lage både en guide for lokal (som under) + kun GitHub.

Denne guiden vil hjelpe deg med å bruke denne repoen som en mal for å lage din egen FHIR Implementation Guide (IG).

## Trinn 1: Klon repoen

Start med å klone repoen til din lokale maskin:
```sh
git clone https://github.com/HL7Norway/ig-mal.git
```

## Trinn 2: Installer nødvendige verktøy

Sørg for at du har Java installert på din maskin, da IG Publisher krever Java 8 eller høyere. Du trenger også å laste ned IG Publisher JAR-filen.

## Trinn 3: Konfigurer Implementation Guide

Åpne `ig.ini`-filen og oppdater banen til Implementation Guide JSON-filen:
```ini
[IG]
ig = fsh-generated/resources/ImplementationGuide-din-ig.json
template = https://github.com/HL7Norway/ig-template
```

## Trinn 4: Rediger FSH-filer

Rediger FSH-filene i `input/fsh/profiles` for å definere dine egne profiler og utvidelser. For eksempel, åpne `mal-Patient.fsh` og tilpass den etter dine behov.

## Trinn 5: Valider eksempler

Legg til dine egne eksempler i `input/examples` og sørg for at de valideres mot dine FSH-profiler.

## Trinn 6: Kjør IG Publisher

Naviger til din repo-mappe og kjør IG Publisher for å generere Implementation Guide:
```sh
java -jar igpublisher.jar -ig ig.ini
```

## Trinn 7: Sjekk utdata

Etter at IG Publisher har kjørt, vil du finne utdata i `output`-mappen. Åpne `index.html` i en nettleser for å se din genererte Implementation Guide.

## Trinn 8: Publiser

Når du er fornøyd med din Implementation Guide, kan du publisere den til en webserver eller GitHub Pages.

## Eksempel på sushi-config.yaml

Her er et eksempel på en `sushi-config.yaml`-fil:
```yaml
id: din.fhir.ig
canonical: http://example.org/fhir/ig
name: DinIG
title: "Din Implementation Guide"
description: En detaljert beskrivelse av din Implementation Guide.
status: draft
version: 0.1.0
fhirVersion: 4.0.1
copyrightYear: 2025+
releaseLabel: ci-build
jurisdiction: urn:iso:std:iso:3166#NO "Norway"
publisher:
name: Din Organisasjon
url: https://www.example.org
menu:
Home: index.html
Artifacts: artifacts.html
TOC: toc.html
```
Følg disse trinnene for å komme i gang med å bruke denne repoen som en mal for din egen FHIR Implementation Guide.
```

...etc.

0 comments on commit 5cab25a

Please sign in to comment.