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

Class ConsentTemplate

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

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 ConsentTemplate
extends org.hl7.fhir.r4.model.Type
implements org.hl7.fhir.instance.model.api.ICompositeType

FHIR Datatype to hold gICS-Template specific information

Author:

bialkem mosaic-greifswald.de

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ConsentTemplate.TemplateType	internal enumeration to differentiate types of consent templates internal use only

Field Summary

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

extension, id

Constructor Summary

Constructors

Constructor	Description
ConsentTemplate()	create new instance of ConsentTemplate, using default version "1.0"
ConsentTemplate(String domain, String name, String version)	create new instance of ConsentTemplate
ConsentTemplate(String domain, String name, String version, String label, String versionLabel)	create new instance of ConsentTemplate
ConsentTemplate(String domain, String name, String version, ConsentTemplate.TemplateType type)	create new instance of ConsentTemplate
ConsentTemplate(String domain, String name, String version, ConsentTemplate.TemplateType type, String label, String versionLabel)	create new instance of ConsentTemplate

Method Summary

Modifier and Type	Method	Description
ConsentTemplate	addAssignedModule(AssignedConsentModule module)	add new AssignedConsentModule to list of AssignedConsentModules and invoke update of internal fhir reference list
ConsentTemplate	addFreetext(ConsentTemplateFreeText freeItem)	add new ConsentTemplateFreeText to list of ConsentTemplateFreeTexts and invoke update of internal fhir reference list
boolean	equals(Object obj)
List<org.hl7.fhir.r4.model.Type>	getAssignedModules()	get current list of assigned Modules as ArrayList
String	getComment()	get comment to describe purpose of consent template
org.hl7.fhir.r4.model.Person	getContact()	get responsible contact for this consent template
Date	getCreationDate()	Return the creation date
String	getDomainName()	get Name of assigned consent domain
String	getExpirationProperties()	get expirationProperties of consent template
String	getExternProperties()	get externProperties of consent template
Boolean	getFinalized()	get consent template finalized status
String	getFooter()	get footer of consent template
List<org.hl7.fhir.r4.model.Type>	getFreetextDefs()	get current list of assigned FreeTextsDefinitions as ArrayList
String	getHeader()	get header of consent template
String	getLabel()	get Label of consent template
String	getName()	get Name of consent template
String	getTitle()	get title of consent template to be used as label etc.
ConsentTemplate.TemplateType	getType()	get type of consent template
String	getVersion()	get version of consent template
String	getVersionLabel()	get version label of consent template
int	hashCode()
boolean	isEmpty()
ConsentTemplate	removeAssignedModule(AssignedConsentModule module)	remove AssignedConsentModule from list of AssignedConsentModules and invoke update of internal fhir reference list
ConsentTemplate	removeFreetext(ConsentTemplateFreeText freeItem)	remove ConsentTemplateFreeText from list of ConsentTemplateFreeTexts and invoke update of internal fhir reference list
ConsentTemplate	setAssignedModules(List<org.hl7.fhir.r4.model.Type> listOfModules)	set list of AssignedConsentModule and update respective fhir list of references
ConsentTemplate	setComment(String templateComment)	set comment to describe purpose of consent template
ConsentTemplate	setContact(String familyName, String givenName, String telephone, String eMail, org.hl7.fhir.r4.model.Address address)	set responsible contact for this consent template
ConsentTemplate	setContact(org.hl7.fhir.r4.model.Person templateContact)	set responsible contact for this consent template
ConsentTemplate	setCreationDate(Date creationDate)	Set the creation date
ConsentTemplate	setDomainName(String templateDomainName)	set name of assigned consent domain
ConsentTemplate	setExpirationProperties(String expirationProperties)	set expirationProperties of consent template e.g. validity_period=p1y
ConsentTemplate	setExternProperties(String externProperties)	set externProperties of consent template with 0-n properties separated by semicolon e.g.
ConsentTemplate	setFinalized(Boolean finalstate)	set consent template finalized status
ConsentTemplate	setFooter(String templateFooter)	set footer of consent template to be used as label etc.
ConsentTemplate	setFreetextDefs(List<org.hl7.fhir.r4.model.Type> listOfFrees)	set list of ConsentTemplateFreeText and update respective fhir list of references
ConsentTemplate	setHeader(String templateHeader)	set header of consent template to be used as label etc.
ConsentTemplate	setLabel(String templateLabel)	set Label of consent template
ConsentTemplate	setName(String templateName)	set Name of consent template
ConsentTemplate	setTitle(String templateTitle)	set title of consent template to be used as label etc.
ConsentTemplate	setType(String templateType)	set type of consent template
ConsentTemplate	setType(ConsentTemplate.TemplateType templateType)	set type of consent template
ConsentTemplate	setVersion(String templateVersion)	set version of consent template
ConsentTemplate	setVersionLabel(String templateVersionLabel)	set version label of consent template
String	toKeyString()	get template Key as String separated with semicolon e.g.
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

