Skip to main content


class HS.FHIR.DTL.vSTU3.Model.Datatype.Signature extends HS.FHIR.DTL.vSTU3.Model.Base.Element

A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWT), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process.

Property Inventory


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = Signature;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = Signature;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property blob as %Binary (XMLNAME = "blob", XMLPROJECTION = "ATTRIBUTE");

The actual signature content (XML DigSig. JWT, picture, etc.)

Property methods: blobGet(), blobIsValid(), blobLogicalToXSD(), blobSet(), blobXSDToLogical()
property contentType as %String (MAXLEN = 1000000, XMLNAME = "contentType", XMLPROJECTION = "ATTRIBUTE");

The technical format of the signature.

MimeType RFC 4289 is the REQUIRED IETF specification for the FHIR3 code values that may be used.

Property methods: contentTypeDisplayToLogical(), contentTypeGet(), contentTypeIsValid(), contentTypeLogicalToDisplay(), contentTypeLogicalToOdbc(), contentTypeNormalize(), contentTypeSet()
property onBehalfOfReference as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "onBehalfOfReference", XMLPROJECTION = "ELEMENT");

The party represented.

Practitioner | RelatedPerson | Patient | Device | Organization

Property methods: onBehalfOfReferenceGet(), onBehalfOfReferenceGetSwizzled(), onBehalfOfReferenceIsValid(), onBehalfOfReferenceNewObject(), onBehalfOfReferenceSet()
property onBehalfOfUri as %String (MAXLEN = 1000000, XMLNAME = "onBehalfOfUri", XMLPROJECTION = "ATTRIBUTE");

The party represented.

Property methods: onBehalfOfUriDisplayToLogical(), onBehalfOfUriGet(), onBehalfOfUriIsValid(), onBehalfOfUriLogicalToDisplay(), onBehalfOfUriLogicalToOdbc(), onBehalfOfUriNormalize(), onBehalfOfUriSet()
property type as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Coding (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];

Indication of the reason the entity signed the object(s)

signature-type is the PREFERRED FHIR3 ValueSet for codes, but if you need to express meanings not found in signature-type, you may use codes from any ValueSet.

Property methods: typeBuildValueArray(), typeCollectionToDisplay(), typeCollectionToOdbc(), typeDisplayToCollection(), typeGet(), typeGetObject(), typeGetObjectId(), typeGetSwizzled(), typeIsValid(), typeOdbcToCollection(), typeSet(), typeSetObject(), typeSetObjectId()
property when as %String (MAXLEN = 1000000, XMLNAME = "when", XMLPROJECTION = "ATTRIBUTE") [ Required ];

When the signature was created.

Property methods: whenDisplayToLogical(), whenGet(), whenIsValid(), whenLogicalToDisplay(), whenLogicalToOdbc(), whenNormalize(), whenSet()
property whoReference as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "whoReference", XMLPROJECTION = "ELEMENT") [ Required ];

Who signed.

Practitioner | RelatedPerson | Patient | Device | Organization

Property methods: whoReferenceGet(), whoReferenceGetSwizzled(), whoReferenceIsValid(), whoReferenceNewObject(), whoReferenceSet()
property whoUri as %String (MAXLEN = 1000000, XMLNAME = "whoUri", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Who signed.

Property methods: whoUriDisplayToLogical(), whoUriGet(), whoUriIsValid(), whoUriLogicalToDisplay(), whoUriLogicalToOdbc(), whoUriNormalize(), whoUriSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab