Provider
Class Location

"A bounded physical place or site, including any contained structures. A place may be natural or man-made. The geographic position of a place may or may not be constant. Places may be work facilities (where relevant acts occur), homes (where people live) or offices (where people work). Places may contain sub-places (floor, room, booth, bed). Places may also be sites that are investigated in the context of health care, social work, public health administration (e.g., buildings, picnic grounds, day care centers, prisons, counties, states, and other focuses of epidemiological events). Examples include a field, lake, city, county, state, country, lot (land), building, pipeline, power line, playground, ship, truck." - HL7 V3.
"Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated." - HL7 FHIR, Location
Note that FHIR has a single class, Location, which encompasses concepts which the FHIM splits into the Location class and the ServiceDeliveryLocation class.

Attributes
«AD» Address address address

The physical location at which the Location is located or to which mail can be directed. Note that both the Location and the ServiceDeliveryLocation classes contain an address. In general, it is anticipated that the Location address would be used, but the ServiceDeliveryLocation address would be used when the organizational presence at the location uses a different address. For example, the physical address may be 123 Main St, but the radiology department may be 123 Main St Suite 400, or may have a billing address at another location.
"Physical location." – HL7 FHIR, Location.address

String alias alias

"A list of alternate names that the location is known as, or was known as in the past." - HL7 FHIR, Location.alias

String description description

"Description of the Location, which helps in finding or referencing the place." - HL7 FHIR, Location.description

«II» Id id id

Uniquely identifies the location.
"Unique code or number identifying the location to its users." - HL7 FHIR, Location.identifier

«CS» Code mode mode

This optional property is included for compatibility with FHIR, but does not fit within the paradigm of the FHIM. In FHIR, it is meant to signal whether the Location is an actual location or a definition of a class of locations. In the FHIM, the Location class is always an actual location. Classes of locations would be represented in the ServiceDeliveryLocation category and/or serviceType properties.
"Indicates whether a resource instance represents a specific location or a class of locations." – HL7 FHIR, Location.mode

String name name

A moniker for the location.
"Name of the location as used by humans. Does not need to be unique." - HL7 FHIR, Location.name

«CS» Code operationalStatus operationalStatus

"The Operational status covers operation values most relevant to beds (but can also apply to rooms/units/chair/etc such as an isolation unit/dialisys chair). This typically covers concepts such as contamination, housekeeping and other activities like maintenance." - HL7 FHIR, Location.operationalStatus

«CS» Code physicalType physicalType

"Physical form of the location, e.g. building, room, vehicle, road." – HL7 FHIR, Location.physicalType

Position position position

"The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML)." – HL7 FHIR, Location.position

RelatedLocation relatedLocation relatedLocation

Pointer to another Location to which this Location is somehow related.
"Another Location which this Location is physically part of." – HL7 FHIR, Location.partOf. Note that FHIM construct is able to handle multiple kinds of relationships between Locations, while FHIR only handles part-of.

«CS» Code status status

"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." - HL7 FHIR, Location.status


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameLocation
Name Expression
NamespaceProvider
Owned Template Signature
OwnerProvider
Owning Template Parameter
PackageProvider
Qualified NameFHIM::Provider::Location
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 address
Public «AD» Address address

The physical location at which the Location is located or to which mail can be directed. Note that both the Location and the ServiceDeliveryLocation classes contain an address. In general, it is anticipated that the Location address would be used, but the ServiceDeliveryLocation address would be used when the organizational presence at the location uses a different address. For example, the physical address may be 123 Main St, but the radiology department may be 123 Main St Suite 400, or may have a billing address at another location.
"Physical location." – HL7 FHIR, Location.address

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassLocation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameaddress
Name Expression
NamespaceLocation
Opposite
OwnerLocation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::Location::address
Stereotype
Template Parameter
Type«AD» Address
Upper1
Upper Value(1)
VisibilityPublic


 alias
Public String alias

"A list of alternate names that the location is known as, or was known as in the past." - HL7 FHIR, Location.alias

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassLocation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namealias
Name Expression
NamespaceLocation
Opposite
OwnerLocation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::Location::alias
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 description
Public String description

"Description of the Location, which helps in finding or referencing the place." - HL7 FHIR, Location.description

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassLocation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namedescription
Name Expression
NamespaceLocation
Opposite
OwnerLocation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::Location::description
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 id
Public «II» Id id

Uniquely identifies the location.
"Unique code or number identifying the location to its users." - HL7 FHIR, Location.identifier

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassLocation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Nameid
Name Expression
NamespaceLocation
Opposite
OwnerLocation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::Location::id
Stereotype
Template Parameter
Type«II» Id
Upper1
Upper Value(1)
VisibilityPublic


 mode
Public «CS» Code mode

This optional property is included for compatibility with FHIR, but does not fit within the paradigm of the FHIM. In FHIR, it is meant to signal whether the Location is an actual location or a definition of a class of locations. In the FHIM, the Location class is always an actual location. Classes of locations would be represented in the ServiceDeliveryLocation category and/or serviceType properties.
"Indicates whether a resource instance represents a specific location or a class of locations." – HL7 FHIR, Location.mode

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassLocation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namemode
Name Expression
NamespaceLocation
Opposite
OwnerLocation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::Location::mode
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 name
Public String name

A moniker for the location.
"Name of the location as used by humans. Does not need to be unique." - HL7 FHIR, Location.name

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassLocation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namename
Name Expression
NamespaceLocation
Opposite
OwnerLocation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::Location::name
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 operationalStatus
Public «CS» Code operationalStatus

"The Operational status covers operation values most relevant to beds (but can also apply to rooms/units/chair/etc such as an isolation unit/dialisys chair). This typically covers concepts such as contamination, housekeeping and other activities like maintenance." - HL7 FHIR, Location.operationalStatus

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassLocation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameoperationalStatus
Name Expression
NamespaceLocation
Opposite
OwnerLocation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::Location::operationalStatus
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 physicalType
Public «CS» Code physicalType

"Physical form of the location, e.g. building, room, vehicle, road." – HL7 FHIR, Location.physicalType

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassLocation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamephysicalType
Name Expression
NamespaceLocation
Opposite
OwnerLocation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::Location::physicalType
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 position
Public Position position

"The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML)." – HL7 FHIR, Location.position

Constraints:
Properties:

AggregationNone
Alias
Associationlocation_position
Association End
ClassLocation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameposition
Name Expression
NamespaceLocation
Opposite
OwnerLocation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::Location::position
Stereotype
Template Parameter
TypePosition
Upper1
Upper Value(1)
VisibilityPublic


 relatedLocation
Public RelatedLocation relatedLocation

Pointer to another Location to which this Location is somehow related.
"Another Location which this Location is physically part of." – HL7 FHIR, Location.partOf. Note that FHIM construct is able to handle multiple kinds of relationships between Locations, while FHIR only handles part-of.

Constraints:
Properties:

AggregationNone
Alias
Associationlocation_relatedLocation
Association End
ClassLocation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamerelatedLocation
Name Expression
NamespaceLocation
Opposite
OwnerLocation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::Location::relatedLocation
Stereotype
Template Parameter
TypeRelatedLocation
Upper*
Upper Value(*)
VisibilityPublic


 status
Public «CS» Code status

"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." - HL7 FHIR, Location.status

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassLocation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namestatus
Name Expression
NamespaceLocation
Opposite
OwnerLocation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::Location::status
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic