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

Class ChMed16AEMediplan<M extends ChMed16AMedicament>

java.lang.Object

org.projecthusky.fhir.emed.ch.epr.model.emediplan.EMediplan<ChMed16AExtension,ChMed16AGender,M,ChMed16APatientId>

org.projecthusky.fhir.emed.ch.epr.model.emediplan.chmed16a.ChMed16AEMediplan<M>

Type Parameters:

M - The type of ChMed16AMedicament. This is needed since revision 3 has added a new version of the medicament object for the ePrescription.

All Implemented Interfaces:

ChMed16AExtendable, EMediplanExtendable<ChMed16AExtension>, EMediplanObject

Direct Known Subclasses:

EPrescription

public class ChMed16AEMediplan<M extends ChMed16AMedicament>
extends EMediplan<ChMed16AExtension,ChMed16AGender,M,ChMed16APatientId>
implements ChMed16AExtendable

This is the main eMediplan object, called Medication in CHMED16A specification. It contains exactly one patient and a list of medications (named medicament in CHMED16A).

Based on the CHMED16A specs doc as published on its GitHub site as of 2025-06-25.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	author	Author (GLN2 if available, otherwise name).
protected static final String	AUTHOR_FIELD_NAME
protected static final String	EMEDIPLAN_TYPE_FIELD_NAME
static final String	EMEDIPLAN_VERSION
protected @Nullable List<@NonNull ChMed16AExtension>	extensions	The list of private fields.
protected static final String	EXTENSIONS_SCHEMA_FIELD_NAME
protected @Nullable String	extensionsSchema	The schema of the private fields.
protected String	id	The ID of the eMediplan object.
protected static final String	ID_FIELD_NAME
protected List<@NonNull M>	medicaments	The list of medicaments.
protected static final String	MEDICAMENTS_FIELD_NAME
protected ChMed16APatient	patient	The patient.
protected static final String	PATIENT_FIELD_NAME
protected @Nullable List<@NonNull ChMed16ARecommendation>	recommendations	The list of recommendations.
protected static final String	RECOMMENDATIONS_FIELD_NAME
protected @Nullable String	remark	Remark (any information/advice the author would like to share independently of a specific medicament).
protected static final String	REMARKS_FIELD_NAME
protected Instant	timestamp	The date of creation.
protected static final String	TIMESTAMP_FIELD_NAME
protected EMediplanType	type	The type of the Medication object.
protected static final String	VALIDATION_TIMESTAMP_FIELD_NAME
protected @Nullable Instant	validationTimestamp	Validate date: Date of validation, Format: YYYY-MM-DDThh:mm:ss±hh:mm (ISO 8601 Date and time with the offset)
protected @Nullable String	validator	Validate by: the GLN of the healthcare professional who has validated the medication plan.
protected static final String	VALIDATOR_FIELD_NAME
protected @Nullable String	zsr	ZSR (Zahlstellenregister) number of the author or their organisation.
protected static final String	ZSR_FIELD_NAME

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

EMEDIPLAN_TIMEZONE

Constructor Summary

Constructors

Constructor	Description
ChMed16AEMediplan()

Method Summary

Modifier and Type	Method	Description
String	getChTransmissionFormatPrefix()
String	getEmediplanVersion()
List<@NonNull ChMed16AExtension>	getExtensions()	Gets the list of this object's extensions.
List<@NonNull M>	getMedicaments()
boolean	hasExtensions(boolean inDepth)	Whether the eMediplan object has any extension or not.
EMediplanType	resolveType()	Resolves the eMediplan type, which can be missing for ChMed23A eMediplan objects authored by a patient, because a Medication Plan is assumed (since they are not allowed to author prescriptions).
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)	Validates the eMediplan object, without any further context than its JSON path and its own content, against the eMediplan specs.

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

addMedicament, compressJson, getId, getPatient, getRemark, getTimestamp, getType, toChTransmissionFormat, uncompressJson

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

Field Details

EMEDIPLAN_VERSION

public static final String EMEDIPLAN_VERSION

See Also:

• Constant Field Values

PATIENT_FIELD_NAME

protected static final String PATIENT_FIELD_NAME

See Also:

• Constant Field Values

MEDICAMENTS_FIELD_NAME

protected static final String MEDICAMENTS_FIELD_NAME

See Also:

• Constant Field Values

RECOMMENDATIONS_FIELD_NAME

protected static final String RECOMMENDATIONS_FIELD_NAME

See Also:

• Constant Field Values

EMEDIPLAN_TYPE_FIELD_NAME

protected static final String EMEDIPLAN_TYPE_FIELD_NAME

