Package org.emau.icmvc.magic.fhir.datatypes

Class AssignedConsentModule

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.Element

org.hl7.fhir.r4.model.Type

org.emau.icmvc.magic.fhir.datatypes.AssignedConsentModule

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType

public class AssignedConsentModule
extends org.hl7.fhir.r4.model.Type
implements org.hl7.fhir.instance.model.api.ICompositeType

FHIR Datatype to hold assigned module specific information for templates

Author:

bialkem

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AssignedConsentModule.PatientConsentStatus	internal enumeration to differentiate types of patient consent status internal use only

Field Summary

Fields inherited from class org.hl7.fhir.r4.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
AssignedConsentModule()
AssignedConsentModule(String moduleKey, List<AssignedConsentModule.PatientConsentStatus> displayCheckBoxes, AssignedConsentModule.PatientConsentStatus defaultConsentStatus, Boolean mandatoryModule)	create new instance of AssignedConsentModule using only obligatory parameters
AssignedConsentModule(String moduleKey, List<AssignedConsentModule.PatientConsentStatus> displayCheckBoxes, AssignedConsentModule.PatientConsentStatus defaultConsentStatus, Boolean mandatoryModule, String comment, Integer orderNumber)	create new instance of AssignedConsentModule using additional parameters
AssignedConsentModule(String moduleKey, List<AssignedConsentModule.PatientConsentStatus> displayCheckBoxes, AssignedConsentModule.PatientConsentStatus defaultConsentStatus, Boolean mandatoryModule, String comment, Integer orderNumber, String externProperties)	create new instance of AssignedConsentModule using additional parameters
AssignedConsentModule(String moduleKey, List<AssignedConsentModule.PatientConsentStatus> displayCheckBoxes, AssignedConsentModule.PatientConsentStatus defaultConsentStatus, Boolean mandatoryModule, String comment, Integer orderNumber, String externProperties, String expirationProperties)	create new instance of AssignedConsentModule using additional parameters

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getComment()	get comment to describe purpose of AssignedConsentModule
String	getDefaultConsentStatus()	get defaultConsentStatus of AssignedConsentModule
List<AssignedConsentModule.PatientConsentStatus>	getDisplayCheckBoxes()	get list of check box values of type PatientConsentStatus of AssignedConsentModule
String	getDisplayCheckBoxesAsString()	get list of check box values of type PatientConsentStatus of AssignedConsentModule as string
String	getExpirationProperties()	get expirationProperties of assigned module
String	getExternProperties()	get externProperties of assigned module
Boolean	getMandatory()	get mandatory state of AssignedConsentModule
String	getModuleKey()	get module reference as semicolon separated string
Integer	getOrderNumber()	get orderNumber of AssignedConsentModule
int	hashCode()
boolean	isEmpty()
AssignedConsentModule	setComment(String moduleComment)	set comment to describe purpose of AssignedConsentModule
AssignedConsentModule	setDefaultConsentStatus(AssignedConsentModule.PatientConsentStatus defaultState)	set defaultConsentStatus of AssignedConsentModule
AssignedConsentModule	setDisplayCheckBoxes(List<AssignedConsentModule.PatientConsentStatus> toBeDisplayedCheckBoxes)	set list of check box values of type PatientConsentStatus of AssignedConsentModule
AssignedConsentModule	setExpirationProperties(String expirationProperties)	set expirationProperties of assigned module
AssignedConsentModule	setExternProperties(String externProperties)	set externProperties of assigned module with 0-n properties separated by semicolon e.g.
AssignedConsentModule	setMandatory(Boolean mandatory)	set mandatory state of AssignedConsentModule
AssignedConsentModule	setModuleKey(String consentmodulekey)	setmodule reference as semicolon separated string
AssignedConsentModule	setOrderNumber(Integer moduleOrdNo)	set orderNumber of AssignedConsentModule
String	toString()
protected org.hl7.fhir.r4.model.Type	typedCopy()

Methods inherited from class org.hl7.fhir.r4.model.Type

copy

Methods inherited from class org.hl7.fhir.r4.model.Element

addChild, addExtension, addExtension, addExtension, copyValues, equalsDeep, equalsShallow, fhirType, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, getNamedProperty, getProperty, getTypesForProperty, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, listChildren, makeProperty, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setProperty, setProperty

Methods inherited from class org.hl7.fhir.r4.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

getUserData, setUserData

Constructor Details

AssignedConsentModule

public AssignedConsentModule()

AssignedConsentModule

public AssignedConsentModule(String moduleKey,
 List<AssignedConsentModule.PatientConsentStatus> displayCheckBoxes,
 AssignedConsentModule.PatientConsentStatus defaultConsentStatus,
 Boolean mandatoryModule)

create new instance of AssignedConsentModule using only obligatory parameters

Parameters:

moduleKey - module reference as semicolon separated string

displayCheckBoxes - list of to be displayed checkbox values for patient consent status

defaultConsentStatus - to be used default patient consent status for this module

mandatoryModule - true if acceptance of this module should be mandatory for the consent template

AssignedConsentModule

public AssignedConsentModule(String moduleKey,
 List<AssignedConsentModule.PatientConsentStatus> displayCheckBoxes,
 AssignedConsentModule.PatientConsentStatus defaultConsentStatus,
 Boolean mandatoryModule,
 String comment,
 Integer orderNumber,
 String externProperties,
 String expirationProperties)

create new instance of AssignedConsentModule using additional parameters

Parameters:

moduleKey - module reference as semicolon separated string

displayCheckBoxes - list of to be displayed checkbox values for patient consent status

