diff --git a/404.html b/404.html index 1f0cdd9a..45004c35 100644 --- a/404.html +++ b/404.html @@ -9,7 +9,7 @@ - +
diff --git a/api.html b/api.html index a3120085..9e6601b1 100644 --- a/api.html +++ b/api.html @@ -9,7 +9,7 @@ - + diff --git a/api/class/default.html b/api/class/default.html index 73dbf9ea..f5b58605 100644 --- a/api/class/default.html +++ b/api/class/default.html @@ -9,7 +9,7 @@ - + diff --git a/api/enum/DisplayOrderEnum.html b/api/enum/DisplayOrderEnum.html index c3ea506a..30eb2c49 100644 --- a/api/enum/DisplayOrderEnum.html +++ b/api/enum/DisplayOrderEnum.html @@ -9,7 +9,7 @@ - + diff --git a/api/interface/Params.html b/api/interface/Params.html index b9c9dbcf..9f34dc2c 100644 --- a/api/interface/Params.html +++ b/api/interface/Params.html @@ -9,7 +9,7 @@ - + diff --git a/assets/js/ea313555.25b7af83.js b/assets/js/ea313555.25b7af83.js deleted file mode 100644 index 1f93ce61..00000000 --- a/assets/js/ea313555.25b7af83.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocumentation=self.webpackChunkdocumentation||[]).push([[1011],{2362:(e,s,i)=>{i.r(s),i.d(s,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>l,toc:()=>d});var r=i(4848),n=i(8453);const t={title:"\u2753 FAQ",description:"Frequently Asked Questions"},o=void 0,l={id:"faq",title:"\u2753 FAQ",description:"Frequently Asked Questions",source:"@site/docs/faq.mdx",sourceDirName:".",slug:"/faq",permalink:"/fhir-dosage-utils/docs/faq",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/faq.mdx",tags:[],version:"current",frontMatter:{title:"\u2753 FAQ",description:"Frequently Asked Questions"},sidebar:"tutorialSidebar",previous:{title:"\ud83e\udde9 Contributing",permalink:"/fhir-dosage-utils/docs/contributing"},next:{title:"\ud83d\udea7 Roadmap",permalink:"/fhir-dosage-utils/docs/next-steps"}},c={},d=[];function a(e){const s={a:"a",admonition:"admonition",blockquote:"blockquote",code:"code",li:"li",ol:"ol",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,n.R)(),...e.components},{Details:i}=s;return i||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsx)(s.p,{children:"Frequently asked questions"}),"\n"]}),"\n",(0,r.jsxs)(i,{children:[(0,r.jsx)("summary",{children:"How can I contribute ?"}),(0,r.jsxs)(s.p,{children:["Any contribution is welcome! Read more ",(0,r.jsx)(s.a,{href:"contributing",children:"here"}),"."]})]}),"\n",(0,r.jsxs)(i,{children:[(0,r.jsx)("summary",{children:"How can I customize the default behavior of the library ?"}),(0,r.jsxs)(s.p,{children:["The library was built with that in mind. Read more ",(0,r.jsx)(s.a,{href:"demo/custom",children:"here"}),"."]})]}),"\n",(0,r.jsxs)(i,{children:[(0,r.jsx)("summary",{children:"Compatibility Matrix"}),(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Version"}),(0,r.jsx)(s.th,{children:"FHIR"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsxs)(s.td,{children:[(0,r.jsx)(s.code,{children:">= 1.0.0"})," (current)"]}),(0,r.jsx)(s.td,{children:(0,r.jsx)(s.code,{children:"R4 and R5"})})]})})]})]}),"\n",(0,r.jsxs)(i,{children:[(0,r.jsx)("summary",{children:"Why the minimal FHIR version is R4 ?"}),(0,r.jsx)(s.p,{children:"Several reasons :"}),(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:["FHIR version R4 is the most widely used version of FHIR, as stated by ",(0,r.jsx)(s.a,{href:"https://smilecdr.com/docs/fhir_repository/fhir_versions.html",children:"many actors like HAPI FHIR creators"})]}),"\n",(0,r.jsx)(s.li,{children:"Many tools don't care anymore for older versions"}),"\n",(0,r.jsx)(s.li,{children:"It fits my needs when I designed this project"}),"\n"]}),(0,r.jsx)(s.admonition,{type:"tip",children:(0,r.jsxs)(s.p,{children:["You can migrate your dosages from R3 to R4 quick easily, as it is just a matter to putting ",(0,r.jsx)(s.code,{children:"dose[x]"})," / ",(0,r.jsx)(s.code,{children:"rate[x]"})," under ",(0,r.jsx)(s.code,{children:"doseAndRate"}),"."]})})]}),"\n",(0,r.jsxs)(i,{children:[(0,r.jsx)("summary",{children:"How can I customize or add my own language ?"}),(0,r.jsx)(s.p,{children:"You can choose your preferred way :"}),(0,r.jsxs)(s.ol,{children:["\n",(0,r.jsxs)(s.li,{children:["Make a pull request on the repository : simply add translations files ",(0,r.jsx)(s.a,{href:"https://github.com/jy95/fhir-dosage-utils/tree/main/src/locales",children:"for your locale"}),"."]}),"\n",(0,r.jsxs)(s.li,{children:["Use a ",(0,r.jsx)(s.a,{href:"https://www.i18next.com/overview/plugins-and-utils#backends",children:"i18next backend"})," like ",(0,r.jsx)(s.a,{href:"custom/i18nConfig",children:"showcast in documentation"})]}),"\n"]}),(0,r.jsxs)(s.p,{children:["You can use ",(0,r.jsx)(s.a,{href:"https://github.com/jy95/fhir-dosage-utils/tree/main/src/locales/en",children:"English files"})," for reference."]})]}),"\n",(0,r.jsxs)(i,{children:[(0,r.jsx)("summary",{children:"Which languages are currently built-in ?"}),(0,r.jsxs)(s.p,{children:["4 ",(0,r.jsx)(s.a,{href:"https://github.com/jy95/fhir-dosage-utils/tree/main/src/locales",children:"locales"})," are currently implemented :"]}),(0,r.jsxs)(s.ol,{children:["\n",(0,r.jsx)(s.li,{children:'"en" (English)'}),"\n",(0,r.jsx)(s.li,{children:'"fr" (French)'}),"\n",(0,r.jsx)(s.li,{children:'"nl" (Dutch)'}),"\n",(0,r.jsx)(s.li,{children:'"de" (German)'}),"\n"]})]})]})}function h(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}}}]); \ No newline at end of file diff --git a/assets/js/ea313555.2a085738.js b/assets/js/ea313555.2a085738.js new file mode 100644 index 00000000..f4980815 --- /dev/null +++ b/assets/js/ea313555.2a085738.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocumentation=self.webpackChunkdocumentation||[]).push([[1011],{2362:(e,s,i)=>{i.r(s),i.d(s,{assets:()=>d,contentTitle:()=>l,default:()=>a,frontMatter:()=>t,metadata:()=>o,toc:()=>c});var n=i(4848),r=i(8453);const t={title:"\u2753 FAQ",description:"Frequently Asked Questions"},l=void 0,o={id:"faq",title:"\u2753 FAQ",description:"Frequently Asked Questions",source:"@site/docs/faq.mdx",sourceDirName:".",slug:"/faq",permalink:"/fhir-dosage-utils/docs/faq",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/faq.mdx",tags:[],version:"current",frontMatter:{title:"\u2753 FAQ",description:"Frequently Asked Questions"},sidebar:"tutorialSidebar",previous:{title:"\ud83e\udde9 Contributing",permalink:"/fhir-dosage-utils/docs/contributing"},next:{title:"\ud83d\udea7 Roadmap",permalink:"/fhir-dosage-utils/docs/next-steps"}},d={},c=[];function h(e){const s={a:"a",admonition:"admonition",blockquote:"blockquote",code:"code",li:"li",ol:"ol",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components},{Details:i}=s;return i||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Frequently asked questions"}),"\n"]}),"\n",(0,n.jsxs)(i,{children:[(0,n.jsx)("summary",{children:"How can I contribute ?"}),(0,n.jsxs)(s.p,{children:["Any contribution is welcome! Read more ",(0,n.jsx)(s.a,{href:"contributing",children:"here"}),"."]})]}),"\n",(0,n.jsxs)(i,{children:[(0,n.jsx)("summary",{children:"How can I customize the default behavior of the library ?"}),(0,n.jsxs)(s.p,{children:["The library was built with that in mind. Read more ",(0,n.jsx)(s.a,{href:"demo/custom",children:"here"}),"."]})]}),"\n",(0,n.jsxs)(i,{children:[(0,n.jsx)("summary",{children:"Compatibility Matrix"}),(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Version"}),(0,n.jsx)(s.th,{children:"FHIR"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsxs)(s.td,{children:[(0,n.jsx)(s.code,{children:">= 1.0.0"})," (current)"]}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"R4 and R5"})})]})})]})]}),"\n",(0,n.jsxs)(i,{children:[(0,n.jsx)("summary",{children:"Why the minimal FHIR version is R4 ?"}),(0,n.jsx)(s.p,{children:"Several reasons :"}),(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsxs)(s.li,{children:["FHIR version R4 is the most widely used version of FHIR, as stated by ",(0,n.jsx)(s.a,{href:"https://smilecdr.com/docs/fhir_repository/fhir_versions.html",children:"many actors like HAPI FHIR creators"})]}),"\n",(0,n.jsx)(s.li,{children:"Many tools don't care anymore for older versions"}),"\n",(0,n.jsx)(s.li,{children:"It fits my needs when I designed this project"}),"\n"]}),(0,n.jsx)(s.admonition,{type:"tip",children:(0,n.jsxs)(s.p,{children:["You can migrate your dosages from R3 to R4 quick easily, as it is just a matter to putting ",(0,n.jsx)(s.code,{children:"dose[x]"})," / ",(0,n.jsx)(s.code,{children:"rate[x]"})," under ",(0,n.jsx)(s.code,{children:"doseAndRate"}),"."]})})]}),"\n",(0,n.jsxs)(i,{children:[(0,n.jsx)("summary",{children:"How can I customize or add my own language ?"}),(0,n.jsx)(s.p,{children:"You can choose your preferred way :"}),(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["Make a pull request on the repository : simply add translations files ",(0,n.jsx)(s.a,{href:"https://github.com/jy95/fhir-dosage-utils/tree/main/src/locales",children:"for your locale"}),"."]}),"\n",(0,n.jsxs)(s.li,{children:["Use a ",(0,n.jsx)(s.a,{href:"https://www.i18next.com/overview/plugins-and-utils#backends",children:"i18next backend"})," like ",(0,n.jsx)(s.a,{href:"custom/i18nConfig",children:"showcast in documentation"})]}),"\n"]}),(0,n.jsxs)(s.p,{children:["You can use ",(0,n.jsx)(s.a,{href:"https://github.com/jy95/fhir-dosage-utils/tree/main/src/locales/en",children:"English files"})," for reference."]})]}),"\n",(0,n.jsxs)(i,{children:[(0,n.jsx)("summary",{children:"Which languages are currently built-in ?"}),(0,n.jsxs)(s.p,{children:["4 ",(0,n.jsx)(s.a,{href:"https://github.com/jy95/fhir-dosage-utils/tree/main/src/locales",children:"locales"})," are currently implemented :"]}),(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsx)(s.li,{children:'"en" (English)'}),"\n",(0,n.jsx)(s.li,{children:'"fr" (French)'}),"\n",(0,n.jsx)(s.li,{children:'"nl" (Dutch)'}),"\n",(0,n.jsx)(s.li,{children:'"de" (German)'}),"\n"]})]}),"\n",(0,n.jsxs)(i,{children:[(0,n.jsx)("summary",{children:"Which FHIR extensions should you support ?"}),(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsxs)(s.li,{children:["Your country extensions (e.g. ",(0,n.jsx)(s.a,{href:"https://www.ehealth.fgov.be/standards/fhir/",children:"Belgian ones"}),")"]}),"\n",(0,n.jsxs)(s.li,{children:[(0,n.jsx)(s.a,{href:"https://hl7.org/fhir/extensions/artifacts.html",children:"FHIR Extensions Pack"})," (for international and interoperability reasons)"]}),"\n"]}),(0,n.jsxs)(s.p,{children:["Currently, 5 extensions are known to have impacts with Dosage / Timing with ",(0,n.jsx)(s.a,{href:"https://hl7.org/fhir/extensions/artifacts.html",children:"FHIR Extensions Pack"})," :"]}),(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:(0,n.jsx)(s.a,{href:"https://hl7.org/fhir/extensions/StructureDefinition-dosage-conditions.html",children:"Conditions"})}),"\n",(0,n.jsx)(s.li,{children:(0,n.jsx)(s.a,{href:"https://hl7.org/fhir/extensions/StructureDefinition-timing-daysOfCycle.html",children:"Days of cycle"})}),"\n",(0,n.jsx)(s.li,{children:(0,n.jsx)(s.a,{href:"https://hl7.org/fhir/extensions/StructureDefinition-timing-dayOfMonth.html",children:"Timing day of month"})}),"\n",(0,n.jsx)(s.li,{children:(0,n.jsx)(s.a,{href:"https://hl7.org/fhir/extensions/StructureDefinition-timing-exact.html",children:"Timing Exact"})}),"\n",(0,n.jsx)(s.li,{children:(0,n.jsx)(s.a,{href:"https://hl7.org/fhir/extensions/StructureDefinition-dosage-minimumGapBetweenDose.html",children:"Minimum Gap Between Doses"})}),"\n"]})]}),"\n",(0,n.jsxs)(i,{children:[(0,n.jsx)("summary",{children:"Explanations about the choice of license ?"}),(0,n.jsx)(s.p,{children:"The library is licensed under the AGPL 3.0 license to ensure everyone benefits from improvements and keeps the project collaborative and open. Here's a simplified breakdown:"}),(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Feature"}),(0,n.jsx)(s.th,{children:"Permitted"}),(0,n.jsx)(s.th,{children:"Not Permitted"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Use the library in your project (commercial/non-commercial)"}),(0,n.jsx)(s.td,{children:"\u2714"}),(0,n.jsx)(s.td,{})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Follow open closed principle"}),(0,n.jsx)(s.td,{children:"\u2714"}),(0,n.jsx)(s.td,{})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Distribute a modified version publicly and keep your changes closed-source"}),(0,n.jsx)(s.td,{}),(0,n.jsx)(s.td,{children:"\u2714"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Create derivative works (e.g., new libraries based on this code) and distribute them under a different license (if public)"}),(0,n.jsx)(s.td,{}),(0,n.jsx)(s.td,{children:"\u2714"})]})]})]})]}),"\n",(0,n.jsxs)(i,{children:[(0,n.jsx)("summary",{children:"I still have a question ..."}),(0,n.jsxs)(s.p,{children:["Create a ticket to speak about it on our discussions space on ",(0,n.jsx)(s.a,{href:"https://github.com/jy95/fhir-dosage-utils/discussions",children:"Github"})]})]})]})}function a(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.ee8da9d9.js b/assets/js/runtime~main.8e61fdbf.js similarity index 99% rename from assets/js/runtime~main.ee8da9d9.js rename to assets/js/runtime~main.8e61fdbf.js index 05c98e8b..73b6ca07 100644 --- a/assets/js/runtime~main.ee8da9d9.js +++ b/assets/js/runtime~main.8e61fdbf.js @@ -1 +1 @@ -(()=>{"use strict";var e,c,a,b,f,d={},t={};function r(e){var c=t[e];if(void 0!==c)return c.exports;var a=t[e]={exports:{}};return d[e].call(a.exports,a,a.exports,r),a.exports}r.m=d,r.amdO={},e=[],r.O=(c,a,b,f)=>{if(!a){var d=1/0;for(i=0;iCurrently, 5 extensions are known to have impacts with Dosage / Timing with FHIR Extensions Pack :
The library is licensed under the AGPL 3.0 license to ensure everyone benefits from improvements and keeps the project collaborative and open. Here's a simplified breakdown:
Feature | Permitted | Not Permitted |
---|---|---|
Use the library in your project (commercial/non-commercial) | ✔ | |
Follow open closed principle | ✔ | |
Distribute a modified version publicly and keep your changes closed-source | ✔ | |
Create derivative works (e.g., new libraries based on this code) and distribute them under a different license (if public) | ✔ |
Create a ticket to speak about it on our discussions space on Github