Package org.projecthusky.fhir.emed.ch.epr.model.emediplan.chmed16a

Class ChMed16AMedicament

java.lang.Object

org.projecthusky.fhir.emed.ch.epr.model.emediplan.EMediplanMedicament<ChMed16AExtension>

org.projecthusky.fhir.emed.ch.epr.model.emediplan.chmed16a.ChMed16AMedicament

All Implemented Interfaces:

ChMed16AExtendable, EMediplanExtendable<ChMed16AExtension>, EMediplanObject

Direct Known Subclasses:

EPrescriptionMedicament

public class ChMed16AMedicament
extends EMediplanMedicament<ChMed16AExtension>
implements ChMed16AExtendable

Information about a medication as well as its dosage.

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable String	applicationInstructions	Application instructions (further information on how to apply the medication, e.g. take before meals).
protected @Nullable List<@NonNull ChMed16AExtension>	extensions	Extensions.
protected static final String	FORBID_SUBSTITUTION_FIELD_NAME
protected @Nullable Integer	forbidSubstitution	1 if medicament should not be substituted, 0 otherwise.
protected String	id	The ID defined in the IdType below.
protected static final String	ID_FIELD_NAME
protected static final String	ID_TYPE_FIELD_NAME
protected MedicamentIdType	idType	The type of id.
protected static final String	NUMBER_OF_PACKAGES_FIELD_NAME
protected @Nullable Double	numberOfPackages	Number of packages to be delivered.
protected List<@NonNull ChMed16APosology>	posology	The list of posologies.
protected static final String	POSOLOGY_FIELD_NAME
protected static final String	PRESCRIBED_BY_FIELD_NAME
protected @Nullable String	prescriber	Prescribed by: the GLN or designation of the person who prescribed the medicament (e.g. physician, pharmacist etc.)
protected @Nullable String	reason	Taking reason (the reason for the medication treatment).
protected @Nullable Integer	repetition	Integer which defines the number of repetitions in months, e.g. permanent prescription for 6 months.
protected static final String	REPETITION_FIELD_NAME
protected static final String	ROUTE_OF_ADMINISTRATION_FIELD_NAME
protected @Nullable CdTyp26	routeOfAdministration	Route of administration.
protected static final String	SELF_MEDICATION_FIELD_NAME
protected @Nullable Integer	selfMedication	Auto-medication (self-medication), 1 if it is auto-medication, 0 otherwise.
protected static final String	TAKING_REASON_FIELD_NAME
protected @Nullable CdTyp9	unit	The quantity unit.
protected static final String	UNIT_FIELD_NAME

Fields inherited from class org.projecthusky.fhir.emed.ch.epr.model.emediplan.EMediplanMedicament

DEFAULT_NUMBER_OF_PACKAGES

Constructor Summary

Constructors

Constructor	Description
ChMed16AMedicament()

Method Summary

Modifier and Type	Method	Description
void	forbidSubstitution(@Nullable Boolean substitutionForbidden)
List<@NonNull ChMed16AExtension>	getExtensions()	Gets the list of this object's extensions.
String	getIdFieldName()
String	getIdTypeFieldName()
String	getNumberOfPackagesFieldName()
List<@NonNull ChMed16APosology>	getPosology()
String	getRepetitionFieldName()
boolean	hasExtensions(boolean inDepth)	Whether the eMediplan object has any extension or not.
boolean	isSelfMedication()	This method expects the Medicament object to be valid.
boolean	isSubstitutionForbidden()
void	setSelfMedication(boolean selfMedication)	Convenience method to set the self-medication property using a boolean.
void	trim()	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.
ValidationResult	validate(@Nullable String basePath, EMediplanType mediplanType)	Context-aware validation, that takes into account whether the eMediplan document is a treatment plan or a prescription.
ValidationResult	validateBase(@Nullable String basePath, boolean contextAwareCaller)

Methods inherited from class org.projecthusky.fhir.emed.ch.epr.model.emediplan.EMediplanMedicament

getId, getIdType, getNumberOfPackages, getPrescriber, getReason, resolveNumberOfPackages, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.projecthusky.fhir.emed.ch.epr.model.emediplan.chmed16a.ChMed16AExtendable

findExtension, getExtensionsFieldName

Methods inherited from interface org.projecthusky.fhir.emed.ch.epr.model.emediplan.EMediplanExtendable

addExtension, validateExtensions

Methods inherited from interface org.projecthusky.fhir.emed.ch.epr.model.emediplan.EMediplanObject

getFieldValidationPath, getFieldValidationPath, getIgnoredFieldValidationIssue, getRequiredFieldValidationIssue, getValidationIssue, validate, validate

Field Details

ID_FIELD_NAME

protected static final String ID_FIELD_NAME

See Also:

• Constant Field Values

ID_TYPE_FIELD_NAME

protected static final String ID_TYPE_FIELD_NAME

See Also:

• Constant Field Values

POSOLOGY_FIELD_NAME

protected static final String POSOLOGY_FIELD_NAME

See Also:

• Constant Field Values

UNIT_FIELD_NAME

protected static final String UNIT_FIELD_NAME

See Also:

• Constant Field Values

TAKING_REASON_FIELD_NAME

protected static final String TAKING_REASON_FIELD_NAME

See Also:

• Constant Field Values

SELF_MEDICATION_FIELD_NAME

protected static final String SELF_MEDICATION_FIELD_NAME

See Also:

• Constant Field Values

PRESCRIBED_BY_FIELD_NAME

