Signature (HAPI FHIR Structures - FHIR R4 3.5.0 API)

java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.Element
  - - org.hl7.fhir.r4.model.Type
    - - org.hl7.fhir.r4.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 signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Base64BinaryType`	`blob` The base64 encoding of the Signature content.
`protected Type`	`onBehalfOf` A reference to an application-usable description of the identity that is represented by the signature.
`protected CodeType`	`sigFormat` A mime type that indicates the technical format of the signature.
`protected CodeType`	`targetFormat` A mime type that indicates the technical format of the target resources signed by 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 identity that signed (e.g.

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

Constructor Summary

Constructors
Constructor and Description

Signature()
Constructor

Signature(InstantType when, Type who)
Constructor

Constructors
Constructor and Description
`Signature()` Constructor
`Signature(InstantType when, Type who)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`Type`	`getOnBehalfOf()`
`Reference`	`getOnBehalfOfReference()`
`UriType`	`getOnBehalfOfUriType()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`String`	`getSigFormat()`
`CodeType`	`getSigFormatElement()`
`String`	`getTargetFormat()`
`CodeType`	`getTargetFormatElement()`
`List<Coding>`	`getType()`
`Coding`	`getTypeFirstRep()`
`String[]`	`getTypesForProperty(int hash, String name)`
`Date`	`getWhen()`
`InstantType`	`getWhenElement()`
`Type`	`getWho()`
`Reference`	`getWhoReference()`
`UriType`	`getWhoUriType()`
`boolean`	`hasBlob()`
`boolean`	`hasBlobElement()`
`boolean`	`hasOnBehalfOf()`
`boolean`	`hasOnBehalfOfReference()`
`boolean`	`hasOnBehalfOfUriType()`
`boolean`	`hasSigFormat()`
`boolean`	`hasSigFormatElement()`
`boolean`	`hasTargetFormat()`
`boolean`	`hasTargetFormatElement()`
`boolean`	`hasType()`
`boolean`	`hasWhen()`
`boolean`	`hasWhenElement()`
`boolean`	`hasWho()`
`boolean`	`hasWhoReference()`
`boolean`	`hasWhoUriType()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`Signature`	`setBlob(byte[] value)`
`Signature`	`setBlobElement(Base64BinaryType value)`
`Signature`	`setOnBehalfOf(Type value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Signature`	`setSigFormat(String value)`
`Signature`	`setSigFormatElement(CodeType value)`
`Signature`	`setTargetFormat(String value)`
`Signature`	`setTargetFormatElement(CodeType value)`
`Signature`	`setType(List<Coding> theType)`
`Signature`	`setWhen(Date value)`
`Signature`	`setWhenElement(InstantType value)`
`Signature`	`setWho(Type value)`
`protected Signature`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

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, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, 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, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, isResource, listChildrenByName, 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, hasFormatComment

- 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 identity that signed (e.g. the signature used their private key).
  - onBehalfOf
```
protected Type onBehalfOf
```
    A reference to an application-usable description of the identity that is represented by the signature.
  - targetFormat
```
protected CodeType targetFormat
```
    A mime type that indicates the technical format of the target resources signed by the signature.
  - sigFormat
```
protected CodeType sigFormat
```
    A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.
  - blob
```
protected Base64BinaryType blob
```
    The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.
- Constructor Detail
  - Signature
```
public Signature()
```
    Constructor
  - Signature
```
public Signature(InstantType when,
                 Type who)
```
    Constructor
- 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.)
  - setType
