EnsLib.HL7.Service.HTTPService

class EnsLib.HL7.Service.HTTPService extends EnsLib.HTTP.Service, EnsLib.HL7.Service.Standard

A service to receive HL7v2 messages sent via HTTP. Can use a HTTP.InboundAdapter listener, or the standard CSP service mechanism, or both. In order for the CSP mechanism to work, Web Services derived from this class must be configured either with their configuration name the same as their class name, or the invoking URL must include ?CfgItem= giving the config item name, or using a CSP application with a DispatchClass configured and the config item name as the next URL piece after the application name.

Property Inventory

Method Inventory

Parameters

parameter ADAPTER = EnsLib.HTTP.InboundAdapter;
Inherited description: The type of adapter used to communicate with external systems
parameter SETTINGS = HTTPResponseMode;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

property EnableStandardRequests as %Boolean [ InitialExpression = 0 ];
Listen via the CSP WebServer in addition to listening on the HTTP.InboundAdapter's custom local port, if the Adapter is defined or pool size is more than 0/

The default for HL7 HTTP Services is Off

Note that SSLConfig only applies to the custom local port. To use SSL via the CSP WebServer, you must configure the WebServer separately.

In order for the CSP mechanism to work, HTTP Services must be configured either with their configuration name the same as their class name, or the invoking URL must include ?CfgItem= giving the config item name, or using a CSP application with a DispatchClass configured and the config item name as the next URL piece after the application name.

Property methods: EnableStandardRequestsDisplayToLogical(), EnableStandardRequestsGet(), EnableStandardRequestsIsValid(), EnableStandardRequestsLogicalToDisplay(), EnableStandardRequestsNormalize(), EnableStandardRequestsSet()
property HTTPResponseMode as %String (VALUELIST = ",CodeOnly,CodeWithACKBody,OKCodeWithACKBody") [ InitialExpression = "OKCodeWithACKBody" ];
What kind of HTTP Response should this service return? CodeOnly : Return an HTTP Response Code of 200 for OK, 500 for Error, and no HTTP Response body text CodeWithACKBody : Return an HTTP Response Code of 200 for OK, 500 for Error, and the HL7 response message as body text OKCodeWithACKBody : Return the HL7 response message as body text, and always an HTTP Response Code of 200 for OK if the body exists
Property methods: HTTPResponseModeDisplayToLogical(), HTTPResponseModeGet(), HTTPResponseModeIsValid(), HTTPResponseModeLogicalToDisplay(), HTTPResponseModeLogicalToOdbc(), HTTPResponseModeNormalize(), HTTPResponseModeSet()
property ReplyIOStream as %IO.MetaCharacterStream;
Property methods: ReplyIOStreamGet(), ReplyIOStreamGetSwizzled(), ReplyIOStreamIsValid(), ReplyIOStreamNewObject(), ReplyIOStreamSet()
property ReplyStream as %GlobalCharacterStream;
Property methods: ReplyStreamDelete(), ReplyStreamGet(), ReplyStreamGetObject(), ReplyStreamGetObjectId(), ReplyStreamGetSwizzled(), ReplyStreamIsValid(), ReplyStreamNewObject(), ReplyStreamOid(), ReplyStreamOpen(), ReplyStreamSet(), ReplyStreamSetObject(), ReplyStreamSetObjectId(), ReplyStreamUnSwizzle()
property SegTerminator as %String [ InitialExpression = $C(13,10) ];
End-Segment marker character(s)
Property methods: SegTerminatorDisplayToLogical(), SegTerminatorGet(), SegTerminatorIsValid(), SegTerminatorLogicalToDisplay(), SegTerminatorLogicalToOdbc(), SegTerminatorNormalize(), SegTerminatorSet()

Methods

method %OnNew(pConfigName As %String) as %Status [ Language = objectscript ]
initialize Business Host object
method OnInit() as %Status [ Language = objectscript ]
Inherited description: This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
method OnProcessInput(pStreamIn As %Library.CharacterStream, Output pStreamOut As %Library.CharacterStream, ByRef pHint As %Library.String) as %Status [ Language = objectscript ]
Inherited description: Note: pDocIn is not declared as EnsLib.HL7.Message so that subclasses can handle other types and transform them before calling ##super().
method SendReply(pReplyDocument As EnsLib.EDI.Document, pOriginalDoc As EnsLib.EDI.Document = $$$NULLOREF) as %Status [ Language = objectscript ]

Inherited Members

Inherited Properties

Inherited Methods

Feedback