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

Class ChMed23AEMediplan

java.lang.Object

org.projecthusky.fhir.emed.ch.epr.model.emediplan.EMediplan<ChMed23AExtension,ChMed23AGender,ChMed23AMedicament,ChMed23APatientId>

org.projecthusky.fhir.emed.ch.epr.model.emediplan.chmed23a.ChMed23AEMediplan

All Implemented Interfaces:

ChMed23AExtendable, EMediplanExtendable<ChMed23AExtension>, EMediplanHealthcareProCarrier<ChMed23AHealthcarePerson,ChMed23AHealthcareOrganization>, EMediplanObject

public class ChMed23AEMediplan
extends EMediplan<ChMed23AExtension,ChMed23AGender,ChMed23AMedicament,ChMed23APatientId>
implements ChMed23AExtendable, EMediplanHealthcareProCarrier<ChMed23AHealthcarePerson,ChMed23AHealthcareOrganization>

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

Based on the CHMed23A specs doc version 2.1 and the CHMed23A posology specs doc version 2.1.

Field Summary

Fields

Modifier and Type	Field	Description
protected EMediplanAuthor	author	The type of author of the document.
static final String	EMEDIPLAN_VERSION
protected @Nullable List<@NonNull ChMed23AExtension>	extensions	The list of extensions.
protected static final String	HEALTHCARE_ORGANIZATION_FIELD_NAME
protected static final String	HEALTHCARE_PERSON_FIELD_NAME
protected @Nullable ChMed23AHealthcareOrganization	healthcareOrganization	The healthcare organization in which the HealthcarePerson works.
protected @Nullable ChMed23AHealthcarePerson	healthcarePerson	The healthcare person author of the document, required if the document author type is an HCP.
protected @Nullable String	id	The id of the Medication object.
protected List<@NonNull ChMed23AMedicament>	medicaments	List of medications.
protected ChMed23APatient	patient	The patient.
protected @Nullable String	recipient	The recipient (GLN) of the electronic prescription.
protected @Nullable String	remark	Remark.
protected Instant	timestamp	The date of creation.
protected @Nullable EMediplanType	type	The type of Medication object, see EMediplanType.

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

EMEDIPLAN_TIMEZONE

Constructor Summary

Constructors

Constructor	Description
ChMed23AEMediplan()

Method Summary

Modifier and Type	Method	Description
String	getChTransmissionFormatPrefix()
String	getEmediplanVersion()
List<@NonNull ChMed23AExtension>	getExtensions()	Gets the list of this object's extensions.
String	getHealthcareOrganizationFieldName()
String	getHealthcarePersonFieldName()
List<@NonNull ChMed23AMedicament>	getMedicaments()
boolean	hasExtensions(boolean inDepth)	Whether the eMediplan object has any extension or not.
boolean	isAuthorProfessional()	Whether the author of the eMediplan is of a professional nature (pro/org) or a patient.
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.chmed23a.ChMed23AExtendable

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

getHealthcareOrganization, getHealthcarePerson, validateHealtcareProInfo

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

HEALTHCARE_PERSON_FIELD_NAME

protected static final String HEALTHCARE_PERSON_FIELD_NAME

See Also:

• Constant Field Values

HEALTHCARE_ORGANIZATION_FIELD_NAME

protected static final String HEALTHCARE_ORGANIZATION_FIELD_NAME

See Also:

• Constant Field Values

patient

protected ChMed23APatient patient

The patient.

healthcarePerson

protected @Nullable ChMed23AHealthcarePerson healthcarePerson

The healthcare person author of the document, required if the document author type is an HCP.

healthcareOrganization

protected @Nullable ChMed23AHealthcareOrganization healthcareOrganization

The healthcare organization in which the HealthcarePerson works. Required if the document author type is an HCP.

medicaments

protected List<@NonNull ChMed23AMedicament> medicaments

List of medications.

extensions

protected @Nullable List<@NonNull ChMed23AExtension> extensions

The list of extensions. Optional if empty.

type

protected @Nullable EMediplanType type

The type of Medication object, see EMediplanType. It is allowed to be missing if the author is a person, in which case it is assumed that it is a EMediplanType.MEDICATION_PLAN.

id

protected @Nullable String id

The id of the Medication object. The eMediplan document creator is responsible for assigning the id.

author

protected EMediplanAuthor author

The type of author of the document.

recipient

protected @Nullable String recipient

The recipient (GLN) of the electronic prescription. To be used if the electronic prescription is to be transmitted electronically to a healthcare professional.

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 or advice the author would like to share independently of a specific medicament.

Constructor Details

ChMed23AEMediplan

public ChMed23AEMediplan()

Method Details

getHealthcarePersonFieldName

public String getHealthcarePersonFieldName()

Specified by:

getHealthcarePersonFieldName in interface EMediplanHealthcareProCarrier<ChMed23AHealthcarePerson,ChMed23AHealthcareOrganization>

getHealthcareOrganizationFieldName

public String getHealthcareOrganizationFieldName()

Specified by:

getHealthcareOrganizationFieldName in interface EMediplanHealthcareProCarrier<ChMed23AHealthcarePerson,ChMed23AHealthcareOrganization>

getMedicaments

public List<@NonNull ChMed23AMedicament> getMedicaments()

Specified by:

getMedicaments in class EMediplan<ChMed23AExtension,ChMed23AGender,ChMed23AMedicament,ChMed23APatientId>

getExtensions

public List<@NonNull ChMed23AExtension> getExtensions()

Description copied from interface: EMediplanExtendable

Gets the list of this object's extensions.

Specified by:

getExtensions in interface EMediplanExtendable<ChMed23AExtension>

Returns:

The list of extensions.

resolveType

@ExpectsValidResource
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<ChMed23AExtension,ChMed23AGender,ChMed23AMedicament,ChMed23APatientId>

Returns:

The resolved EMediplanType.

isAuthorProfessional

public boolean isAuthorProfessional()

Description copied from interface: EMediplanHealthcareProCarrier

Whether the author of the eMediplan is of a professional nature (pro/org) or a patient.

Specified by:

isAuthorProfessional in interface EMediplanHealthcareProCarrier<ChMed23AHealthcarePerson,ChMed23AHealthcareOrganization>

Returns:

true if the author is a professional, false otherwise.

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<ChMed23AExtension,ChMed23AGender,ChMed23AMedicament,ChMed23APatientId>

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.

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.

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<ChMed23AExtension>

Specified by:

trim in interface EMediplanObject

Overrides:

trim in class EMediplan<ChMed23AExtension,ChMed23AGender,ChMed23AMedicament,ChMed23APatientId>

getEmediplanVersion

public String getEmediplanVersion()

Specified by:

getEmediplanVersion in class EMediplan<ChMed23AExtension,ChMed23AGender,ChMed23AMedicament,ChMed23APatientId>

getChTransmissionFormatPrefix

public String getChTransmissionFormatPrefix()

Specified by:

getChTransmissionFormatPrefix in class EMediplan<ChMed23AExtension,ChMed23AGender,ChMed23AMedicament,ChMed23APatientId>