```
public Signature setType(List<Coding> theType)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasType
```
public boolean hasType()
```
  - addType
```
public Coding addType()
```
  - addType
```
public Signature addType(Coding t)
```
  - getTypeFirstRep
```
public Coding getTypeFirstRep()
```
    Returns:
    
    The first repetition of repeating field type, creating it if it does not already exist
  - 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 identity that signed (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 identity that signed (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 identity that signed (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 identity that signed (e.g. the signature used their private key).)
  - getOnBehalfOf
```
public Type getOnBehalfOf()
```
    Returns:
    
    onBehalfOf (A reference to an application-usable description of the identity that is represented by the signature.)
  - getOnBehalfOfUriType
```
public UriType getOnBehalfOfUriType()
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    onBehalfOf (A reference to an application-usable description of the identity that is represented by the signature.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasOnBehalfOfUriType
```
public boolean hasOnBehalfOfUriType()
```
  - getOnBehalfOfReference
```
public Reference getOnBehalfOfReference()
                                 throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    onBehalfOf (A reference to an application-usable description of the identity that is represented by the signature.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasOnBehalfOfReference
```
public boolean hasOnBehalfOfReference()
```
  - hasOnBehalfOf
```
public boolean hasOnBehalfOf()
```
  - setOnBehalfOf
```
public Signature setOnBehalfOf(Type value)
```
    Parameters:
    
    value - onBehalfOf (A reference to an application-usable description of the identity that is represented by the signature.)
  - getTargetFormatElement
```
public CodeType getTargetFormatElement()
```
    Returns:
    
    targetFormat (A mime type that indicates the technical format of the target resources signed by the signature.). This is the underlying object with id, value and extensions. The accessor "getTargetFormat" gives direct access to the value
  - hasTargetFormatElement
```
public boolean hasTargetFormatElement()
```
  - hasTargetFormat
```
public boolean hasTargetFormat()
```
  - setTargetFormatElement
```
public Signature setTargetFormatElement(CodeType value)
```
    Parameters:
    
    value - targetFormat (A mime type that indicates the technical format of the target resources signed by the signature.). This is the underlying object with id, value and extensions. The accessor "getTargetFormat" gives direct access to the value
  - getTargetFormat
```
public String getTargetFormat()
```
    Returns:
    
    A mime type that indicates the technical format of the target resources signed by the signature.
  - setTargetFormat
```
public Signature setTargetFormat(String value)
```
    Parameters:
    
    value - A mime type that indicates the technical format of the target resources signed by the signature.
  - getSigFormatElement
```
public CodeType getSigFormatElement()
```
    Returns:
    
    sigFormat (A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.). This is the underlying object with id, value and extensions. The accessor "getSigFormat" gives direct access to the value
  - hasSigFormatElement
```
public boolean hasSigFormatElement()
```
  - hasSigFormat
```
public boolean hasSigFormat()
```
  - setSigFormatElement
```
public Signature setSigFormatElement(CodeType value)
```
    Parameters:
    
    value - sigFormat (A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.). This is the underlying object with id, value and extensions. The accessor "getSigFormat" gives direct access to the value
  - getSigFormat
```
public String getSigFormat()
```
    Returns:
    
    A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.
  - setSigFormat
```
public Signature setSigFormat(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/jose for JWS, and image/* for a graphical image of a signature, etc.
  - getBlobElement
```
public Base64BinaryType getBlobElement()
```
    Returns:
    
    blob (The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.). 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. When signature is not recorded electronically this element would be empty.). 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. When signature is not recorded electronically this element would be empty.
  - setBlob
```
public Signature setBlob(byte[] value)
```
    Parameters:
    
    value - The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class Element
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class Element
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class Element
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class Element
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class Element
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class Element
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty 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()
```
    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

Class Signature

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Field Detail

type

when

who

onBehalfOf

targetFormat

sigFormat

blob

Constructor Detail

Signature

Signature

Method Detail

getType

setType

hasType

addType

addType

getTypeFirstRep

getWhenElement

hasWhenElement

hasWhen

setWhenElement

getWhen

setWhen

getWho

getWhoUriType

hasWhoUriType

getWhoReference

hasWhoReference

hasWho

setWho

getOnBehalfOf

getOnBehalfOfUriType

hasOnBehalfOfUriType

getOnBehalfOfReference

hasOnBehalfOfReference

hasOnBehalfOf

setOnBehalfOf

getTargetFormatElement

hasTargetFormatElement

hasTargetFormat

setTargetFormatElement

getTargetFormat

setTargetFormat

getSigFormatElement

hasSigFormatElement

hasSigFormat

setSigFormatElement

getSigFormat

setSigFormat

getBlobElement

hasBlobElement

hasBlob

setBlobElement

getBlob

setBlob

listChildren

getNamedProperty

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty

addChild

fhirType

copy

typedCopy

equalsDeep

equalsShallow

isEmpty