Params

Index

Properties

• dateTimeFormatOptions
• displayOrder
• displaySeparator
• fromCodeableConceptToString
• fromExtensionsToString
• fromFHIRQuantityUnitToString
• language

Properties

optionaldateTimeFormatOptions

dateTimeFormatOptions?: DateTimeFormatOptions

To control the formatting of dateTime objects. If not provided, will use the defaults according locale e.g. "20/01/2024"

@defaultValue

{}

@see

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat#options

optionaldisplayOrder

displayOrder?: (method | doseQuantity | doseRange | rateRatio | rateQuantity | rateRange | durationDurationMax | frequencyFrequencyMax | periodPeriodMax | frequencyFrequencyMaxPeriodPeriodMax | offsetWhen | dayOfWeek | timeOfDay | route | site | asNeeded | boundsDuration | boundsPeriod | boundsRange | countCountMax | event | code | maxDosePerPeriod | maxDosePerAdministration | maxDosePerLifetime | additionalInstruction | patientInstruction | text | extension)[]

Control the display order used by the algorithm Useful when you want to turn on / off some specific rules for some reason

@defaultValue

["method", "doseQuantity", "doseRange", "rateRatio", "rateQuantity", "rateRange", "durationDurationMax", "frequencyFrequencyMaxPeriodPeriodMax", "offsetWhen", "dayOfWeek", "timeOfDay", "route", "site", "asNeeded", "boundsDuration", "boundsPeriod", "boundsRange", "countCountMax", "event", "code", "maxDosePerPeriod", "maxDosePerAdministration", "maxDosePerLifetime", "additionalInstruction", "patientInstruction"]

@see

DisplayOrderEnum for more info

optionaldisplaySeparator

displaySeparator?: string

Override separator between each part of "Dosage"

@defaultValue

" - "

optionalfromCodeableConceptToString

fromCodeableConceptToString?: FromCodeableConceptToStringFct

Function to turn a codeable concept (e.g SNOMED CT "311504000") into a string for humans (e.g "With or after food") The choice to handle extension, local valueset, ... is thus under the hands of people ;)

@see

• defaultFromCodeableConceptToString for default implementation
• FHIR definition of CodeableConcept for more info about the type itself

optionalfromExtensionsToString

fromExtensionsToString?: FromExtensionsToStringFct

Function to turn extension(s) into a string for humans. The choice to handle national extensions, ... is thus under the hands of people ;)

optionalfromFHIRQuantityUnitToString

fromFHIRQuantityUnitToString?: FromFHIRQuantityUnitToStringFct

Function to turn a quantity unit (e.g UCUM "ml") into a string for humans (e.g "militier") The choice to handle plural form or not is thus under the hands of people ;)

@see

• defaultFromFHIRQuantityUnitToString for default implementation
• FHIR definition of Quantity for more info about the type itself

optionallanguage

language?: en | fr | nl | de

To set up the language

@defaultValue

"en" (English)