Fsh ig template

.github/workflows/publish.yml

@@ -10,7 +10,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-  
+
       - name: Install Node
         uses: actions/setup-node@v3
         with:
@@ -32,19 +32,58 @@ jobs:
         run: sudo apt install ruby ruby-all-dev -y
 
       - name: Install Jekyll
-        run: sudo gem install jekyll
+        run: sudo gem install jekyll jekyll-plantuml
+
+      - name: Install Graphvix
+        run: sudo apt install graphviz
 
       - name: Build IG
-        run: ./_genonce.sh
+        run: ./_genonce.sh ${{ vars.VALIDATOR_OFFLINE }}
+
+      - name: Download and unpack font-awesome
+        run: wget https://fontawesome.com/v4/assets/font-awesome-4.7.0.zip; unzip font-awesome-4.7.0.zip -d output
 
       - name: Publish IG Artefact
         uses: actions/upload-artifact@v3
         with:
           name: IG Archive
           path: ./output/
 
+      - name: Prepare files for GitHub Pages
+        run: |
+          cp -r output _site;
+          chmod -c -R +rX "_site/" | while read line; do
+            echo "::warning title=Invalid file permissions automatically fixed::$line"
+          done
+
+      - name: Publish IG to GitHub Pages
+        uses: actions/upload-pages-artifact@v3
+
       - name: Cache Node modules
         uses: actions/cache@v3
         with:
           path: ~/.npm
           key: ${{ runner.os }}--build-cache-npm-packages-${{ hashFiles('**/package-lock.json') }}
+
+           # Deploy job (https://github.com/actions/deploy-pages)
+  deploy:
+    # Add a dependency to the build job
+    needs: build
+    # Only deploy on development branch
+    # if: github.ref == 'refs/heads/development'
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Specify runner + deployment step
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action

.gitignore

@@ -1,7 +1,15 @@
-.DS_Store
-Thumbs.db
-/fsh-generated
-/input-cache
-/output
-/temp
-/template
+_site/
+.sass-cache/
+.jekyll-cache/
+.jekyll-metadata
+# Ignore folders generated by Bundler
+.bundle/
+vendor/
+input-cache
+node_modules
+output
+temp
+template
+font-awesome*
+fsh-generated
+input/resources/QUERY-OUTPUT*

README.md

