Skip to main content
Version: v0.0.3

Interface: StructuredSig

A best-effort, lossy decode of a SCRIPT structured <Sig> into typed dosing components. Every component slot is always present and tagged SigFieldProvenance, so the surface is uniform and a consumer can see which fields are coded, derived, or absent.

Safety contract. The free-text sigText is the source of truth and is preserved verbatim; the structured view is additive and clearly flagged lossy (see "../common/warnings".SCRIPT_WARNING_CODES.SIG_STRUCTURED_LOSSY). The two are never reconciled: when structured dosing and the free text disagree, both are surfaced as-is. An ambiguous structured dose is never collapsed into a confident value (see "../common/warnings".SCRIPT_WARNING_CODES.SIG_AMBIGUOUS_DOSE).

Properties

administrationTiming

readonly administrationTiming: SigField

Administration timing / frequency.


dose

readonly dose: SigField

Dose amount (the numeric quantity), string-preserved; never a confident guess.


doseDeliveryMethod

readonly doseDeliveryMethod: SigField

Method of dose delivery (e.g. "take", "apply").


doseUnitOfMeasure

readonly doseUnitOfMeasure: SigField

Unit of measure for the dose (e.g. tablet, mL).


duration

readonly duration: SigField

Duration of therapy.


hasStructuredData

readonly hasStructuredData: boolean

True when at least one component decoded to a non-"absent" value.


indication

readonly indication: SigField

Clinical indication ("as needed for ...") .


maximumDoseRestriction

readonly maximumDoseRestriction: SigField

Maximum-dose restriction.


route

readonly route: SigField

Route of administration (SNOMED/NCI when coded).


sigText?

readonly optional sigText?: string

The free-text SIG (<SigText>), verbatim: always the source of truth.


siteOfAdministration

readonly siteOfAdministration: SigField

Site of administration (SNOMED/NCI when coded).


vehicle

readonly vehicle: SigField

Vehicle / diluent the dose is taken with.