|
| Provider UML Documentation |
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, LocationNote 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 |
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 |
"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 of the Location, which helps in finding or referencing the place." - HL7 FHIR, Location.description
|
| «II» Id | identifier |
Uniquely identifies the location."Unique code or number identifying the location to its users." - HL7 FHIR, Location.identifier
|
| «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
|
| 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
|
| «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
|
| «CS» Code | physicalType |
"Physical form of the location, e.g. building, room, vehicle, road." – HL7 FHIR, Location.physicalType
|
| 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 |
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.
|
| ServiceDeliveryLocation | serviceDeliveryLocation |
Pointer to the ServiceDeliveryLocation Role that this location plays or has played in the past.
|
| «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
|
Properties:
| Alias | |
| Classifier Behavior | |
| Is Abstract | false |
| Is Active | false |
| Is Leaf | false |
| Keywords | |
| Name | Location |
| Name Expression | |
| Namespace | Provider |
| Owned Template Signature | |
| Owner | Provider |
| Owning Template Parameter | |
| Package | Provider |
| Qualified Name | FHIM::Provider::Location |
| Representation | |
| Stereotype | |
| Template Parameter | |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | Location |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | 0..1 |
| Name | address |
| Name Expression | |
| Namespace | Location |
| Opposite | |
| Owner | Location |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::Location::address |
| Stereotype | |
| Template Parameter | |
| Type | «AD» Address |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | Location |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | * |
| Name | alias |
| Name Expression | |
| Namespace | Location |
| Opposite | |
| Owner | Location |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::Location::alias |
| Stereotype | |
| Template Parameter | |
| Type | String |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
description
Public String description
-
"Description of the Location, which helps in finding or referencing the place." - HL7 FHIR, Location.description
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | Location |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | 0..1 |
| Name | description |
| Name Expression | |
| Namespace | Location |
| Opposite | |
| Owner | Location |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::Location::description |
| Stereotype | |
| Template Parameter | |
| Type | String |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
identifier
Public «II» Id identifier
-
Uniquely identifies the location."Unique code or number identifying the location to its users." - HL7 FHIR, Location.identifier
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | Location |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 1 |
| Lower Value | (1) |
| Multiplicity | 1 |
| Name | identifier |
| Name Expression | |
| Namespace | Location |
| Opposite | |
| Owner | Location |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::Location::identifier |
| Stereotype | |
| Template Parameter | |
| Type | «II» Id |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | Location |
| Terminologies | [
HL7_FHIR_R4 LocationMode http://hl7.org/fhir/ValueSet/location-mode
] |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | 0..1 |
| Name | mode |
| Name Expression | |
| Namespace | Location |
| Opposite | |
| Owner | Location |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::Location::mode |
| Stereotype | ValueSetConstraints |
| Template Parameter | |
| Type | «CS» Code |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | Location |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | 0..1 |
| Name | name |
| Name Expression | |
| Namespace | Location |
| Opposite | |
| Owner | Location |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::Location::name |
| Stereotype | |
| Template Parameter | |
| Type | String |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | Location |
| Terminologies | [
HL7_FHIR_R4 HL7 v2 Bed Status http://terminology.hl7.org/ValueSet/v2-0116
] |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | 0..1 |
| Name | operationalStatus |
| Name Expression | |
| Namespace | Location |
| Opposite | |
| Owner | Location |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::Location::operationalStatus |
| Stereotype | ValueSetConstraints |
| Template Parameter | |
| Type | «CS» Code |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
physicalType
Public «CS» Code physicalType
-
"Physical form of the location, e.g. building, room, vehicle, road." – HL7 FHIR, Location.physicalType
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | Location |
| Terminologies | [
HL7_FHIR_R4 Location type http://hl7.org/fhir/ValueSet/location-physical-type
] |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | 0..1 |
| Name | physicalType |
| Name Expression | |
| Namespace | Location |
| Opposite | |
| Owner | Location |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::Location::physicalType |
| Stereotype | ValueSetConstraints |
| Template Parameter | |
| Type | «CS» Code |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | location_position |
| Association End | |
| Class | Location |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | 0..1 |
| Name | position |
| Name Expression | |
| Namespace | Location |
| Opposite | |
| Owner | Location |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::Location::position |
| Stereotype | |
| Template Parameter | |
| Type | Position |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | location_relatedLocation |
| Association End | |
| Class | Location |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | * |
| Name | relatedLocation |
| Name Expression | |
| Namespace | Location |
| Opposite | |
| Owner | Location |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::Location::relatedLocation |
| Stereotype | |
| Template Parameter | |
| Type | RelatedLocation |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
serviceDeliveryLocation
Public ServiceDeliveryLocation serviceDeliveryLocation
-
Pointer to the ServiceDeliveryLocation Role that this location plays or has played in the past.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | location_serviceDeliveryLocation |
| Association End | |
| Class | Location |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | * |
| Name | serviceDeliveryLocation |
| Name Expression | |
| Namespace | Location |
| Opposite | |
| Owner | Location |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::Location::serviceDeliveryLocation |
| Stereotype | |
| Template Parameter | |
| Type | ServiceDeliveryLocation |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | Location |
| Terminologies | [
HL7_FHIR_R4 LocationStatus http://hl7.org/fhir/ValueSet/location-status
] |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | 0..1 |
| Name | status |
| Name Expression | |
| Namespace | Location |
| Opposite | |
| Owner | Location |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::Location::status |
| Stereotype | ValueSetConstraints |
| Template Parameter | |
| Type | «CS» Code |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
|
| Provider UML Documentation |