❓ FAQ

Frequently asked questions

How can I contribute ?

Any contribution is welcome! Read more here.

How can I customize the default behavior of the library ?

The library was built with that in mind. Read more here.

Compatibility Matrix

Version	FHIR
>= 2.0.0 (current)	R4 and R5
>= 1.0.0	R4 and R5

Why the minimal FHIR version is R4 ?

Several reasons :

• FHIR version R4 is the most widely used version of FHIR, as stated by many actors like HAPI FHIR creators
• Many tools don't care anymore for older versions
• It fits my needs when I designed this project

tip

You can migrate your dosages from R3 to R4 quick easily, as it is just a matter to putting dose[x] / rate[x] under doseAndRate.

How can I customize or add my own language ?

You can choose your preferred way :

1. Make a pull request on the repository : simply add translations files for your locale.
2. Use a i18next backend like showcast in documentation

You can use English files for reference. Each file has a single responsibility :

• common : Anything that isn't related to a specific ValueSet
• daysOfWeek : Codes related to Days Of Week ValueSet
• eventTiming : Codes related to EventTiming ValueSet
• unitsOfTime : Codes related to UnitsOfTime ValueSet
• quantityComparator : Codes related to QuantityComparator ValueSet

Which languages are currently built-in ?

4 locales are currently implemented :

1. "en" (English)
2. "fr" (French)
3. "nl" (Dutch)
4. "de" (German)

Which FHIR extensions should you support ?

• Your country extensions (e.g. Belgian ones)
• FHIR Extensions Pack (for international and interoperability reasons)

Currently, 5 extensions are known to have impacts with Dosage / Timing with FHIR Extensions Pack :

• Conditions
• Days of cycle
• Timing day of month
• Timing Exact
• Minimum Gap Between Doses

Explanations about the choice of license ?

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)		✔

I still have a question ...

Create a ticket to speak about it on our discussions space on Github