Package org.projecthusky.fhir.emed.ch.epr.model.emediplan.posology.detail

Class CyclicDosage

java.lang.Object
org.projecthusky.fhir.emed.ch.epr.model.emediplan.posology.detail.PosologyDetail
org.projecthusky.fhir.emed.ch.epr.model.emediplan.posology.detail.CyclicDosage
All Implemented Interfaces:
EMediplanObject
public class CyclicDosage extends PosologyDetail
Describes the application of a medication at constant intervals.

  • Field Details

    • CYCLE_DURATION_UNIT_FIELD_NAME

      protected static final String CYCLE_DURATION_UNIT_FIELD_NAME
      See Also:

    • CYCLE_DURATION_FIELD_NAME

      protected static final String CYCLE_DURATION_FIELD_NAME
      See Also:

    • TIMED_DOSAGE_FIELD_NAME

      protected static final String TIMED_DOSAGE_FIELD_NAME
      See Also:

    • NUMBER_OF_DOSES_PER_CYCLE_FIELD_NAME

      protected static final String NUMBER_OF_DOSES_PER_CYCLE_FIELD_NAME
      See Also:

    • DEFAULT_NUMBER_OF_DOSES_PER_CYCLE

      protected static final int DEFAULT_NUMBER_OF_DOSES_PER_CYCLE
      See Also:

    • cycleDurationUnit

      protected TimeUnit cycleDurationUnit
      The cycle duration unit.

    • cycleDuration

      protected int cycleDuration
      The duration of a cycle.

    • timedDosage

      protected TimedDosage timedDosage
      Timing and dose of a medication to be applied. Supported types: DosageOnly, Times, DaySegments, Interval, WeekDaysDosage and DaysOfMonthDosage. WeekDaysDosage is supported only if the cycle curation unit is a week. DaysOfMonthDosage is supported only if the cycle duration unit is a month.

    • numberOfDosesPerCycle

      protected @Nullable Integer numberOfDosesPerCycle
      Number of doses (as specified by tdo) to be applied per cycle. By default, 1 is assumed.

  • Constructor Details

    • CyclicDosage

      public CyclicDosage()

  • Method Details

    • getNumberOfDosesPerCycle

      public int getNumberOfDosesPerCycle()

    • validate

      public ValidationResult validate(@Nullable String basePath)
      Description copied from interface: EMediplanObject
      Validates the eMediplan object, without any further context than its JSON path and its own content, against the eMediplan specs.
      Specified by:
      validate in interface EMediplanObject
      Overrides:
      validate in class PosologyDetail
      Parameters:
      basePath - The JSON path of this object. If null, the object is considered to be root. Any validation issues produced by the validation will use this path as a base for each issue's path.
      Returns:
      The validation result containing all the encountered validation issues, if any.

    • trim

      public void trim()
      Description copied from interface: EMediplanObject
      Trims the eMediplan object, that is, removes any redundant info and sets to null values that match the default assumed value by the specs, to shorten the serialized result.