Merge pull request #783 from aehrc/issue/692

Issue/692

.github/workflows/deploy_docs.yml

@@ -0,0 +1,53 @@
+name: Smart Forms Docs Deployment Workflow
+
+on:
+  push:
+#    branches: [ "main" ]
+
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy-docusaurus:
+    environment:
+      name: github-pages
+      url: ${{ steps.build-publish.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build documentation website
+        run: npm run build -w documentation
+
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: build
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+
+
+#  deploy-storybook:
+#    environment:
+#      name: github-pages
+#      url: ${{ steps.build-publish.outputs.page_url }}
+#
+#    runs-on: ubuntu-latest
+#    steps:
+#      - uses: bitovi/[email protected]
+#        with:
+#          path: packages/smart-forms-renderer/storybook-static
+#          install_command: npm ci
+#          build_command: npm run build-storybook -w packages/smart-forms-renderer

documentation/docs/components/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Components",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "Basic components used in Smart Forms to render FHIR Questionnaires."
+  }
+}

documentation/docs/components/attachment.mdx

@@ -0,0 +1,7 @@
+---
+sidebar_position: 12
+---
+
+# Attachment
+
+[Question with binary content such as an image, PDF, etc. as an answer (valueAttachment).](https://hl7.org/fhir/r4/codesystem-item-type.html#item-type-attachment)

documentation/docs/components/boolean.mdx

@@ -0,0 +1,50 @@
+---
+sidebar_position: 1
+---
+
+# Boolean
+
+[Question with a yes/no answer (valueBoolean).](https://www.hl7.org/fhir/r4/codesystem-item-type.html#item-type-boolean)
+
+## Basic usage
+
+#### Calculated Expressions
+
+[//]: # '<IframeContainer storyUrl="https://aehrc.github.io/smart-forms/?path=/story/component-single-components--boolean">'
+[//]: # '  <iframe'
+[//]: # '    src="https://aehrc.github.io/smart-forms/iframe.html?viewMode=story&id=component-single-components--boolean"'
+[//]: # '    width="100%"'
+[//]: # '    height="100"'
+[//]: # '  />'
+[//]: # '</IframeContainer>'
+
+## Advanced usage
+
+#### Calculated Expressions
+
+[//]: # '<IframeContainer storyUrl="https://aehrc.github.io/smart-forms/?path=/story/component-single-components--boolean">'
+[//]: # '  <iframe'
+[//]: # '    src="https://aehrc.github.io/smart-forms/iframe.html?viewMode=story&id=component-single-components--boolean"'
+[//]: # '    width="100%"'
+[//]: # '    height="100"'
+[//]: # '  />'
+[//]: # '</IframeContainer>'
+[//]: # 'Insert referenced Stories here'
+
+If there are other advanced usage scenarios you'd like to see, please [let us know](https://github.com/aehrc/smart-forms/issues/new).
+
+## SDC Supported extensions
+
+| Code                 | Usage                                                                                 |
+| -------------------- | ------------------------------------------------------------------------------------- |
+| initialExpression    | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression    |
+| calculatedExpression | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression |
+| enableWhenExpression | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression |
+| hidden               | http://hl7.org/fhir/StructureDefinition/questionnaire-hidden                          |
+| required             | item.required                                                                         |
+| repeats              | item.repeats                                                                          |
+| readOnly             | item.readOnly                                                                         |
+| initial              | item.initial                                                                          |
+| enableWhen           | item.enableWhen                                                                       |
+| enableBehavior       | item.enableBehavior                                                                   |
+| text                 | item.text                                                                             |

documentation/docs/components/choice.mdx

@@ -0,0 +1,7 @@
+---
+sidebar_position: 10
+---
+
+# Choice
+
+[Question with a Coding drawn from a list of possible answers (specified in either the answerOption property, or via the valueset referenced in the answerValueSet property) as an answer (valueCoding).](https://hl7.org/fhir/r4/codesystem-item-type.html#item-type-choice)

documentation/docs/components/date.mdx

@@ -0,0 +1,7 @@
+---
+sidebar_position: 4
+---
+
+# Date
+
+[Question with a date answer (valueDate).](https://hl7.org/fhir/r4/codesystem-item-type.html#item-type-date)

documentation/docs/components/dateTime.mdx

@@ -0,0 +1,7 @@
+---
+sidebar_position: 5
+---
+
+# Date Time
+
+[Question with a date and time answer (valueDateTime).](https://hl7.org/fhir/r4/codesystem-item-type.html#item-type-dateTime)

documentation/docs/components/decimal.mdx

@@ -0,0 +1,59 @@
+---
+sidebar_position: 2
+---
+
+# Decimal
+
+[Question with is a real number answer (valueDecimal).](https://hl7.org/fhir/r4/codesystem-item-type.html#item-type-decimal)
+
+[//]: # '## Basic usage'
+[//]: #
+[//]: # '<IframeContainer storyUrl="https://aehrc.github.io/smart-forms/?path=/story/component-single-components--decimal">'
+[//]: # '  <iframe'
+[//]: # '    src="https://aehrc.github.io/smart-forms/iframe.html?viewMode=story&id=component-single-components--decimal"'
+[//]: # '    width="100%"'
+[//]: # '    height="100"'
+[//]: # '  />'
+[//]: # '</IframeContainer>'
+[//]: #
+[//]: # '## Advanced usage'
+[//]: #
+[//]: # '#### Calculated Expressions'
+[//]: #
+[//]: # '<IframeContainer storyUrl="https://aehrc.github.io/smart-forms/?path=/story/component-single-components--decimal">'
+[//]: # '  <iframe'
+[//]: # '    src="https://aehrc.github.io/smart-forms/iframe.html?viewMode=story&id=component-single-components--decimal"'
+[//]: # '    width="100%"'
+[//]: # '    height="100"'
+[//]: # '  />'
+[//]: # '</IframeContainer>'
+[//]: # "If there are other advanced usage scenarios you'd like to see, please [let us know](https://github.com/aehrc/smart-forms/issues/new)."
+
+:::caution
+
+// In development, you can only use one locale at a time.
+
+:::
+
+## SDC Supported extensions
+
+| Code                 | Usage                                                                                 |
+| -------------------- | ------------------------------------------------------------------------------------- |
+| initialExpression    | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression    |
+| calculatedExpression | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression |
+| enableWhenExpression | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression |
+| hidden               | http://hl7.org/fhir/StructureDefinition/questionnaire-hidden                          |
+| entryFormat          | http://hl7.org/fhir/StructureDefinition/entryFormat                                   |
+| required             | item.required                                                                         |
+| repeats              | item.repeats                                                                          |
+| readOnly             | item.readOnly                                                                         |
+| maxLength            | item.maxLength                                                                        |
+| minLength            | http://hl7.org/fhir/StructureDefinition/minLength                                     |
+| regex                | http://hl7.org/fhir/StructureDefinition/regex                                         |
+| minValue             | http://hl7.org/fhir/StructureDefinition/minValue                                      |
+| maxValue             | http://hl7.org/fhir/StructureDefinition/maxValue                                      |
+| maxDecimalPlaces     | http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces                              |
+| initial              | item.initial                                                                          |
+| enableWhen           | item.enableWhen                                                                       |
+| enableBehavior       | item.enableBehavior                                                                   |
+| text                 | item.text                                                                             |

documentation/docs/components/integer.mdx

@@ -0,0 +1,29 @@
+---
+sidebar_position: 3
+---
+
+# Integer
+
+[Question with an integer answer (valueInteger).](https://hl7.org/fhir/r4/codesystem-item-type.html#item-type-integer)
+
+## SDC Supported extensions
+
+| Code                 | Usage                                                                                 |
+| -------------------- | ------------------------------------------------------------------------------------- |
+| initialExpression    | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression    |
+| calculatedExpression | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression |
+| enableWhenExpression | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression |
+| hidden               | http://hl7.org/fhir/StructureDefinition/questionnaire-hidden                          |
+| entryFormat          | http://hl7.org/fhir/StructureDefinition/entryFormat                                   |
+| required             | item.required                                                                         |
+| repeats              | item.repeats                                                                          |
+| readOnly             | item.readOnly                                                                         |
+| maxLength            | item.maxLength                                                                        |
+| minLength            | http://hl7.org/fhir/StructureDefinition/minLength                                     |
+| regex                | http://hl7.org/fhir/StructureDefinition/regex                                         |
+| minValue             | http://hl7.org/fhir/StructureDefinition/minValue                                      |
+| maxValue             | http://hl7.org/fhir/StructureDefinition/maxValue                                      |
+| initial              | item.initial                                                                          |
+| enableWhen           | item.enableWhen                                                                       |
+| enableBehavior       | item.enableBehavior                                                                   |
+| text                 | item.text                                                                             |

documentation/docs/components/open-choice.mdx

@@ -0,0 +1,7 @@
+---
+sidebar_position: 11
+---
+
+# Open Choice
+
+[Answer is a Coding drawn from a list of possible answers (as with the choice type) or a free-text entry in a string (valueCoding or valueString).](https://hl7.org/fhir/r4/codesystem-item-type.html#item-type-open-choice)

documentation/docs/components/quantity.mdx

@@ -0,0 +1,7 @@
+---
+sidebar_position: 14
+---
+
+# Quantity
+
+[Question with a combination of a numeric value and unit, potentially with a comparator (< , >, etc.) as an answer. (valueQuantity) There is an extension 'http://hl7.org/fhir/StructureDefinition/questionnaire-unit' that can be used to define what unit should be captured (or the unit that has a ucum conversion from the provided unit).](https://hl7.org/fhir/r4/codesystem-item-type.html#item-type-quantity)

documentation/docs/components/reference.mdx

@@ -0,0 +1,7 @@
+---
+sidebar_position: 13
+---
+
+# Reference
+
+[Question with a reference to another resource (practitioner, organization, etc.) as an answer (valueReference).](https://hl7.org/fhir/r4/codesystem-item-type.html#item-type-reference)

documentation/docs/components/string.mdx

@@ -0,0 +1,7 @@
+---
+sidebar_position: 7
+---
+
+# String
+
+[ Question with a short (few words to short sentence) free-text entry answer (valueString).](https://hl7.org/fhir/r4/codesystem-item-type.html#item-type-string)

documentation/docs/components/text.mdx

@@ -0,0 +1,7 @@
+---
+sidebar_position: 8
+---
+
+# Text
+
+[Question with a long (potentially multi-paragraph) free-text entry answer (valueString).](https://hl7.org/fhir/r4/codesystem-item-type.html#item-type-text)

documentation/docs/components/time.mdx

@@ -0,0 +1,7 @@
+---
+sidebar_position: 6
+---
+
+# Time
+
+[Question with a time (hour:minute:second) answer independent of date (valueTime).](https://hl7.org/fhir/r4/codesystem-item-type.html#item-type-time)

documentation/docs/components/url.mdx

@@ -0,0 +1,7 @@
+---
+sidebar_position: 9
+---
+
+# Url
+
+[Question with a URL (website, FTP site, etc.) answer (valueUri).](https://hl7.org/fhir/r4/codesystem-item-type.html#item-type-url)

website/docs/tutorial-basics/_category_.json → documentation/docs/tutorial-basics/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Tutorial - Basics",
-  "position": 2,
+  "position": 20,
   "link": {
     "type": "generated-index",
     "description": "5 minutes to learn the most important Docusaurus concepts."

website/docs/tutorial-extras/_category_.json → documentation/docs/tutorial-extras/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Tutorial - Extras",
-  "position": 3,
+  "position": 21,
   "link": {
     "type": "generated-index"
   }