Skip to main content


class HS.FHIR.DTL.vR4.Model.Resource.Location extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Details and position information for a physical place.

Property Inventory


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 XMLNAME = Location;
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.
parameter XMLTYPE = Location;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property address as HS.FHIR.DTL.vR4.Model.Datatype.Address (XMLNAME = "address", XMLPROJECTION = "ELEMENT");

Physical location.

Property methods: addressGet(), addressGetSwizzled(), addressIsValid(), addressNewObject(), addressSet()
property alias as list of %String (MAXLEN = 1000000, XMLNAME = "alias", XMLPROJECTION = "ELEMENT");

A list of alternate names that the location is known as, or was known as, in the past.

Property methods: aliasBuildValueArray(), aliasCollectionToDisplay(), aliasCollectionToOdbc(), aliasDisplayToCollection(), aliasDisplayToLogical(), aliasGet(), aliasGetObject(), aliasGetObjectId(), aliasGetSwizzled(), aliasIsValid(), aliasLogicalToDisplay(), aliasLogicalToOdbc(), aliasNormalize(), aliasOdbcToCollection(), aliasSet(), aliasSetObject(), aliasSetObjectId()
property availabilityExceptions as %String (MAXLEN = 1000000, XMLNAME = "availabilityExceptions", XMLPROJECTION = "ATTRIBUTE");

Description of availability exceptions.

Property methods: availabilityExceptionsDisplayToLogical(), availabilityExceptionsGet(), availabilityExceptionsIsValid(), availabilityExceptionsLogicalToDisplay(), availabilityExceptionsLogicalToOdbc(), availabilityExceptionsNormalize(), availabilityExceptionsSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");

Additional details about the location that could be displayed as further information to identify the location beyond its name.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property endpoint as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "endpoint", XMLPROJECTION = "ELEMENT");

Technical endpoints providing access to services operated for the location.


Property methods: endpointBuildValueArray(), endpointCollectionToDisplay(), endpointCollectionToOdbc(), endpointDisplayToCollection(), endpointGet(), endpointGetObject(), endpointGetObjectId(), endpointGetSwizzled(), endpointIsValid(), endpointOdbcToCollection(), endpointSet(), endpointSetObject(), endpointSetObjectId()
property hoursOfOperation as list of HS.FHIR.DTL.vR4.Model.Element.Location.hoursOfOperation (XMLNAME = "hoursOfOperation", XMLPROJECTION = "ELEMENT");

What days/times during a week is this location usually open.

Property methods: hoursOfOperationBuildValueArray(), hoursOfOperationCollectionToDisplay(), hoursOfOperationCollectionToOdbc(), hoursOfOperationDisplayToCollection(), hoursOfOperationGet(), hoursOfOperationGetObject(), hoursOfOperationGetObjectId(), hoursOfOperationGetSwizzled(), hoursOfOperationIsValid(), hoursOfOperationOdbcToCollection(), hoursOfOperationSet(), hoursOfOperationSetObject(), hoursOfOperationSetObjectId()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Unique code or number identifying the location to its users.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property managingOrganization as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "managingOrganization", XMLPROJECTION = "ELEMENT");

Organization responsible for provisioning and upkeep.


Property methods: managingOrganizationGet(), managingOrganizationGetSwizzled(), managingOrganizationIsValid(), managingOrganizationNewObject(), managingOrganizationSet()
property mode as %String (MAXLEN = 1000000, XMLNAME = "mode", XMLPROJECTION = "ATTRIBUTE");

instance | kind

location-mode|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend location-mode|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: modeDisplayToLogical(), modeGet(), modeIsValid(), modeLogicalToDisplay(), modeLogicalToOdbc(), modeNormalize(), modeSet()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE");

Name of the location as used by humans.

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property operationalStatus as HS.FHIR.DTL.vR4.Model.Datatype.Coding (XMLNAME = "operationalStatus", XMLPROJECTION = "ELEMENT");

The operational status of the location (typically only for a bed/room)

v2-0116 is the PREFERRED FHIR4 ValueSet for codes, but if you need to express meanings not found in v2-0116, you may use codes from any ValueSet.

Property methods: operationalStatusGet(), operationalStatusGetSwizzled(), operationalStatusIsValid(), operationalStatusNewObject(), operationalStatusSet()
property partOf as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");

Another Location this one is physically a part of.


Property methods: partOfGet(), partOfGetSwizzled(), partOfIsValid(), partOfNewObject(), partOfSet()
property physicalType as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "physicalType", XMLPROJECTION = "ELEMENT");

Physical form of the location.

any FHIR4 code may be used; location-physical-type shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: physicalTypeGet(), physicalTypeGetSwizzled(), physicalTypeIsValid(), physicalTypeNewObject(), physicalTypeSet()
property position as HS.FHIR.DTL.vR4.Model.Element.Location.position (XMLNAME = "position", XMLPROJECTION = "ELEMENT");

The absolute geographic location.

Property methods: positionGet(), positionGetSwizzled(), positionIsValid(), positionNewObject(), positionSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");

active | suspended | inactive

location-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend location-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property telecom as list of HS.FHIR.DTL.vR4.Model.Datatype.ContactPoint (XMLNAME = "telecom", XMLPROJECTION = "ELEMENT");

Contact details of the location.

Property methods: telecomBuildValueArray(), telecomCollectionToDisplay(), telecomCollectionToOdbc(), telecomDisplayToCollection(), telecomGet(), telecomGetObject(), telecomGetObjectId(), telecomGetSwizzled(), telecomIsValid(), telecomOdbcToCollection(), telecomSet(), telecomSetObject(), telecomSetObjectId()
property type as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");

Type of function performed.

v3-ServiceDeliveryLocationRoleType is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in v3-ServiceDeliveryLocationRoleType, you may formally EXTEND v3-ServiceDeliveryLocationRoleType to add codes to it.

Property methods: typeBuildValueArray(), typeCollectionToDisplay(), typeCollectionToOdbc(), typeDisplayToCollection(), typeGet(), typeGetObject(), typeGetObjectId(), typeGetSwizzled(), typeIsValid(), typeOdbcToCollection(), typeSet(), typeSetObject(), typeSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab