Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%Standards.AU.eHealth.HI.SignatureContainerType

class %Standards.AU.eHealth.HI.SignatureContainerType extends %SOAP.Header

This SOAP header is defined as part of Medicare Australia (Federal Agency) Healthcare Identifiers (HI) Service in document Healthcare Identifiers (HI) Service, System Interface Specification (SIS), B2B Common Functionality Document, TECH.SIS.HI.01
The class name is derived from the type definition in CommonCoreElements.xsd.
The SOAP header element name is "signature".
See %Standards.AU.eHealth.HI.Headers class for adding and validating headers.

Property Inventory

Method Inventory

Parameters

parameter NAMESPACE = http://ns.electronichealth.net.au/hi/xsd/common/CommonCoreElements/3.0;
Inherited description: NAMESPACE specifies the XML namespace to be used when projecting the class to XML. if NAMESPACE - "", the default namespace is used for the XML schema is used as the namespace for his class.
parameter XMLFORMAT = literal;
Inherited description: The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport methods for XML enabled classes to include code for only literal or only encoded format. This allows the generated routines to be significantly smaller since usually both formats are not needed.
If XMLFORMAT="Literal", then only support for literal format import and export is generated.
If XMLFORMAT="Encoded", then only support for SOAP encoded format import and export is generated.
The default is to generate support for both literal and encoded format.
parameter XMLNAME = signature;
The header element name and key name for HeadersIn and HeadersOut arrays.
parameter XMLPREFIX = cce;
Inherited description: The XMLPREFIX parameter controls the prefix to be used for the XML namespace that is given by the NAMESPACE parameter.

Properties

property Signature as %XML.Security.Signature (REFNAMESPACE = "http://www.w3.org/2000/09/xmldsig#", XMLPROJECTION = "element", XMLREF = 1) [ Required ];
Property methods: SignatureGet(), SignatureGetSwizzled(), SignatureIsValid(), SignatureNewObject(), SignatureSet()

Methods

classmethod Create(service As %SOAP.WebBase, credentials As %SYS.X509Credentials)
Create a signature header and sign user header, timestamp header and Body. Create signature interface:
  • The service argument is required and is the web client or service for which to add the headers.
  • The credentials argument is the X.509 credentials object used for signing. See %SYS.X509Credentials class documentation for details.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab