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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
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
ConstructorDescriptioncreate new instance of ConsentTemplate, using default version "1.0"ConsentTemplate
(String domain, String name, String version) create new instance of ConsentTemplatecreate new instance of ConsentTemplateConsentTemplate
(String domain, String name, String version, ConsentTemplate.TemplateType type) create new instance of ConsentTemplateConsentTemplate
(String domain, String name, String version, ConsentTemplate.TemplateType type, String label, String versionLabel) create new instance of ConsentTemplate -
Method Summary
Modifier and TypeMethodDescriptionadd new AssignedConsentModule to list of AssignedConsentModules and invoke update of internal fhir reference listaddFreetext
(ConsentTemplateFreeText freeItem) add new ConsentTemplateFreeText to list of ConsentTemplateFreeTexts and invoke update of internal fhir reference listboolean
List<org.hl7.fhir.r4.model.Type>
get current list of assigned Modules as ArrayListget comment to describe purpose of consent templateorg.hl7.fhir.r4.model.Person
get responsible contact for this consent templateReturn the creation dateget Name of assigned consent domainget expirationProperties of consent templateget externProperties of consent templateget consent template finalized statusget footer of consent templateList<org.hl7.fhir.r4.model.Type>
get current list of assigned FreeTextsDefinitions as ArrayListget header of consent templategetLabel()
get Label of consent templategetName()
get Name of consent templategetTitle()
get title of consent template to be used as label etc.getType()
get type of consent templateget version of consent templateget version label of consent templateint
hashCode()
boolean
isEmpty()
remove AssignedConsentModule from list of AssignedConsentModules and invoke update of internal fhir reference listremoveFreetext
(ConsentTemplateFreeText freeItem) remove ConsentTemplateFreeText from list of ConsentTemplateFreeTexts and invoke update of internal fhir reference listsetAssignedModules
(List<org.hl7.fhir.r4.model.Type> listOfModules) set list of AssignedConsentModule and update respective fhir list of referencessetComment
(String templateComment) set comment to describe purpose of consent templatesetContact
(String familyName, String givenName, String telephone, String eMail, org.hl7.fhir.r4.model.Address address) set responsible contact for this consent templatesetContact
(org.hl7.fhir.r4.model.Person templateContact) set responsible contact for this consent templatesetCreationDate
(Date creationDate) Set the creation datesetDomainName
(String templateDomainName) set name of assigned consent domainsetExpirationProperties
(String expirationProperties) set expirationProperties of consent template e.g. validity_period=p1ysetExternProperties
(String externProperties) set externProperties of consent template with 0-n properties separated by semicolon e.g.setFinalized
(Boolean finalstate) set consent template finalized statusset footer of consent template to be used as label etc.setFreetextDefs
(List<org.hl7.fhir.r4.model.Type> listOfFrees) set list of ConsentTemplateFreeText and update respective fhir list of referencesset header of consent template to be used as label etc.set Label of consent templateset Name of consent templateset title of consent template to be used as label etc.set type of consent templatesetType
(ConsentTemplate.TemplateType templateType) set type of consent templatesetVersion
(String templateVersion) set version of consent templatesetVersionLabel
(String templateVersionLabel) set version label of consent templateget template Key as String separated with semicolon e.g.toString()
protected org.hl7.fhir.r4.model.Type
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
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
get Name of consent template- Returns:
- Name of consent template
-
setName
set Name of consent template- Parameters:
templateName
- Name of consent template- Returns:
- instance of consent template
-
getFinalized
get consent template finalized status- Returns:
- template finalized status
-
setFinalized
set consent template finalized status- Parameters:
finalstate
- finalized status domain finalized status- Returns:
- instance of consent domain
-
getLabel
get Label of consent template- Returns:
- Label of consent template
-
setLabel
set Label of consent template- Parameters:
templateLabel
- Label of consent template- Returns:
- instance of consent template
-
getVersionLabel
get version label of consent template- Returns:
- version label of consent template
-
setVersionLabel
set version label of consent template- Parameters:
templateVersionLabel
- version Label of consent template- Returns:
- instance of consent template
-
getDomainName
get Name of assigned consent domain- Returns:
- name of assigned consent domain
-
setDomainName
set name of assigned consent domain- Parameters:
templateDomainName
- name of assigned consent domain- Returns:
- instance of ConsentTemplate
-
getVersion
get version of consent template- Returns:
- version of consent template
-
setVersion
set version of consent template- Parameters:
templateVersion
- version of consent template- Returns:
- instance of ConsentTemplate
-
getType
get type of consent template- Returns:
- type of consent template
-
setType
set type of consent template- Parameters:
templateType
- type of consent template- Returns:
- instance of ConsentTemplate
-
setType
set type of consent template- Parameters:
templateType
- string type of consent template- Returns:
- instance of ConsentTemplate
-
getTitle
get title of consent template to be used as label etc.- Returns:
- title of consent template
-
setTitle
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
get comment to describe purpose of consent template- Returns:
- comment to describe purpose of consent template
-
setComment
set comment to describe purpose of consent template- Parameters:
templateComment
- comment to describe purpose of consent template- Returns:
- instance of ConsentTemplate
-
getHeader
get header of consent template- Returns:
- header of consent template
-
setHeader
set header of consent template to be used as label etc.- Parameters:
templateHeader
- header of consent template- Returns:
- instance of ConsentTemplate
-
getExpirationProperties
get expirationProperties of consent template- Returns:
- expirationProperties of consent template
-
setExpirationProperties
set expirationProperties of consent template e.g. validity_period=p1y- Parameters:
expirationProperties
- expirationProperties of consent template- Returns:
- instance of ConsentTemplate
-
getExternProperties
get externProperties of consent template- Returns:
- externProperties of consent template
-
setExternProperties
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
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
get current list of assigned FreeTextsDefinitions as ArrayList- Returns:
- list of assigned FreeTextsDefinitions as ArrayList
-
setFreetextDefs
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
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
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
get current list of assigned Modules as ArrayList- Returns:
- list of assigned modules as ArrayList
-
setAssignedModules
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
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
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
Return the creation date- Returns:
- the creation date
-
setCreationDate
Set the creation date- Parameters:
creationDate
- the creation date
-
toKeyString
get template Key as String separated with semicolon e.g. "domain;template name;template version" -
hashCode
public int hashCode() -
equals
-
typedCopy
protected org.hl7.fhir.r4.model.Type typedCopy()- Specified by:
typedCopy
in classorg.hl7.fhir.r4.model.Type
-
isEmpty
public boolean isEmpty()- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classorg.hl7.fhir.r4.model.Element
-
toString
-