@@ -1,11 +1 @@
-# sushi-demo
-
-The [docs for FSH](https://fshschool.org) are very clear and comprehensive
-
-The page on [creating an IG](https://fshschool.org/courses/fsh-seminar/02-creating-an-ig.html) covers in detail what is being demonstrated in this repo.
-
-A github action outputs the generated IG
-
-<img src="https://github.com/declankieran-nhsd/sushi-demo/assets/93662162/96b07107-34c6-4e89-ab23-e0e6e1e7b44c" width="50%">
-
-The IG generate is using [NHS England FHIR assets](https://github.com/NHSDigital/NHSEngland-FHIR-ImplementationGuide).
+# IG Template( Using Fsh)

input/fsh/aliases.fsh

@@ -0,0 +1,24 @@
+Alias: $consentscope = http://terminology.hl7.org/CodeSystem/consentscope
+Alias: $sct = https://snomed.info/sct
+Alias: $condition-clinical = http://terminology.hl7.org/CodeSystem/condition-clinical
+Alias: $v3-DataOperation = http://terminology.hl7.org/CodeSystem/v3-DataOperation
+Alias: $condition-clinical = http://terminology.hl7.org/CodeSystem/condition-clinical
+Alias: $sct = https://snomed.info/sct
+Alias: $v3-DataOperation = http://terminology.hl7.org/CodeSystem/v3-DataOperation
+Alias: $contractsignertypecodes = http://terminology.hl7.org/CodeSystem/contractsignertypecodes
+Alias: $RoleClass = http://terminology.hl7.org/CodeSystem/v3-RoleClass
+Alias: $RoleCode = http://terminology.hl7.org/CodeSystem/v3-RoleCode
+Alias: $ParticipationFunction = http://terminology.hl7.org/CodeSystem/v3-ParticipationFunction
+Alias: $ParticipationType = http://terminology.hl7.org/CodeSystem/v3-ParticipationType
+Alias: $extra-security-role-type = http://terminology.hl7.org/CodeSystem/extra-security-role-type
+Alias: $CareConnect-SDSJobRoleName-1 = https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1
+Alias: $ValueSetPatientFlagCategory =  https://fhir.nhs.uk/England/ValueSet/PatientFlagCategory
+Alias: $ValueSetProgrammeFlagCategory =  https://fhir.nhs.uk/England/ValueSet/ProgrammeFlagCategory
+Alias: $ExtensionFlagDetail =  http://hl7.org/fhir/StructureDefinition/flag-detail
+Alias: $ValueSetFlagProvenanceRole =  https://fhir.nhs.uk/England/ValueSet/FlagProvenanceRole
+Alias: $ValueSetRAFlagCode =  https://fhir.nhs.uk/England/ValueSet/RA-FlagCode
+Alias: $ValueSetCPISFlagCode =  https://fhir.nhs.uk/England/ValueSet/CPIS-FlagCode
+Alias: $ValueSetFGMFlagCode =  https://fhir.nhs.uk/England/ValueSet/FGM-FlagCode
+Alias: $ValueSetProgrammeFlagCode =  https://fhir.nhs.uk/England/ValueSet/ProgrammeFlagCode
+Alias: $ValueSetFlagConditionCategory =  https://fhir.nhs.uk/England/ValueSet/FlagConditionCategory
+Alias: $ValueSetFlagConditionCode =  https://fhir.nhs.uk/England/ValueSet/FlagConditionCode

input/fsh/codesystem/PatientFlagCategory.fsh

@@ -0,0 +1,20 @@
+
+CodeSystem: PatientFlagCategory
+Id: PatientFlagCategory
+Title: "NHSE Patient Flag Category"
+Description: "A CodeSystem to identify the type/category of Flag."
+
+* ^name = "PatientFlagCategory"
+* ^url = "https://fhir.nhs.uk/England/CodeSystem/PatientFlagCategory"
+* ^version = "0.1.0"
+* ^status = #draft
+* ^date = "2024-02-14"
+* ^experimental = false
+
+* insert NHSEngland-Copyright
+
+* ^caseSensitive = true
+* ^content = #complete
+* #NRAF "National Reasonable Adjustments Flag"
+* #CP-IS "Child Protection - Information Sharing Flag"
+* #FGM "Female Genital Mutilation Flag"

input/fsh/examples/PatientExample1.fsh

@@ -0,0 +1,14 @@
+Instance: PatientExample1
+InstanceOf: Patient
+Title: "UKCore patient example with very basic details."
+Usage: #example
+* meta.profile = "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient"
+
+* identifier.system = "https://fhir.nhs.uk/Id/nhs-number"
+* identifier.value = "9912003888"
+* active = true
+* name.use = #official
+* name.family = "Mann"
+* name.given = "Alan"
+* gender = #male
+* birthDate = "1970-01-01"

input/fsh/extensions/Extension-AdjustmentNotes.fsh

@@ -0,0 +1,16 @@
+Extension: Extension-FlagNotes
+Id: Extension-FlagNotes
+Title: "Extension for Flag Adjustment Notes"
+Description: "Captures the additional information for an Adjustment within a Reasonable Adjustment Flag."
+Context: Flag
+
+* ^purpose = "Additional information required to correctly or effectively interpret an Adjustment."
+* ^url = "https://fhir.nhs.uk/England/StructureDefinition/Extension-FlagNotes"
+* ^version = "0.1.0"
+* ^status = #draft
+* ^date = "2024-02-14"
+
+* insert NHSEngland-Copyright
+
+* value[x] 1..
+* value[x] only Annotation

input/fsh/extensions/Extension-ConsentCreateSummary.fsh

@@ -0,0 +1,16 @@
+Extension: Extension-ConsentCreateSummary
+Id: Extension-ConsentCreateSummary
+Title: "Extension for Consent Create Summary"
+Description: "Captures the additional information for a Best Interest decison when recording consent for a Reasonable Adjustment Flag."
+Context: Consent
+
+* ^purpose = "Captures the additional information for a Best Interest decison when recording consent for a Reasonable Adjustment Flag."
+* ^url = "https://fhir.nhs.uk/England/StructureDefinition/Extension-ConsentCreateSummary"
+* ^version = "0.1.0"
+* ^status = #draft
+* ^date = "2024-02-14"
+
+* insert NHSEngland-Copyright
+
+* value[x] 1..
+* value[x] only Annotation

input/fsh/extensions/Extension-RemoveCreateSummary.fsh

@@ -0,0 +1,16 @@
+Extension: Extension-ConsentRemoveSummary
+Id: Extension-ConsentRemoveSummary
+Title: "Extension for Consent Remove Summary"
+Description: "Captures the additional information for a Best Interest decison when removing consent for a Reasonable Adjustment Flag."
+Context: Consent
+
+* ^purpose = "Captures the additional information for a Best Interest decison when removing consent for a Reasonable Adjustment Flag."
+* ^url = "https://fhir.nhs.uk/England/StructureDefinition/Extension-ConsentRemoveSummary"
+* ^version = "0.1.0"
+* ^status = #draft
+* ^date = "2024-02-14"
+
+* insert NHSEngland-Copyright
+
+* value[x] 1..
+* value[x] only Annotation

input/fsh/profiles/FlagCondition.fsh

@@ -0,0 +1,32 @@
+Profile: FlagCondition
+Parent: Condition
+Id: FlagCondition
+Title: "NHSE Condition Profile for flags"
+Description: "Record an individual condition for a flag in NHS England"
+
+* ^name = "FlagCondition"
+* ^url = "https://fhir.nhs.uk/England/StructureDefinition/FlagCondition"
+* ^version = "0.1.0"
+* ^status = #draft
+* ^date = "2024-02-14"
+
+* contained ^slicing.discriminator.type = #profile
+* contained ^slicing.rules = #open
+* contained ^slicing.discriminator.path = "contained"
+* contained contains provenance 1..1
+* contained[provenance] only FlagProvenance
+
+* insert NHSEngland-Copyright
+
+* category ^slicing.discriminator.type = #pattern
+* category ^slicing.rules = #open
+* category ^slicing.discriminator.path = "$this"
+
+* category contains patientFlag 1.. MS
+* category[patientFlag] from $ValueSetPatientFlagCategory (required)
+
+* category contains conditionCategory 1.. MS
+* category[conditionCategory] from $ValueSetFlagConditionCategory (required)
+
+* code 1.. MS
+* code from $ValueSetFlagConditionCode (extensible)

input/fsh/profiles/FlagConsent.fsh

@@ -0,0 +1,39 @@
+Profile: FlagConsent
+Parent: Consent
+Id: FlagConsent
+Title: "NHSE Flag Consent Profile"
+Description: "Record consent to capture information for NHS England flags"
+
+* ^name = "FlagConsent"
+* ^url = "https://fhir.nhs.uk/England/StructureDefinition/FlagConsent"
+* ^version = "0.1.0"
+* ^status = #draft
+* ^date = "2024-02-14"
+
+* insert NHSEngland-Copyright
+
+* extension contains
+    Extension-ConsentCreateSummary named createSummary 0..1 and
+    Extension-ConsentRemoveSummary named removeSummary 0..1
+
+* extension[createSummary].value[x] only Annotation
+* extension[createSummary].valueAnnotation 1..
+
+* extension[removeSummary].value[x] only Annotation
+* extension[removeSummary].valueAnnotation 1..
+
+* contained ^slicing.discriminator.type = #profile
+* contained ^slicing.rules = #open
+* contained ^slicing.discriminator.path = "contained"
+* contained contains provenance 1..1
+* contained[provenance] only FlagProvenance
+
+* category from $ValueSetPatientFlagCategory (extensible)
+* policy 1..1
+* policy.uri 1..
+* policyRule 1..
+* policyRule from FlagProxyRole (extensible)
+* performer ..1
+* performer only Reference(Organization or Patient or Practitioner)
+* provision.purpose 1..1
+* provision.purpose from FlagConsentPurpose (extensible)

input/fsh/profiles/FlagProvenance.fsh

@@ -0,0 +1,18 @@
+Profile: FlagProvenance
+Parent: Provenance
+Id: FlagProvenance
+Title: "NHSE Flag Provenance Profile"
+Description: "Record details of the practitioner recording or removing an individual Flag."
+
+* ^name = "FlagProvenance"
+* ^url = "https://fhir.nhs.uk/England/StructureDefinition/FlagProvenance"
+* ^version = "0.1.0"
+* ^status = #draft
+* ^date = "2024-02-14"
+
+* insert NHSEngland-Copyright
+
+* target only Reference(FlagCondition or FlagConsent or ProgrammeFlag or PatientFlag)
+* agent.role from $ValueSetFlagProvenanceRole (extensible)
+* agent.who only Reference(Practitioner)
+* agent.onBehalfOf only Reference(Organization)

input/fsh/profiles/PatientFlag.fsh

@@ -0,0 +1,32 @@
+Profile: PatientFlag
+Parent: Flag
+Id: PatientFlag
+Title: "NHSE Patient Flag Profile"
+Description: "Record whether a Patient Flags exists"
+
+* ^name = "PatientFlag"
+* ^url = "https://fhir.nhs.uk/England/StructureDefinition/PatientFlag"
+* ^version = "0.1.0"
+* ^status = #draft
+* ^date = "2024-02-14"
+
+* insert NHSEngland-Copyright
+
+* extension contains
+    Extension-FlagNotes named flagNotes 0..1 and
+    $ExtensionFlagDetail named flagDetail 0..*
+
+* extension[flagNotes].value[x] only Annotation
+* extension[flagNotes].valueAnnotation 1..
+
+* extension[flagDetail].valueReference only Reference(ProgrammeFlag or FlagConsent or FlagCondition or FlagProvenance)
+
+* contained ^slicing.discriminator.type = #profile
+* contained ^slicing.rules = #open
+* contained ^slicing.discriminator.path = "contained"
+
+* contained contains provenance 1..1
+* contained[provenance] only FlagProvenance
+
+* code MS
+* code from $ValueSetPatientFlagCategory (required)

input/fsh/profiles/ProgrammeFlag.fsh

@@ -0,0 +1,32 @@
+Profile: ProgrammeFlag
+Parent: Flag
+Id: ProgrammeFlag
+Title: "NHSE Programme Flag Profile"
+Description: "Record an individual flag for an NHS England programme."
+
+* ^name = "ProgrammeFlag"
+* ^url = "https://fhir.nhs.uk/England/StructureDefinition/ProgrammeFlag"
+* ^version = "0.1.0"
+* ^status = #draft
+* ^date = "2024-02-14"
+
+* insert NHSEngland-Copyright
+
+* extension contains
+    Extension-FlagNotes named flagNotes 0..1 
+
+* extension[flagNotes].value[x] only Annotation
+* extension[flagNotes].valueAnnotation 1..
+
+* category ^slicing.discriminator.type = #pattern
+* category ^slicing.rules = #open
+* category ^slicing.discriminator.path = "$this"
+
+* category contains patientFlag 1.. MS
+* category[patientFlag] from $ValueSetPatientFlagCategory (required)
+
+* category contains programmeFlag 1.. MS
+* category[programmeFlag] from $ValueSetProgrammeFlagCategory (required)
+
+* code MS
+* code from $ValueSetProgrammeFlagCode (extensible)

input/fsh/rulsets/NHSEngland-Copyright.fsh

@@ -0,0 +1,2 @@
+RuleSet: NHSEngland-Copyright
+* ^copyright = "Copyright © 2024+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html."