defaultConsentStatus - to be used default patient consent status for this module

mandatoryModule - true if acceptance of this module should be mandatory for the consent template

comment - comment

orderNumber - ordernumber to change order of modules in template (future use)

externProperties - externProperties for assigned module

expirationProperties - expirationProperties for assigned module

AssignedConsentModule

public AssignedConsentModule(String moduleKey,
 List<AssignedConsentModule.PatientConsentStatus> displayCheckBoxes,
 AssignedConsentModule.PatientConsentStatus defaultConsentStatus,
 Boolean mandatoryModule,
 String comment,
 Integer orderNumber,
 String externProperties)

create new instance of AssignedConsentModule using additional parameters

Parameters:

moduleKey - module reference as semicolon separated string

displayCheckBoxes - list of to be displayed checkbox values for patient consent status

defaultConsentStatus - to be used default patient consent status for this module

mandatoryModule - true if acceptance of this module should be mandatory for the consent template

comment - comment

orderNumber - ordernumber to change order of modules in template (future use)

externProperties - externProperties for assigned module

AssignedConsentModule

public AssignedConsentModule(String moduleKey,
 List<AssignedConsentModule.PatientConsentStatus> displayCheckBoxes,
 AssignedConsentModule.PatientConsentStatus defaultConsentStatus,
 Boolean mandatoryModule,
 String comment,
 Integer orderNumber)

create new instance of AssignedConsentModule using additional parameters

Parameters:

moduleKey - module reference as semicolon separated string

displayCheckBoxes - list of to be displayed checkbox values for patient consent status

defaultConsentStatus - to be used default patient consent status for this module

mandatoryModule - true if acceptance of this module should be mandatory for the consent template

comment - comment

orderNumber - ordernumber to change order of modules in template (future use)

Method Details

getMandatory

public Boolean getMandatory()

get mandatory state of AssignedConsentModule

Returns:

mandatory state of AssignedConsentModule

setMandatory

public AssignedConsentModule setMandatory(Boolean mandatory)

set mandatory state of AssignedConsentModule

Parameters:

mandatory - required state of AssignedConsentModule

Returns:

instance of AssignedConsentModule

getComment

public String getComment()

get comment to describe purpose of AssignedConsentModule

Returns:

comment to describe purpose of AssignedConsentModule

setComment

public AssignedConsentModule setComment(String moduleComment)

set comment to describe purpose of AssignedConsentModule

Parameters:

moduleComment - comment to describe purpose of AssignedConsentModule

Returns:

instance of AssignedConsentModule

getModuleKey

public String getModuleKey()

get module reference as semicolon separated string

Returns:

referenced module key

setModuleKey

public AssignedConsentModule setModuleKey(String consentmodulekey)

setmodule reference as semicolon separated string

Parameters:

consentmodulekey - referenced module to be assigned to template, as semicolon separated string

Returns:

instance of AssignedConsentModule

getDefaultConsentStatus

public String getDefaultConsentStatus()

get defaultConsentStatus of AssignedConsentModule

Returns:

defaultConsentStatus of AssignedConsentModule

setDefaultConsentStatus

public AssignedConsentModule setDefaultConsentStatus(AssignedConsentModule.PatientConsentStatus defaultState)

set defaultConsentStatus of AssignedConsentModule

Parameters:

defaultState - defaultConsentStatus of AssignedConsentModule

Returns:

instance of AssignedConsentModule

getOrderNumber

public Integer getOrderNumber()

get orderNumber of AssignedConsentModule

Returns:

orderNumber of AssignedConsentModule

setOrderNumber

public AssignedConsentModule setOrderNumber(Integer moduleOrdNo)

set orderNumber of AssignedConsentModule

Parameters:

moduleOrdNo - orderNumber of AssignedConsentModule

Returns:

instance of AssignedConsentModule

getDisplayCheckBoxes

public List<AssignedConsentModule.PatientConsentStatus> getDisplayCheckBoxes()

get list of check box values of type PatientConsentStatus of AssignedConsentModule

Returns:

assigned checkbox values of this AssignedConsentModule

getDisplayCheckBoxesAsString

public String getDisplayCheckBoxesAsString()

get list of check box values of type PatientConsentStatus of AssignedConsentModule as string

Returns:

assigned checkbox values of this AssignedConsentModule as string

setDisplayCheckBoxes

public AssignedConsentModule setDisplayCheckBoxes(List<AssignedConsentModule.PatientConsentStatus> toBeDisplayedCheckBoxes)

set list of check box values of type PatientConsentStatus of AssignedConsentModule

Parameters:

toBeDisplayedCheckBoxes - list of displayCheckBoxes for AssignedConsentModule

Returns:

instance of AssignedConsentModule

getExternProperties

public String getExternProperties()

get externProperties of assigned module

Returns:

externProperties of assigned module

setExternProperties

public AssignedConsentModule setExternProperties(String externProperties)

set externProperties of assigned module with 0-n properties separated by semicolon e.g. validity_period=p1y

Parameters:

externProperties - externProperties of assigned module

Returns:

instance of Assigend Module

getExpirationProperties

public String getExpirationProperties()

get expirationProperties of assigned module

Returns:

expirationProperties of assigned module

setExpirationProperties

public AssignedConsentModule setExpirationProperties(String expirationProperties)

set expirationProperties of assigned module

Parameters:

expirationProperties - expirationProperties of assigned module

Returns:

instance of Assigend Module

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class org.hl7.fhir.r4.model.Element

typedCopy

protected org.hl7.fhir.r4.model.Type typedCopy()

Specified by:

typedCopy in class org.hl7.fhir.r4.model.Type