ConsentTemplate

public ConsentTemplate(String domain,
 String name,
 String version)

create new instance of ConsentTemplate

Parameters:

domain -

name -

version -

ConsentTemplate

public ConsentTemplate(String domain,
 String name,
 String version,
 String label,
 String versionLabel)

create new instance of ConsentTemplate

Parameters:

domain -

name -

label -

version -

versionLabel -

ConsentTemplate

public ConsentTemplate(String domain,
 String name,
 String version,
 ConsentTemplate.TemplateType type)

create new instance of ConsentTemplate

Parameters:

domain -

name -

version -

type -

ConsentTemplate

public ConsentTemplate(String domain,
 String name,
 String version,
 ConsentTemplate.TemplateType type,
 String label,
 String versionLabel)

create new instance of ConsentTemplate

Parameters:

domain -

name -

version -

type -

label -

versionLabel -

ConsentTemplate

public ConsentTemplate()

create new instance of ConsentTemplate, using default version "1.0"

Method Details

getName

public String getName()

get Name of consent template

Returns:

Name of consent template

setName

public ConsentTemplate setName(String templateName)

set Name of consent template

Parameters:

templateName - Name of consent template

Returns:

instance of consent template

getFinalized

public Boolean getFinalized()

get consent template finalized status

Returns:

template finalized status

setFinalized

public ConsentTemplate setFinalized(Boolean finalstate)

set consent template finalized status

Parameters:

finalstate - finalized status domain finalized status

Returns:

instance of consent domain

getLabel

public String getLabel()

get Label of consent template

Returns:

Label of consent template

setLabel

public ConsentTemplate setLabel(String templateLabel)

set Label of consent template

Parameters:

templateLabel - Label of consent template

Returns:

instance of consent template

getVersionLabel

public String getVersionLabel()

get version label of consent template

Returns:

version label of consent template

setVersionLabel

public ConsentTemplate setVersionLabel(String templateVersionLabel)

set version label of consent template

Parameters:

templateVersionLabel - version Label of consent template

Returns:

instance of consent template

getDomainName

public String getDomainName()

get Name of assigned consent domain

Returns:

name of assigned consent domain

setDomainName

public ConsentTemplate setDomainName(String templateDomainName)

set name of assigned consent domain

Parameters:

templateDomainName - name of assigned consent domain

Returns:

instance of ConsentTemplate

getVersion

public String getVersion()

get version of consent template

Returns:

version of consent template

setVersion

public ConsentTemplate setVersion(String templateVersion)

set version of consent template

Parameters:

templateVersion - version of consent template

Returns:

instance of ConsentTemplate

getType

public ConsentTemplate.TemplateType getType()

get type of consent template

Returns:

type of consent template

setType

public ConsentTemplate setType(ConsentTemplate.TemplateType templateType)

set type of consent template

Parameters:

templateType - type of consent template

Returns:

instance of ConsentTemplate

setType

public ConsentTemplate setType(String templateType)

set type of consent template

Parameters:

templateType - string type of consent template

Returns:

instance of ConsentTemplate

getTitle

public String getTitle()

get title of consent template to be used as label etc.

Returns:

title of consent template

setTitle

public ConsentTemplate setTitle(String templateTitle)

set title of consent template to be used as label etc.

Parameters:

templateTitle - title of consent template to be used as label etc.

Returns:

instance of ConsentTemplate

getComment

public String getComment()

get comment to describe purpose of consent template

Returns:

comment to describe purpose of consent template

setComment

public ConsentTemplate setComment(String templateComment)

set comment to describe purpose of consent template

Parameters:

templateComment - comment to describe purpose of consent template

Returns:

instance of ConsentTemplate

getHeader

public String getHeader()

get header of consent template

Returns:

header of consent template

setHeader

public ConsentTemplate setHeader(String templateHeader)

set header of consent template to be used as label etc.

Parameters:

templateHeader - header of consent template