See Also:

• Constant Field Values

ID_FIELD_NAME

protected static final String ID_FIELD_NAME

See Also:

• Constant Field Values

AUTHOR_FIELD_NAME

protected static final String AUTHOR_FIELD_NAME

See Also:

• Constant Field Values

ZSR_FIELD_NAME

protected static final String ZSR_FIELD_NAME

See Also:

• Constant Field Values

TIMESTAMP_FIELD_NAME

protected static final String TIMESTAMP_FIELD_NAME

See Also:

• Constant Field Values

REMARKS_FIELD_NAME

protected static final String REMARKS_FIELD_NAME

See Also:

• Constant Field Values

VALIDATOR_FIELD_NAME

protected static final String VALIDATOR_FIELD_NAME

See Also:

• Constant Field Values

VALIDATION_TIMESTAMP_FIELD_NAME

protected static final String VALIDATION_TIMESTAMP_FIELD_NAME

See Also:

• Constant Field Values

EXTENSIONS_SCHEMA_FIELD_NAME

protected static final String EXTENSIONS_SCHEMA_FIELD_NAME

See Also:

• Constant Field Values

patient

protected ChMed16APatient patient

The patient.

medicaments

protected List<@NonNull M extends ChMed16AMedicament> medicaments

The list of medicaments.

recommendations

protected @Nullable List<@NonNull ChMed16ARecommendation> recommendations

The list of recommendations.

type

protected EMediplanType type

The type of the Medication object.

id

protected String id

The ID of the eMediplan object.

author

protected String author

Author (GLN2 if available, otherwise name).

eMediplan: GLN of a person or organisation

ePrescription: GLN of a person

The patient can also be the author of the eMediplan. In this case, the minimum requirement is that the term "patient" is used to designate the author. Optionally, the patient's first name, last name and date of birth can also be specified additionally.

zsr

protected @Nullable String zsr

ZSR (Zahlstellenregister) number of the author or their organisation.

timestamp

protected Instant timestamp

The date of creation. Format: yyyy-mm-ddThh:mm:ss+02:00 (ISO 86012 Combined date and time in UTC) (e.g. 2016-06-16T16:26:15+02:00)

remark

protected @Nullable String remark

Remark (any information/advice the author would like to share independently of a specific medicament).

validator

protected @Nullable String validator

Validate by: the GLN of the healthcare professional who has validated the medication plan.

validationTimestamp

protected @Nullable Instant validationTimestamp

Validate date: Date of validation, Format: YYYY-MM-DDThh:mm:ss±hh:mm (ISO 8601 Date and time with the offset)

extensionsSchema

protected @Nullable String extensionsSchema

The schema of the private fields. When empty or not specified, all private fields must be ignored.

extensions

protected @Nullable List<@NonNull ChMed16AExtension> extensions

The list of private fields.

Constructor Details

ChMed16AEMediplan

public ChMed16AEMediplan()

Method Details

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<M extends ChMed16AMedicament>

Returns:

The list of extensions.

getMedicaments

public List<@NonNull M> getMedicaments()

Specified by:

getMedicaments in class EMediplan<ChMed16AExtension,ChMed16AGender,M extends ChMed16AMedicament,ChMed16APatientId>

resolveType

public EMediplanType resolveType()

Description copied from class: EMediplan

Resolves the eMediplan type, which can be missing for ChMed23A eMediplan objects authored by a patient, because a Medication Plan is assumed (since they are not allowed to author prescriptions).

Specified by:

resolveType in class EMediplan<ChMed16AExtension,ChMed16AGender,M extends ChMed16AMedicament,ChMed16APatientId>

Returns:

The resolved EMediplanType.

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 EMediplan<ChMed16AExtension,ChMed16AGender,M extends ChMed16AMedicament,ChMed16APatientId>

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.

Specified by:

trim in interface EMediplanExtendable<M extends ChMed16AMedicament>

Specified by:

trim in interface EMediplanObject

Overrides:

trim in class EMediplan<ChMed16AExtension,ChMed16AGender,M extends ChMed16AMedicament,ChMed16APatientId>

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.

getEmediplanVersion

public String getEmediplanVersion()

Specified by:

getEmediplanVersion in class EMediplan<ChMed16AExtension,ChMed16AGender,M extends ChMed16AMedicament,ChMed16APatientId>

getChTransmissionFormatPrefix

public String getChTransmissionFormatPrefix()

Specified by:

getChTransmissionFormatPrefix in class EMediplan<ChMed16AExtension,ChMed16AGender,M extends ChMed16AMedicament,ChMed16APatientId>