Skip to main content


class HS.Types.FacilityInfo extends %Library.RegisteredObject, HS.Util.DataModel.Adaptor, %XML.Adaptor, HS.Util.CopyFrom

Property Inventory


Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.
parameter XMLIGNORENULL = inputonly;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.


property AssigningAuthority as %Boolean;
Whether this facility will serve as an assigning authority
Property methods: AssigningAuthorityDisplayToLogical(), AssigningAuthorityGet(), AssigningAuthorityIsValid(), AssigningAuthorityLogicalToDisplay(), AssigningAuthorityLogicalToXSD(), AssigningAuthorityNormalize(), AssigningAuthoritySet(), AssigningAuthorityXSDToLogical()
property ConsentGroup as %String);
Property methods: ConsentGroupDisplayToLogical(), ConsentGroupGet(), ConsentGroupIsValid(), ConsentGroupLogicalToDisplay(), ConsentGroupLogicalToOdbc(), ConsentGroupNormalize(), ConsentGroupSet()
property Contact as HS.Types.Contact;
Property methods: ContactGet(), ContactGetObject(), ContactGetObjectId(), ContactGetSwizzled(), ContactIsEmpty(), ContactIsValid(), ContactNewObject(), ContactSet(), ContactSetObject(), ContactSetObjectId(), ContactUnSwizzle()
property Description as %String);
Facility description Free text description of the facility to display to the user e.g. St Lukes Hospital, 1 George Street, Windosr, MA 10213, USA
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property ExternalHIE as %Boolean [ InitialExpression = 0 ];
Property methods: ExternalHIEDisplayToLogical(), ExternalHIEGet(), ExternalHIEIsValid(), ExternalHIELogicalToDisplay(), ExternalHIELogicalToXSD(), ExternalHIENormalize(), ExternalHIESet(), ExternalHIEXSDToLogical()
property FacilityCode as HS.HC.DataType.FacilityCode;
"Coded" value for the facility, as sent by the Gateway A unique value for the whole HealthShare network e.g. STLW
Property methods: FacilityCodeDisplayToLogical(), FacilityCodeGet(), FacilityCodeIsValid(), FacilityCodeLogicalToDisplay(), FacilityCodeLogicalToOdbc(), FacilityCodeNormalize(), FacilityCodeSet()
property FacilityId as %String (MAXLEN = 256, ZENREADONLY = 0);
MPI's ID for the facility The ID used by the MPI (e.g. Quadramed or Initiate) which may be different from the HealthShare FacilityCode e.g. ST001
Property methods: FacilityIdDisplayToLogical(), FacilityIdGet(), FacilityIdIsValid(), FacilityIdLogicalToDisplay(), FacilityIdLogicalToOdbc(), FacilityIdNormalize(), FacilityIdSet()
property GatewayName as %String (MAXLEN = 256, ZENHIDDEN = 1);
Property methods: GatewayNameDisplayToLogical(), GatewayNameGet(), GatewayNameIsValid(), GatewayNameLogicalToDisplay(), GatewayNameLogicalToOdbc(), GatewayNameNormalize(), GatewayNameSet()
property HomeFacility as %Boolean;
Determines whether can records for this facility can be manually edited
Property methods: HomeFacilityDisplayToLogical(), HomeFacilityGet(), HomeFacilityIsValid(), HomeFacilityLogicalToDisplay(), HomeFacilityLogicalToXSD(), HomeFacilityNormalize(), HomeFacilitySet(), HomeFacilityXSDToLogical()
property IPAddresses as list of %String);
Property methods: IPAddressesBuildValueArray(), IPAddressesCollectionToDisplay(), IPAddressesCollectionToOdbc(), IPAddressesDisplayToCollection(), IPAddressesDisplayToLogical(), IPAddressesGet(), IPAddressesGetObject(), IPAddressesGetObjectId(), IPAddressesGetSwizzled(), IPAddressesIsValid(), IPAddressesLogicalToDisplay(), IPAddressesLogicalToOdbc(), IPAddressesNormalize(), IPAddressesOdbcToCollection(), IPAddressesSet(), IPAddressesSetObject(), IPAddressesSetObjectId()
property IgnoreProviderUpdates as %Boolean;
If true updates from HSPD will not change contact information
Property methods: IgnoreProviderUpdatesDisplayToLogical(), IgnoreProviderUpdatesGet(), IgnoreProviderUpdatesIsValid(), IgnoreProviderUpdatesLogicalToDisplay(), IgnoreProviderUpdatesLogicalToXSD(), IgnoreProviderUpdatesNormalize(), IgnoreProviderUpdatesSet(), IgnoreProviderUpdatesXSDToLogical()
property Name as HS.HC.DataType.FacilityName;
Name of this facility Displayed to the user, e.g. St Lukes Hospital, Windsor
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property OID as %String (MAXLEN = 64);
OID property is not used - this is leftover from a very early version The facility's OID is stored in the OID registry (HS.Data.OIDMap).
Property methods: OIDDisplayToLogical(), OIDGet(), OIDIsValid(), OIDLogicalToDisplay(), OIDLogicalToOdbc(), OIDNormalize(), OIDSet()
property Roles as list of %String (MAXLEN = 64);
Roles (which includes consent groups) that this facility is allowed to assign
Property methods: RolesBuildValueArray(), RolesCollectionToDisplay(), RolesCollectionToOdbc(), RolesDisplayToCollection(), RolesDisplayToLogical(), RolesGet(), RolesGetObject(), RolesGetObjectId(), RolesGetSwizzled(), RolesIsValid(), RolesLogicalToDisplay(), RolesLogicalToOdbc(), RolesNormalize(), RolesOdbcToCollection(), RolesSet(), RolesSetObject(), RolesSetObjectId()
property Tier as %Integer;
For selecting the best patient record
Property methods: TierDisplayToLogical(), TierGet(), TierIsValid(), TierLogicalToDisplay(), TierNormalize(), TierSet(), TierXSDToLogical()
property Timezone as %String;
Property methods: TimezoneDisplayToLogical(), TimezoneGet(), TimezoneIsValid(), TimezoneLogicalToDisplay(), TimezoneLogicalToOdbc(), TimezoneNormalize(), TimezoneSet()

Inherited Members

Inherited Properties

Inherited Methods


FeedbackOpens in a new tab