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

Class ChMed23APosology

java.lang.Object
org.projecthusky.fhir.emed.ch.epr.model.emediplan.EMediplanPosology
org.projecthusky.fhir.emed.ch.epr.model.emediplan.chmed23a.posology.ChMed23APosology
All Implemented Interfaces:
EMediplanObject
public class ChMed23APosology extends EMediplanPosology
Describes when and what amount of medication must be taken.

  • Field Details

    • DETAIL_FIELD_NAME

      protected static final String DETAIL_FIELD_NAME
      See Also:

    • UNIT_FIELD_NAME

      protected static final String UNIT_FIELD_NAME
      See Also:

    • start

      protected @Nullable Instant start
      From date. Format: YYYY-MM-DDThh:mm:ss+02:00 or YYYY-MM-DD (ISO 8601 Combined date and time including time zone or date only) (e.g. 2016-06-16T16:26:15+02:00).

    • end

      protected @Nullable Instant end
      To date. Format: YYYY-MM-DDThh:mm:ss+02:00 or YYYY-MM-DD (ISO 8601 Combined date and time including time zone or date only) (e.g. 2016-06-16T16:26:15+02:00). The DtTo must be considered as inclusive. For example, DtTo: 2015-05-01, the patient must apply the medicament also on 2015-05-01.

    • asNeeded

      protected @Nullable Boolean asNeeded
      Reserve medication. True if in reserve, false otherwise. By default, false is assumed.

    • detail

      protected PosologyDetail detail
      Dosage details.

    • relativeToMeal

      protected @Nullable RelativeToMeal relativeToMeal
      Indicates whether a medication has to be taken relative to a meal.

    • unit

      protected @Nullable CdTyp9 unit
      The quantity unit. See allowed values.

    • applicationInstructions

      protected @Nullable String applicationInstructions
      Application instructions. Further information on how to apply the medication. Do not use for unstructured dosage information; use the inner posology object's free text instead.

    • routeOfAdministration

      protected @Nullable String routeOfAdministration
      The EDQM route of administration.

    • methodOfAdministration

      protected @Nullable String methodOfAdministration
      The EDQM method of administration.

  • Constructor Details

    • ChMed23APosology

      public ChMed23APosology()

  • Method Details

    • isInReserve

      protected boolean isInReserve()
      Specified by:
      isInReserve in class EMediplanPosology
      Returns:
      Whether the medication is in reserve or not. That is, whether it is to be taken only when needed (true) or strictly as defined by the posology (false).

    • 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 EMediplanPosology
      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.

    • hasExtensions

      public boolean hasExtensions(boolean inDepth)
      Description copied from interface: EMediplanObject
      Whether the eMediplan object has any extension or not.
      Parameters:
      inDepth - If true, the called object, and all its children objects, are subject to the check. If false, only the called object is checked for extensions.
      Returns:
      true if the object contains any extensions; false otherwise.

    • validate

      public ValidationResult validate(@Nullable String basePath, EMediplanType mediplanType)
      Performs validation of the eMediplan object taking into account whether it belongs to an eMediplan medication plan document or to an eMediplan prescription document. This performs the base checks of validate(String) plus extra validation checks tied to the eMediplan document type.
      Parameters:
      basePath - The base path of the object.
      mediplanType - The type of eMediplan document.
      Returns:
      The validation result.

    • 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.