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

Klasse 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

Alle implementierten Schnittstellen:

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

Autor:

bialkem mosaic-greifswald.de

Siehe auch:

• Serialisierte Form

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static enum	ConsentTemplate.TemplateType	internal enumeration to differentiate types of consent templates

Feldübersicht

Von Klasse geerbte Felder org.hl7.fhir.r4.model.Element

extension, id

Konstruktorübersicht

Konstruktoren

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

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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	getValidFromProperties()	get validFromProperties 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	setValidFromProperties(String validFromProperties)	set validFromProperties of consent template e.g. validity_period=p1y
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()

Von Klasse geerbte Methoden org.hl7.fhir.r4.model.Type

copy

Von Klasse geerbte Methoden 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

Von Klasse geerbte Methoden 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, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden org.hl7.fhir.instance.model.api.IBase

fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Von Schnittstelle geerbte Methoden org.hl7.fhir.instance.model.api.IBaseElement

getUserData, setUserData

Konstruktordetails

ConsentTemplate

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

ConsentTemplate

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

ConsentTemplate

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

ConsentTemplate

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

ConsentTemplate

public ConsentTemplate()

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

Methodendetails

getName

public String getName()

get Name of consent template

Gibt zurück:

Name of consent template

setName

public ConsentTemplate setName(String templateName)

set Name of consent template

Parameter:

templateName - Name of consent template

Gibt zurück:

instance of consent template

getFinalized

public Boolean getFinalized()

get consent template finalized status

Gibt zurück:

template finalized status

setFinalized

public ConsentTemplate setFinalized(Boolean finalstate)

set consent template finalized status

Parameter:

finalstate - finalized status domain finalized status

Gibt zurück:

instance of consent domain

getLabel

public String getLabel()

get Label of consent template

Gibt zurück:

Label of consent template

setLabel

public ConsentTemplate setLabel(String templateLabel)

set Label of consent template

Parameter:

templateLabel - Label of consent template

Gibt zurück:

instance of consent template

getVersionLabel

public String getVersionLabel()

get version label of consent template

Gibt zurück:

version label of consent template

setVersionLabel

public ConsentTemplate setVersionLabel(String templateVersionLabel)

set version label of consent template

Parameter:

templateVersionLabel - version Label of consent template

Gibt zurück:

instance of consent template

getDomainName

public String getDomainName()

get Name of assigned consent domain

Gibt zurück:

name of assigned consent domain

setDomainName

public ConsentTemplate setDomainName(String templateDomainName)

set name of assigned consent domain

Parameter:

templateDomainName - name of assigned consent domain

Gibt zurück:

instance of ConsentTemplate

getVersion

public String getVersion()

get version of consent template

Gibt zurück:

version of consent template

setVersion

public ConsentTemplate setVersion(String templateVersion)

set version of consent template

Parameter:

templateVersion - version of consent template

Gibt zurück:

instance of ConsentTemplate

getType

public ConsentTemplate.TemplateType getType()

get type of consent template

Gibt zurück:

type of consent template

setType

public ConsentTemplate setType(ConsentTemplate.TemplateType templateType)

set type of consent template

Parameter:

templateType - type of consent template

Gibt zurück:

instance of ConsentTemplate

setType

public ConsentTemplate setType(String templateType)

set type of consent template

Parameter:

templateType - string type of consent template

Gibt zurück:

instance of ConsentTemplate

getTitle

public String getTitle()

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

Gibt zurück:

title of consent template

setTitle

public ConsentTemplate setTitle(String templateTitle)

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

Parameter:

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

Gibt zurück:

instance of ConsentTemplate

getComment

public String getComment()

get comment to describe purpose of consent template

Gibt zurück:

comment to describe purpose of consent template

setComment

public ConsentTemplate setComment(String templateComment)

set comment to describe purpose of consent template

Parameter:

templateComment - comment to describe purpose of consent template

Gibt zurück:

instance of ConsentTemplate

getHeader

public String getHeader()

get header of consent template

Gibt zurück:

header of consent template

setHeader

public ConsentTemplate setHeader(String templateHeader)

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

Parameter:

templateHeader - header of consent template

Gibt zurück:

instance of ConsentTemplate

getFooter

public String getFooter()

get footer of consent template

Gibt zurück:

footer of consent template

setFooter

public ConsentTemplate setFooter(String templateFooter)

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

Parameter:

templateFooter - footer of consent template

Gibt zurück:

instance of ConsentTemplate

getExpirationProperties

public String getExpirationProperties()

get expirationProperties of consent template

Gibt zurück:

expirationProperties of consent template

setExpirationProperties

public ConsentTemplate setExpirationProperties(String expirationProperties)

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

Parameter:

expirationProperties - expirationProperties of consent template

Gibt zurück:

instance of ConsentTemplate

getExternProperties

public String getExternProperties()

get externProperties of consent template

Gibt zurück:

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

Parameter:

externProperties - externProperties of consent template

Gibt zurück:

instance of ConsentTemplate

getContact

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

get responsible contact for this consent template

Gibt zurück:

responsible contact for this consent template

setContact

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

set responsible contact for this consent template

Parameter:

templateContact - responsible contact for this consent template

Gibt zurück:

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

Parameter:

familyName -

givenName -

telephone -

eMail -

address - Address in FHIR format

Gibt zurück:

instance of ConsentTemplate

getFreetextDefs

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

get current list of assigned FreeTextsDefinitions as ArrayList

Gibt zurück:

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

Parameter:

listOfFrees - list of ConsentTemplateFreeText for this consent template

Gibt zurück:

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

Parameter:

freeItem - ConsentTemplateFreeText item to be added

Gibt zurück:

current instance of ConsentTemplate

removeFreetext

public ConsentTemplate removeFreetext(ConsentTemplateFreeText freeItem)

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

Parameter:

freeItem - ConsentTemplateFreeText item to be removed

Gibt zurück:

current instance of ConsentTemplate

getAssignedModules

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

get current list of assigned Modules as ArrayList

Gibt zurück:

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

Parameter:

listOfModules - list of AssignedConsentModule for this consent template

Gibt zurück:

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

Parameter:

module - AssignedConsentModule item to be added

Gibt zurück:

current instance of ConsentTemplate

removeAssignedModule

public ConsentTemplate removeAssignedModule(AssignedConsentModule module)

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

Parameter:

module - AssignedConsentModule item to be removed

Gibt zurück:

current instance of ConsentTemplate

getCreationDate

public Date getCreationDate()

Return the creation date

Gibt zurück:

the creation date

setCreationDate

public ConsentTemplate setCreationDate(Date creationDate)

Set the creation date

Parameter:

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()

Setzt außer Kraft:

hashCode in Klasse Object

equals

public boolean equals(Object obj)

Setzt außer Kraft:

equals in Klasse Object

typedCopy

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

Angegeben von:

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

isEmpty

public boolean isEmpty()

Angegeben von:

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

Setzt außer Kraft:

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

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object

getValidFromProperties

public String getValidFromProperties()

get validFromProperties of consent template

Gibt zurück:

validFromProperties of consent template

setValidFromProperties

public ConsentTemplate setValidFromProperties(String validFromProperties)

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

Parameter:

validFromProperties - validFromProperties of consent template

Gibt zurück:

instance of ConsentTemplate