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

Class EPrescription

java.lang.Object

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

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

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

All Implemented Interfaces:

ChMed16AExtendable, EMediplanExtendable<ChMed16AExtension>, EMediplanHealthcareProCarrier<ChMed16AHealthcarePerson,ChMed16AHealthcareOrganization>, EMediplanObject

public class EPrescription
extends ChMed16AEMediplan<EPrescriptionMedicament>
implements EMediplanHealthcareProCarrier<ChMed16AHealthcarePerson,ChMed16AHealthcareOrganization>

Model according to the specifications of eMediplan in the context of ePrescription. This extends the base ChMed16AEMediplan model.

This class is intended for ePrescription following at least revision 2 of the CHMED16A Prescription specs. For revision 1, just use ChMed16AEMediplan instead.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	HEALTHCARE_ORGANIZATION_FIELD_NAME
protected static final String	HEALTHCARE_PERSON_FIELD_NAME
protected ChMed16AHealthcareOrganization	healthcareOrganization	The healthcare organization in which the HealthcarePerson works.
protected ChMed16AHealthcarePerson	healthcarePerson	The healthcare person (the author of the document).
static final int	LAST_SUPPORTED_REVISION
protected static final int	POSTAL_CODE_REV3_MAX_LENGTH
protected @Nullable Integer	revision	The revision number of the specification.
protected static final String	REVISION_FIELD_NAME
protected static final int	ZSR_REV3_MAX_LENGTH

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

author, AUTHOR_FIELD_NAME, EMEDIPLAN_TYPE_FIELD_NAME, EMEDIPLAN_VERSION, extensions, EXTENSIONS_SCHEMA_FIELD_NAME, extensionsSchema, id, ID_FIELD_NAME, medicaments, MEDICAMENTS_FIELD_NAME, patient, PATIENT_FIELD_NAME, recommendations, RECOMMENDATIONS_FIELD_NAME, remark, REMARKS_FIELD_NAME, timestamp, TIMESTAMP_FIELD_NAME, type, VALIDATION_TIMESTAMP_FIELD_NAME, validationTimestamp, validator, VALIDATOR_FIELD_NAME, zsr, ZSR_FIELD_NAME

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

EMEDIPLAN_TIMEZONE

Constructor Summary

Constructors

Constructor	Description
EPrescription()

Method Summary

Modifier and Type	Method	Description
static EPrescription	fromChTransmissionFormat(String chTransmission)	Parses an ePrescription from a ChTransmissionFormat String, as specified by eMediplan.
String	getHealthcareOrganizationFieldName()
String	getHealthcarePersonFieldName()
boolean	hasExtensions(boolean inDepth)	Whether the eMediplan object has any extension or not.
boolean	isAuthorProfessional()	In ePrescription, the author is always a professional.
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.
protected void	validateRev3Constraints(@Nullable String basePath, ValidationResult result)	This method validates specific constraints added with rev3 of the eMediplan ePrescription exchange format.

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

getChTransmissionFormatPrefix, getEmediplanVersion, getExtensions, getMedicaments, resolveType

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

REVISION_FIELD_NAME

protected static final String REVISION_FIELD_NAME

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

POSTAL_CODE_REV3_MAX_LENGTH

protected static final int POSTAL_CODE_REV3_MAX_LENGTH

See Also:

• Constant Field Values

ZSR_REV3_MAX_LENGTH

protected static final int ZSR_REV3_MAX_LENGTH

See Also:

• Constant Field Values

LAST_SUPPORTED_REVISION

public static final int LAST_SUPPORTED_REVISION

See Also:

• Constant Field Values

revision

protected @Nullable Integer revision

The revision number of the specification. If no revision number is specified, it is assumed it uses revision 1 (the eMediplan base spec).

Since:

CHMED16A Prescription rev 2.

healthcarePerson

protected ChMed16AHealthcarePerson healthcarePerson

The healthcare person (the author of the document).

Since:

CHMED16A Prescription rev 2.

healthcareOrganization

protected ChMed16AHealthcareOrganization healthcareOrganization

The healthcare organization in which the HealthcarePerson works.

Since:

CHMED16A Prescription rev 2.

Constructor Details

EPrescription

public EPrescription()

Method Details

getHealthcarePersonFieldName

public String getHealthcarePersonFieldName()

Specified by:

getHealthcarePersonFieldName in interface EMediplanHealthcareProCarrier<ChMed16AHealthcarePerson,ChMed16AHealthcareOrganization>

getHealthcareOrganizationFieldName

public String getHealthcareOrganizationFieldName()

Specified by:

getHealthcareOrganizationFieldName in interface EMediplanHealthcareProCarrier<ChMed16AHealthcarePerson,ChMed16AHealthcareOrganization>

isAuthorProfessional

public boolean isAuthorProfessional()

In ePrescription, the author is always a professional.

Specified by:

isAuthorProfessional in interface EMediplanHealthcareProCarrier<ChMed16AHealthcarePerson,ChMed16AHealthcareOrganization>

Returns:

true.

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 ChMed16AEMediplan<EPrescriptionMedicament>

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.

validateRev3Constraints

protected void validateRev3Constraints(@Nullable String basePath,
 ValidationResult result)

This method validates specific constraints added with rev3 of the eMediplan ePrescription exchange format.

While a different approach of delegating new constraints to the objects themselves would have seemed cleaner, it would have required a refactoring for only a few simple extra checks. For the moment being, the approach of adding a new method per revision to add the newly added checks has been adopted. This decision might be reconsidered at a later stage.

Parameters:

basePath -

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 ChMed16AEMediplan<EPrescriptionMedicament>

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

Overrides:

hasExtensions in class ChMed16AEMediplan<EPrescriptionMedicament>

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.

fromChTransmissionFormat

@ExpectsValidResource
public static EPrescription fromChTransmissionFormat(String chTransmission)
                                              throws IOException

Parses an ePrescription from a ChTransmissionFormat String, as specified by eMediplan.

Parameters:

chTransmission - The transmission content, e.g. CHMED16A1H4sIAAAAAAAAAzWPMU/DMBCFZ/IrolvB0p3b+O6yUSEEEkUM3RCDW7uiQyNE3AFV+e84diN5ed/ze093bdoWPnw6xSFB316zzOD53Z9jlvDihxEeKnxb4PYypvi74M3THARSZkOUH9xlY5pd2MZwOuTUkMb857ME6kQ2X8OcYyfYEWuHa3S3zmLu/n7mNVvI1HwthTe+Krp2+OACd7I3qvFoSOloNAgZF0UcH7yGzpdqeLyk77qKhIjMwqLVqmdYtCuDzljZEfUo/Vrv0faI0Ez/cZpKMywBAAA=

Returns:

The parsed EPrescription object.

Throws:

IOException - If there was an I/O parsing error.

InvalidEmedContentException - if there were content errors that prevented parsing.