This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %Standards.AU.eHealth.HI.Headers

%Standards.AU.eHealth.HI.Headers

class %Standards.AU.eHealth.HI.Headers extends %Library.RegisteredObject

%Standards.AU.eHealth.HI.Headers supports adding, signing and validating headers that are 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

See AddRequestHeaders and AddResponseHeaders for details of how to add and sign headers.
See ValidateHeaders for details of how to validate headers.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property product as %Standards.AU.eHealth.HI.ProductType;
product SOAP header is to be supplied by caller for creating request and response. product SOAP header will reference header after validating.
Property methods: productGet(), productGetSwizzled(), productIsValid(), productNewObject(), productSet()
property signature as %Standards.AU.eHealth.HI.SignatureContainerType;
signature SOAP header will be created for request and response and will sign other headers. signature SOAP header will reference header after validating received request or response.
Property methods: signatureGet(), signatureGetSwizzled(), signatureIsValid(), signatureNewObject(), signatureSet()
property timestamp as %Standards.AU.eHealth.HI.TimestampType;
timestamp SOAP header will be created request. timestamp SOAP header will reference header after validating received request.
Property methods: timestampGet(), timestampGetSwizzled(), timestampIsValid(), timestampNewObject(), timestampSet()
property user as %Standards.AU.eHealth.HI.UserType;
user SOAP header is to be supplied by caller for creating request. user SOAP header will reference header after validating received request.
Property methods: userGet(), userGetSwizzled(), userIsValid(), userNewObject(), userSet()

Methods (Including Private)

method AddRequestHeaders(service As %SOAP.WebBase, credentials As %SYS.X509Credentials, interval As %Integer)
Add request headers.
  • SOAP addressing headers will be created and added.
  • product header will be as supplied by caller by setting product property.
  • user header will be as supplied by caller by setting product property.
  • timestamp and signature headers will be created by this method.
AddRequestHeaders 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.
  • The optional interval argument is used to create the timestamp header, if the optional expires field is desired.
method AddResponseHeaders(service As %SOAP.WebBase, credentials As %SYS.X509Credentials)
Add response headers.
  • SOAP addressing headers will be created and added.
  • product header will be as supplied by caller by setting product property.
  • signature header will be created by this method.
AddResponseHeaders 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.
method ValidateHeaders(service As %SOAP.WebBase) as %Status
Validate the signature and other HI required headers.
If called from a web service, a fault is issued in case of error and this method does not return.
If called from a web client, a %Status is returned in case of error.
In order to valdate the headers the web service or client must be told to import the headers.
Web service needs request headers defined in SOAPHEADERS parameter

Parameter SOAPHEADERS =    "signature:%Standards.AU.eHealth.HI.SignatureContainerType,product:%Standards.AU.eHealth.HI.ProductType,user:%Standards.AU.eHealth.HI.UserType,timestamp:%Standards.AU.eHealth.HI.TimestampType"
Web client needs response headers defined in SOAPHEADERS parameter
Parameter SOAPHEADERS =    "signature:%Standards.AU.eHealth.HI.SignatureContainerType,product:%Standards.AU.eHealth.HI.ProductType"

Inherited Members

Inherited Methods (Including Private)

FeedbackOpens in a new window