protected static final String PRESCRIBED_BY_FIELD_NAME

See Also:

• Constant Field Values

ROUTE_OF_ADMINISTRATION_FIELD_NAME

protected static final String ROUTE_OF_ADMINISTRATION_FIELD_NAME

See Also:

• Constant Field Values

REPETITION_FIELD_NAME

protected static final String REPETITION_FIELD_NAME

See Also:

• Constant Field Values

FORBID_SUBSTITUTION_FIELD_NAME

protected static final String FORBID_SUBSTITUTION_FIELD_NAME

See Also:

• Constant Field Values

NUMBER_OF_PACKAGES_FIELD_NAME

protected static final String NUMBER_OF_PACKAGES_FIELD_NAME

See Also:

• Constant Field Values

id

protected String id

The ID defined in the IdType below. If the IdType is 'None', add a free text description here.

idType

protected MedicamentIdType idType

The type of id.

posology

protected List<@NonNull ChMed16APosology> posology

The list of posologies.

unit

protected @Nullable CdTyp9 unit

The quantity unit. Mandatory if Pos is defined. (The unit must be based on the standardized substance in the INDEX database.)

reason

protected @Nullable String reason

Taking reason (the reason for the medication treatment).

applicationInstructions

protected @Nullable String applicationInstructions

Application instructions (further information on how to apply the medication, e.g. take before meals).

selfMedication

protected @Nullable Integer selfMedication

Auto-medication (self-medication), 1 if it is auto-medication, 0 otherwise.

prescriber

protected @Nullable String prescriber

Prescribed by: the GLN or designation of the person who prescribed the medicament (e.g. physician, pharmacist etc.)

routeOfAdministration

protected @Nullable CdTyp26 routeOfAdministration

Route of administration. Possible values: CDTYP 26 in HCI's INDEX database/CODE schema.

repetition

protected @Nullable Integer repetition

Integer which defines the number of repetitions in months, e.g. permanent prescription for 6 months.

forbidSubstitution

protected @Nullable Integer forbidSubstitution

1 if medicament should not be substituted, 0 otherwise. Default: 0

numberOfPackages

protected @Nullable Double numberOfPackages

Number of packages to be delivered. Default: 1

extensions

protected @Nullable List<@NonNull ChMed16AExtension> extensions

Extensions.

Constructor Details

ChMed16AMedicament

public ChMed16AMedicament()

Method Details

getRepetitionFieldName

public String getRepetitionFieldName()

getNumberOfPackagesFieldName

public String getNumberOfPackagesFieldName()

getIdFieldName

public String getIdFieldName()

Specified by:

getIdFieldName in class EMediplanMedicament<ChMed16AExtension>

getIdTypeFieldName

public String getIdTypeFieldName()

Specified by:

getIdTypeFieldName in class EMediplanMedicament<ChMed16AExtension>

getExtensions

public List<@NonNull ChMed16AExtension> getExtensions()

Description copied from interface: EMediplanExtendable

Gets the list of this object's extensions.

Specified by:

getExtensions in interface EMediplanExtendable<ChMed16AExtension>

Returns:

The list of extensions.

getPosology

public List<@NonNull ChMed16APosology> getPosology()

setSelfMedication

public void setSelfMedication(boolean selfMedication)

Convenience method to set the self-medication property using a boolean.

isSelfMedication

@ExpectsValidResource
public boolean isSelfMedication()

This method expects the Medicament object to be valid. This means that it expects that the only case for the self-medication property to be null is when the document is a prescription and, in this case, it assumes that it is therefore not a self-medication. When not-null, the value returned is that of the property.

Specified by:

isSelfMedication in class EMediplanMedicament<ChMed16AExtension>

Returns:

Whether the medication is a self-medication treatment or a prescribed one.

isSubstitutionForbidden

public boolean isSubstitutionForbidden()

Specified by:

isSubstitutionForbidden in class EMediplanMedicament<ChMed16AExtension>

forbidSubstitution

public void forbidSubstitution(@Nullable Boolean substitutionForbidden)

Specified by:

forbidSubstitution in class EMediplanMedicament<ChMed16AExtension>

validateBase

public ValidationResult validateBase(@Nullable String basePath,
 boolean contextAwareCaller)

Overrides:

validateBase in class EMediplanMedicament<ChMed16AExtension>

Parameters:

basePath - The object's JSON path.

contextAwareCaller - Whether the method was called from a basic object validation (i.e. EMediplanMedicament.validate(String)) or with context (i.e. EMediplanMedicament.validate(String, EMediplanType)). This allows avoiding redundant checks, if the context-aware caller will also invoke children validation that are context-aware, thus the basic validator will skip those.

Returns:

The validation result.

validate

public ValidationResult validate(@Nullable String basePath,
 EMediplanType mediplanType)

Description copied from class: EMediplanMedicament

Context-aware validation, that takes into account whether the eMediplan document is a treatment plan or a prescription.

Overrides:

validate in class EMediplanMedicament<ChMed16AExtension>

Parameters:

basePath - The object's JSON path.

mediplanType - The eMediplan document type.

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.

Specified by:

trim in interface EMediplanExtendable<ChMed16AExtension>

Specified by:

trim in interface EMediplanObject

Overrides:

trim in class EMediplanMedicament<ChMed16AExtension>

hasExtensions

public boolean hasExtensions(boolean inDepth)

Description copied from interface: EMediplanObject

Whether the eMediplan object has any extension or not.

Specified by:

hasExtensions in interface EMediplanObject

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.