Returns:

instance of ConsentTemplate

getFooter

public String getFooter()

get footer of consent template

Returns:

footer of consent template

setFooter

public ConsentTemplate setFooter(String templateFooter)

set footer of consent template to be used as label etc.

Parameters:

templateFooter - footer of consent template

Returns:

instance of ConsentTemplate

getExpirationProperties

public String getExpirationProperties()

get expirationProperties of consent template

Returns:

expirationProperties of consent template

setExpirationProperties

public ConsentTemplate setExpirationProperties(String expirationProperties)

set expirationProperties of consent template e.g. validity_period=p1y

Parameters:

expirationProperties - expirationProperties of consent template

Returns:

instance of ConsentTemplate

getExternProperties

public String getExternProperties()

get externProperties of consent template

Returns:

externProperties of consent template

setExternProperties

public ConsentTemplate setExternProperties(String externProperties)

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

Parameters:

externProperties - externProperties of consent template

Returns:

instance of ConsentTemplate

getContact

public org.hl7.fhir.r4.model.Person getContact()

get responsible contact for this consent template

Returns:

responsible contact for this consent template

setContact

public ConsentTemplate setContact(org.hl7.fhir.r4.model.Person templateContact)

set responsible contact for this consent template

Parameters:

templateContact - responsible contact for this consent template

Returns:

instance of ConsentTemplate

setContact

public ConsentTemplate setContact(String familyName,
 String givenName,
 String telephone,
 String eMail,
 org.hl7.fhir.r4.model.Address address)

set responsible contact for this consent template

Parameters:

familyName -

givenName -

telephone -

eMail -

address - Address in FHIR format

Returns:

instance of ConsentTemplate

getFreetextDefs

public List<org.hl7.fhir.r4.model.Type> getFreetextDefs()

get current list of assigned FreeTextsDefinitions as ArrayList

Returns:

list of assigned FreeTextsDefinitions as ArrayList

setFreetextDefs

public ConsentTemplate setFreetextDefs(List<org.hl7.fhir.r4.model.Type> listOfFrees)

set list of ConsentTemplateFreeText and update respective fhir list of references

Parameters:

listOfFrees - list of ConsentTemplateFreeText for this consent template

Returns:

current instance of ConsentTemplate

addFreetext

public ConsentTemplate addFreetext(ConsentTemplateFreeText freeItem)

add new ConsentTemplateFreeText to list of ConsentTemplateFreeTexts and invoke update of internal fhir reference list

Parameters:

freeItem - ConsentTemplateFreeText item to be added

Returns:

current instance of ConsentTemplate

removeFreetext

public ConsentTemplate removeFreetext(ConsentTemplateFreeText freeItem)

remove ConsentTemplateFreeText from list of ConsentTemplateFreeTexts and invoke update of internal fhir reference list

Parameters:

freeItem - ConsentTemplateFreeText item to be removed

Returns:

current instance of ConsentTemplate

getAssignedModules

public List<org.hl7.fhir.r4.model.Type> getAssignedModules()

get current list of assigned Modules as ArrayList

Returns:

list of assigned modules as ArrayList

setAssignedModules

public ConsentTemplate setAssignedModules(List<org.hl7.fhir.r4.model.Type> listOfModules)

set list of AssignedConsentModule and update respective fhir list of references

Parameters:

listOfModules - list of AssignedConsentModule for this consent template

Returns:

current instance of ConsentTemplate

addAssignedModule

public ConsentTemplate addAssignedModule(AssignedConsentModule module)

add new AssignedConsentModule to list of AssignedConsentModules and invoke update of internal fhir reference list

Parameters:

module - AssignedConsentModule item to be added

Returns:

current instance of ConsentTemplate

removeAssignedModule

public ConsentTemplate removeAssignedModule(AssignedConsentModule module)

remove AssignedConsentModule from list of AssignedConsentModules and invoke update of internal fhir reference list

Parameters:

module - AssignedConsentModule item to be removed

Returns:

current instance of ConsentTemplate

getCreationDate

public Date getCreationDate()

Return the creation date

Returns:

the creation date

setCreationDate

public ConsentTemplate setCreationDate(Date creationDate)

Set the creation date

Parameters:

creationDate - the creation date

toKeyString

public String toKeyString()

get template Key as String separated with semicolon e.g. "domain;template name;template version"

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

typedCopy

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

Specified by:

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

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

toString

public String toString()

Overrides:

toString in class Object