java.lang.Object
- org.hl7.fhir.dstu2.model.Base
- - org.hl7.fhir.dstu2.model.Element
  - - org.hl7.fhir.dstu2.model.Type
    - - org.hl7.fhir.dstu2.model.Signature

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 Signature
extends Type
implements org.hl7.fhir.instance.model.api.ICompositeType
```
A digital signature along with supporting context. The signature may be electronic/cryptographic in nature, or a graphical image representing a hand-written signature, or a signature process. Different Signature approaches have different utilities.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected Base64BinaryType`	`blob`	The base64 encoding of the Signature content.
`protected CodeType`	`contentType`	A mime type that indicates the technical format of the signature.
`protected List<Coding>`	`type`	An indication of the reason that the entity signed this document.
`protected InstantType`	`when`	When the digital signature was signed.
`protected Type`	`who`	A reference to an application-usable description of the person that signed the certificate (e.g.

Fields inherited from class org.hl7.fhir.dstu2.model.Element
extension, id

Constructor Summary

Constructors
Constructor Description

Signature()

Signature(InstantType when, Type who, CodeType contentType, Base64BinaryType blob)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Base`	`addChild(String name)`
`Coding`	`addType()`
`Signature`	`addType(Coding t)`
`Signature`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`byte[]`	`getBlob()`
`Base64BinaryType`	`getBlobElement()`
`String`	`getContentType()`
`CodeType`	`getContentTypeElement()`
`List<Coding>`	`getType()`
`Date`	`getWhen()`
`InstantType`	`getWhenElement()`
`Type`	`getWho()`
`Reference`	`getWhoReference()`
`UriType`	`getWhoUriType()`
`boolean`	`hasBlob()`
`boolean`	`hasBlobElement()`
`boolean`	`hasContentType()`
`boolean`	`hasContentTypeElement()`
`boolean`	`hasType()`
`boolean`	`hasWhen()`
`boolean`	`hasWhenElement()`
`boolean`	`hasWho()`
`boolean`	`hasWhoReference()`
`boolean`	`hasWhoUriType()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Signature`	`setBlob(byte[] value)`
`Signature`	`setBlobElement(Base64BinaryType value)`
`Signature`	`setContentType(String value)`
`Signature`	`setContentTypeElement(CodeType value)`
`void`	`setProperty(String name, Base value)`
`Signature`	`setWhen(Date value)`
`Signature`	`setWhenElement(InstantType value)`
`Signature`	`setWho(Type value)`
`protected Signature`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu2.model.Element
addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement

Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

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

- Field Detail
  - type
```
protected List<Coding> type
```
    An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.
  - when
```
protected InstantType when
```
    When the digital signature was signed.
  - who
```
protected Type who
```
    A reference to an application-usable description of the person that signed the certificate (e.g. the signature used their private key).
  - contentType
```
protected CodeType contentType
```
    A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jwt for JWT, and image/* for a graphical image of a signature.
  - blob
```
protected Base64BinaryType blob
```
    The base64 encoding of the Signature content.
- Constructor Detail
  - Signature
```
public Signature()
```
  - Signature
```
public Signature(InstantType when,
                 Type who,
                 CodeType contentType,
                 Base64BinaryType blob)
```
- Method Detail
  - getType
```
public List<Coding> getType()
```
    Returns:
    
    type (An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.)
  - hasType
```
public boolean hasType()
```
  - addType
```
public Coding addType()
```
    Returns:
    
    type (An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.)
  - addType
```
public Signature addType(Coding t)
```
  - getWhenElement
```
public InstantType getWhenElement()
```
    Returns:
    
    when (When the digital signature was signed.). This is the underlying object with id, value and extensions. The accessor "getWhen" gives direct access to the value
  - hasWhenElement
```
public boolean hasWhenElement()
```
  - hasWhen
```
public boolean hasWhen()
```
  - setWhenElement
```
public Signature setWhenElement(InstantType value)
```
    Parameters:
    
    value - when (When the digital signature was signed.). This is the underlying object with id, value and extensions. The accessor "getWhen" gives direct access to the value
  - getWhen
```
public Date getWhen()
```
    Returns:
    
    When the digital signature was signed.
  - setWhen
```
public Signature setWhen(Date value)
```
    Parameters:
    
    value - When the digital signature was signed.
  - getWho
```
public Type getWho()
```
    Returns:
    
    who (A reference to an application-usable description of the person that signed the certificate (e.g. the signature used their private key).)
  - getWhoUriType
```
public UriType getWhoUriType()
                      throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    who (A reference to an application-usable description of the person that signed the certificate (e.g. the signature used their private key).)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasWhoUriType
```
public boolean hasWhoUriType()
```
  - getWhoReference
```
public Reference getWhoReference()
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    who (A reference to an application-usable description of the person that signed the certificate (e.g. the signature used their private key).)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasWhoReference
```
public boolean hasWhoReference()
```
  - hasWho
```
public boolean hasWho()
```
  - setWho
```
public Signature setWho(Type value)
```
    Parameters:
    
    value - who (A reference to an application-usable description of the person that signed the certificate (e.g. the signature used their private key).)
  - getContentTypeElement
```
public CodeType getContentTypeElement()
```
    Returns:
    
    contentType (A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jwt for JWT, and image/* for a graphical image of a signature.). This is the underlying object with id, value and extensions. The accessor "getContentType" gives direct access to the value
  - hasContentTypeElement
```
public boolean hasContentTypeElement()
```
  - hasContentType
```
public boolean hasContentType()
```
  - setContentTypeElement
```
public Signature setContentTypeElement(CodeType value)
```
    Parameters:
    
    value - contentType (A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jwt for JWT, and image/* for a graphical image of a signature.). This is the underlying object with id, value and extensions. The accessor "getContentType" gives direct access to the value
  - getContentType
```
public String getContentType()
```
    Returns:
    
    A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jwt for JWT, and image/* for a graphical image of a signature.
  - setContentType
```
public Signature setContentType(String value)
```
    Parameters:
    
    value - A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jwt for JWT, and image/* for a graphical image of a signature.
  - getBlobElement
```
public Base64BinaryType getBlobElement()
```
    Returns:
    
    blob (The base64 encoding of the Signature content.). This is the underlying object with id, value and extensions. The accessor "getBlob" gives direct access to the value
  - hasBlobElement
```
public boolean hasBlobElement()
```
  - hasBlob
```
public boolean hasBlob()
```
  - setBlobElement
```
public Signature setBlobElement(Base64BinaryType value)
```
    Parameters:
    
    value - blob (The base64 encoding of the Signature content.). This is the underlying object with id, value and extensions. The accessor "getBlob" gives direct access to the value
  - getBlob
```
public byte[] getBlob()
```
    Returns:
    
    The base64 encoding of the Signature content.
  - setBlob
```
public Signature setBlob(byte[] value)
```
    Parameters:
    
    value - The base64 encoding of the Signature content.
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class Element
  - setProperty
```
public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class Element
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class Element
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class Element
  - copy
```
public Signature copy()
```
    Overrides:
    
    copy in class Type
  - typedCopy
```
protected Signature typedCopy()
```
    Specified by:
    
    typedCopy in class Type
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class Element
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class Element
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class Element

Constructor	Description
`Signature()`
`Signature(InstantType when, Type who, CodeType contentType, Base64BinaryType blob)`

Class Signature

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

Field Detail

type

when

who

contentType

blob

Constructor Detail

Signature

Signature

Method Detail

getType

hasType

addType

addType

getWhenElement

hasWhenElement

hasWhen

setWhenElement

getWhen

setWhen

getWho

getWhoUriType

hasWhoUriType

getWhoReference

hasWhoReference

hasWho

setWho

getContentTypeElement

hasContentTypeElement

hasContentType

setContentTypeElement

getContentType

setContentType

getBlobElement

hasBlobElement

hasBlob

setBlobElement

getBlob

setBlob

listChildren

setProperty

addChild

fhirType

copy

typedCopy

equalsDeep

equalsShallow

isEmpty