Skip to main content

HS.FHIRModel.R4.Location

class HS.FHIRModel.R4.Location extends HS.FHIRModel.FHIRClassSuper

*****************************************
** Location generated class schema
*****************************************
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_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.

Properties

property _alias as HS.FHIRModel.R4.SeqOfElement;
Extensions for alias
Property methods: _aliasGet(), _aliasGetSwizzled(), _aliasIsValid(), _aliasNewObject(), _aliasSet()
property _availabilityExceptions as HS.FHIRModel.R4.Element;
Extensions for availabilityExceptions
Property methods: _availabilityExceptionsGet(), _availabilityExceptionsGetSwizzled(), _availabilityExceptionsIsValid(), _availabilityExceptionsNewObject(), _availabilityExceptionsSet()
property _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _mode as HS.FHIRModel.R4.Element;
Extensions for mode
Property methods: _modeGet(), _modeGetSwizzled(), _modeIsValid(), _modeNewObject(), _modeSet()
property _name as HS.FHIRModel.R4.Element;
Extensions for name
Property methods: _nameGet(), _nameGetSwizzled(), _nameIsValid(), _nameNewObject(), _nameSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property address as HS.FHIRModel.R4.Address;
Physical location.
Property methods: addressGet(), addressGetSwizzled(), addressIsValid(), addressNewObject(), addressSet()
property alias as HS.FHIRModel.R4.SeqOfString;
A list of alternate names that the location is known as, or was known as, in the past.
Property methods: aliasGet(), aliasGetSwizzled(), aliasIsValid(), aliasNewObject(), aliasSet()
property availabilityExceptions as %String;
A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.
Property methods: availabilityExceptionsDisplayToLogical(), availabilityExceptionsGet(), availabilityExceptionsIsValid(), availabilityExceptionsLogicalToDisplay(), availabilityExceptionsLogicalToOdbc(), availabilityExceptionsNormalize(), availabilityExceptionsSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property description as %String;
Description of the Location, which helps in finding or referencing the place.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property endpoint as HS.FHIRModel.R4.SeqOfReference;
Technical endpoints providing access to services operated for the location.
Property methods: endpointGet(), endpointGetSwizzled(), endpointIsValid(), endpointNewObject(), endpointSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
What days/times during a week is this location usually open.
Property methods: hoursOfOperationGet(), hoursOfOperationGetSwizzled(), hoursOfOperationIsValid(), hoursOfOperationNewObject(), hoursOfOperationSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Unique code or number identifying the location to its users.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property managingOrganization as HS.FHIRModel.R4.Reference;
The organization responsible for the provisioning and upkeep of the location.
Property methods: managingOrganizationGet(), managingOrganizationGetSwizzled(), managingOrganizationIsValid(), managingOrganizationNewObject(), managingOrganizationSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property mode as %String (VALUELIST = ",instance,kind");
Indicates whether a resource instance represents a specific location or a class of locations.
Property methods: modeDisplayToLogical(), modeGet(), modeIsValid(), modeLogicalToDisplay(), modeLogicalToOdbc(), modeNormalize(), modeSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property name as %String;
Name of the location as used by humans. Does not need to be unique.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property operationalStatus as HS.FHIRModel.R4.Coding;
The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.
Property methods: operationalStatusGet(), operationalStatusGetSwizzled(), operationalStatusIsValid(), operationalStatusNewObject(), operationalStatusSet()
property partOf as HS.FHIRModel.R4.Reference;
Another Location of which this Location is physically a part of.
Property methods: partOfGet(), partOfGetSwizzled(), partOfIsValid(), partOfNewObject(), partOfSet()
property physicalType as HS.FHIRModel.R4.CodeableConcept;
Physical form of the location, e.g. building, room, vehicle, road.
Property methods: physicalTypeGet(), physicalTypeGetSwizzled(), physicalTypeIsValid(), physicalTypeNewObject(), physicalTypeSet()
property position as HS.FHIRModel.R4.LocationX.Position;
The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
Property methods: positionGet(), positionGetSwizzled(), positionIsValid(), positionNewObject(), positionSet()
property resourceType as %String [ InitialExpression = "Location" , Required ];
This is a Location resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String (VALUELIST = ",active,suspended,inactive");
The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property telecom as HS.FHIRModel.R4.SeqOfContactPoint;
The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
Property methods: telecomGet(), telecomGetSwizzled(), telecomIsValid(), telecomNewObject(), telecomSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
Indicates the type of function performed at the location.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Methods

method IncludeAddress()
method IncludeAlias()
method IncludeContained()
method IncludeEndpoint()
method IncludeExtension()
method IncludeHoursOfOperation()
method IncludeIdentifier()
method IncludeManagingOrganization()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeOperationalStatus()
method IncludePartOf()
method IncludePhysicalType()
method IncludePosition()
method IncludeTelecom()
method IncludeText()
method IncludeType()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab