HS.FHIRModel.R4.Signature
class HS.FHIRModel.R4.Signature extends HS.FHIRModel.FHIRClassSuper
******************************************* Signature generated class schema
*****************************************
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.
Property Inventory
- _data
- _sigFormat
- _targetFormat
- _when
- data
- extension
- fhirID
- onBehalfOf
- sigFormat
- targetFormat
- type
- when
- who
Method Inventory
- IncludeExtension()
- IncludeOnBehalfOf()
- IncludeType()
- IncludeWho()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_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 HS.FHIRModel.R4.Element;
Extensions for data
Property methods: _dataGet(), _dataGetSwizzled(), _dataIsValid(), _dataNewObject(), _dataSet()
property _sigFormat as HS.FHIRModel.R4.Element;
Extensions for sigFormat
Property methods: _sigFormatGet(), _sigFormatGetSwizzled(), _sigFormatIsValid(), _sigFormatNewObject(), _sigFormatSet()
property _targetFormat as HS.FHIRModel.R4.Element;
Extensions for targetFormat
Property methods: _targetFormatGet(), _targetFormatGetSwizzled(), _targetFormatIsValid(), _targetFormatNewObject(), _targetFormatSet()
property _when as HS.FHIRModel.R4.Element;
Extensions for when
Property methods: _whenGet(), _whenGetSwizzled(), _whenIsValid(), _whenNewObject(), _whenSet()
property data as %String;
The base64 encoding of the Signature content. When signature is not
recorded electronically this element would be empty.
Property methods: dataDisplayToLogical(), dataGet(), dataIsValid(), dataLogicalToDisplay(), dataLogicalToOdbc(), dataNormalize(), dataSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the element. To make the use of extensions
safe and manageable, there is a strict set of governance applied
to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL
be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references).
This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property onBehalfOf as HS.FHIRModel.R4.Reference;
A reference to an application-usable description of the identity
that is represented by the signature.
Property methods: onBehalfOfGet(), onBehalfOfGetSwizzled(), onBehalfOfIsValid(), onBehalfOfNewObject(), onBehalfOfSet()
property sigFormat as %String;
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.
Property methods: sigFormatDisplayToLogical(), sigFormatGet(), sigFormatIsValid(), sigFormatLogicalToDisplay(), sigFormatLogicalToOdbc(), sigFormatNormalize(), sigFormatSet()
property targetFormat as %String;
A mime type that indicates the technical format of the target resources
signed by the signature.
Property methods: targetFormatDisplayToLogical(), targetFormatGet(), targetFormatIsValid(), targetFormatLogicalToDisplay(), targetFormatLogicalToOdbc(), targetFormatNormalize(), targetFormatSet()
property type as HS.FHIRModel.R4.SeqOfCoding [ Required ];
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.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property when as %String;
When the digital signature was signed.
Property methods: whenDisplayToLogical(), whenGet(), whenIsValid(), whenLogicalToDisplay(), whenLogicalToOdbc(), whenNormalize(), whenSet()
property who as HS.FHIRModel.R4.Reference [ Required ];
A reference to an application-usable description of the identity
that signed (e.g. the signature used their private key).
Property methods: whoGet(), whoGetSwizzled(), whoIsValid(), whoNewObject(), whoSet()
Methods
method IncludeExtension()
method IncludeOnBehalfOf()
method IncludeType()
method IncludeWho()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.Signature
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()