Skip to main content

HS.FHIR.DTL.vR4.Model.Datatype.Signature

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

A Signature - XML DigSig, JWS, Graphical image of signature, etc.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
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 XMLPROJECTION = ELEMENT;
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.

Properties

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

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

Property methods: dataGet(), dataIsValid(), dataLogicalToXSD(), dataSet(), dataXSDToLogical()
property onBehalfOf as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "onBehalfOf", XMLPROJECTION = "ELEMENT");
Reference

The party represented.

Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization

Property methods: onBehalfOfGet(), onBehalfOfGetSwizzled(), onBehalfOfIsValid(), onBehalfOfNewObject(), onBehalfOfSet()
property sigFormat as %String (MAXLEN = 1000000, XMLNAME = "sigFormat", XMLPROJECTION = "ATTRIBUTE");
code

The technical format of the signature.

mimetypes|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend mimetypes|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: sigFormatDisplayToLogical(), sigFormatGet(), sigFormatIsValid(), sigFormatLogicalToDisplay(), sigFormatLogicalToOdbc(), sigFormatNormalize(), sigFormatSet()
property targetFormat as %String (MAXLEN = 1000000, XMLNAME = "targetFormat", XMLPROJECTION = "ATTRIBUTE");
code

The technical format of the signed resources.

mimetypes|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend mimetypes|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: targetFormatDisplayToLogical(), targetFormatGet(), targetFormatIsValid(), targetFormatLogicalToDisplay(), targetFormatLogicalToOdbc(), targetFormatNormalize(), targetFormatSet()
property type as list of HS.FHIR.DTL.vR4.Model.Datatype.Coding (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];
Coding

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

signature-type is the PREFERRED FHIR4 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 ];
instant

When the signature was created.

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

Who signed.

Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization

Property methods: whoGet(), whoGetSwizzled(), whoIsValid(), whoNewObject(), whoSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab