Skip to main content

HS.AU.PCEHR.HeaderType

class HS.AU.PCEHR.HeaderType extends %SOAP.Header

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 NAMESPACE = http://ns.electronichealth.net.au/pcehr/xsd/common/CommonCoreElements/1.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 = PCEHRHeader;
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 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.

Properties

property AccessingOrganisation as HS.AU.PCEHR.AccessingOrganisation (XMLNAME = "accessingOrganisation");
Property methods: AccessingOrganisationGet(), AccessingOrganisationGetSwizzled(), AccessingOrganisationIsValid(), AccessingOrganisationNewObject(), AccessingOrganisationSet()
property ClientSystemType as %String) [ Required ];
Property methods: ClientSystemTypeDisplayToLogical(), ClientSystemTypeGet(), ClientSystemTypeIsValid(), ClientSystemTypeLogicalToDisplay(), ClientSystemTypeLogicalToOdbc(), ClientSystemTypeNormalize(), ClientSystemTypeSet()
property IHINumber as HS.AU.PCEHR.IHINumber (REFELEMENTQUALIFIED = 1, REFNAMESPACE = "http://ns.electronichealth.net.au/pcehr/xsd/common/CommonCoreElements/1.0", XMLNAME = "ihiNumber", XMLREF = 1);
Property methods: IHINumberDisplayToLogical(), IHINumberGet(), IHINumberIsValid(), IHINumberLogicalToDisplay(), IHINumberLogicalToOdbc(), IHINumberNormalize(), IHINumberSet()
property ProductType as HS.AU.PCEHR.ProductType (XMLNAME = "productType") [ Required ];
Property methods: ProductTypeGet(), ProductTypeGetSwizzled(), ProductTypeIsValid(), ProductTypeNewObject(), ProductTypeSet()
property User as HS.AU.PCEHR.User (XMLNAME = "User") [ SqlFieldName = _User , Required ];
Property methods: UserGet(), UserGetSwizzled(), UserIsValid(), UserNewObject(), UserSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab