Location
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Columns
Header row
# |
path |
type |
required |
description |
0 |
resourceType |
string |
* |
Resource type identifier. Must be string "Location" |
1 |
|
integer |
* |
Number of subrows |
2 |
id |
string |
* |
Logical id of this artifact |
3 |
status |
code |
|
active | suspended | inactive |
|
operationalStatus |
Coding |
|
The operational status of the location (typically only for a bed/room) |
4 |
operationalStatus.system |
uri |
|
Identity of the terminology system |
5 |
operationalStatus.version |
string |
|
Version of the system - if relevant |
6 |
operationalStatus.code |
code |
|
Symbol in syntax defined by the system |
7 |
operationalStatus.display |
string |
|
Representation defined by the system |
8 |
operationalStatus.userSelected |
boolean |
|
If this coding was chosen directly by the user |
9 |
name |
string |
|
Name of the location as used by humans |
10 |
description |
string |
|
Additional details about the location that could be displayed as further information to identify the location beyond its name |
11 |
mode |
code |
|
instance | kind |
|
address |
Address |
|
Physical location |
12 |
address.use |
code |
|
home | work | temp | old | billing - purpose of this address |
13 |
address.type |
code |
|
postal | physical | both |
14 |
address.text |
string |
|
Text representation of the address |
15 |
address.line |
string |
|
Street name, number, direction & P.O. Box etc. |
16 |
address.city |
string |
|
Name of city, town etc. |
17 |
address.district |
string |
|
District name (aka county) |
18 |
address.state |
string |
|
Sub-unit of country (abbreviations ok) |
19 |
address.postalCode |
string |
|
Postal code for area |
20 |
address.country |
string |
|
Country (e.g. can be ISO 3166 2 or 3 letter code) |
|
address.period |
Period |
|
Time period when address was/is in use |
21 |
address.period.start |
dateTime |
|
Starting time with inclusive boundary |
22 |
address.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
|
physicalType |
CodeableConcept |
|
Physical form of the location |
|
physicalType.coding |
Coding |
|
Code defined by a terminology system |
23 |
physicalType.coding.system |
uri |
|
Identity of the terminology system |
24 |
physicalType.coding.version |
string |
|
Version of the system - if relevant |
25 |
physicalType.coding.code |
code |
|
Symbol in syntax defined by the system |
26 |
physicalType.coding.display |
string |
|
Representation defined by the system |
27 |
physicalType.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
28 |
physicalType.text |
string |
|
Plain text representation of the concept |
|
position |
|
|
The absolute geographic location |
29 |
position.longitude |
decimal |
|
Longitude with WGS84 datum |
30 |
position.latitude |
decimal |
|
Latitude with WGS84 datum |
31 |
position.altitude |
decimal |
|
Altitude with WGS84 datum |
|
managingOrganization |
Reference |
|
Organization responsible for provisioning and upkeep |
32 |
managingOrganization.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
33 |
managingOrganization.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
managingOrganization.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
34 |
managingOrganization.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
managingOrganization.identifier.type |
CodeableConcept |
|
Description of identifier |
|
managingOrganization.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
35 |
managingOrganization.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
36 |
managingOrganization.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
37 |
managingOrganization.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
38 |
managingOrganization.identifier.type.coding.display |
string |
|
Representation defined by the system |
39 |
managingOrganization.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
40 |
managingOrganization.identifier.type.text |
string |
|
Plain text representation of the concept |
41 |
managingOrganization.identifier.system |
uri |
|
The namespace for the identifier value |
42 |
managingOrganization.identifier.value |
string |
|
The value that is unique |
|
managingOrganization.identifier.period |
Period |
|
Time period when id is/was valid for use |
43 |
managingOrganization.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
44 |
managingOrganization.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
45 |
managingOrganization.display |
string |
|
Text alternative for the resource |
|
partOf |
Reference |
|
Another Location this one is physically a part of |
46 |
partOf.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
47 |
partOf.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
partOf.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
48 |
partOf.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
partOf.identifier.type |
CodeableConcept |
|
Description of identifier |
|
partOf.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
49 |
partOf.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
50 |
partOf.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
51 |
partOf.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
52 |
partOf.identifier.type.coding.display |
string |
|
Representation defined by the system |
53 |
partOf.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
54 |
partOf.identifier.type.text |
string |
|
Plain text representation of the concept |
55 |
partOf.identifier.system |
uri |
|
The namespace for the identifier value |
56 |
partOf.identifier.value |
string |
|
The value that is unique |
|
partOf.identifier.period |
Period |
|
Time period when id is/was valid for use |
57 |
partOf.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
58 |
partOf.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
59 |
partOf.display |
string |
|
Text alternative for the resource |
60 |
availabilityExceptions |
string |
|
Description of availability exceptions |
Row identifier
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "identifier" |
|
identifier |
Identifier |
|
Unique code or number identifying the location to its users |
1 |
identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
identifier.type |
CodeableConcept |
|
Description of identifier |
|
identifier.type.coding |
Coding |
|
Code defined by a terminology system |
2 |
identifier.type.coding.system |
uri |
|
Identity of the terminology system |
3 |
identifier.type.coding.version |
string |
|
Version of the system - if relevant |
4 |
identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
5 |
identifier.type.coding.display |
string |
|
Representation defined by the system |
6 |
identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
7 |
identifier.type.text |
string |
|
Plain text representation of the concept |
8 |
identifier.system |
uri |
|
The namespace for the identifier value |
9 |
identifier.value |
string |
|
The value that is unique |
|
identifier.period |
Period |
|
Time period when id is/was valid for use |
10 |
identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
11 |
identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
Row alias
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "alias" |
1 |
alias |
string |
|
A list of alternate names that the location is known as, or was known as, in the past |
Row type
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "type" |
|
type |
CodeableConcept |
|
Type of function performed |
|
type.coding |
Coding |
|
Code defined by a terminology system |
1 |
type.coding.system |
uri |
|
Identity of the terminology system |
2 |
type.coding.version |
string |
|
Version of the system - if relevant |
3 |
type.coding.code |
code |
|
Symbol in syntax defined by the system |
4 |
type.coding.display |
string |
|
Representation defined by the system |
5 |
type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
6 |
type.text |
string |
|
Plain text representation of the concept |
Row telecom
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "telecom" |
|
telecom |
ContactPoint |
|
Contact details of the location |
1 |
telecom.system |
code |
|
phone | fax | email | pager | url | sms | other |
2 |
telecom.value |
string |
|
The actual contact point details |
3 |
telecom.use |
code |
|
home | work | temp | old | mobile - purpose of this contact point |
4 |
telecom.rank |
positiveInt |
|
Specify preferred order of use (1 = highest) |
|
telecom.period |
Period |
|
Time period when the contact point was/is in use |
5 |
telecom.period.start |
dateTime |
|
Starting time with inclusive boundary |
6 |
telecom.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
Row hoursOfOperation
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "hoursOfOperation" |
|
hoursOfOperation |
|
|
What days/times during a week is this location usually open |
1 |
hoursOfOperation.daysOfWeek |
code |
|
mon | tue | wed | thu | fri | sat | sun |
2 |
hoursOfOperation.allDay |
boolean |
|
The Location is open all day |
3 |
hoursOfOperation.openingTime |
time |
|
Time that the Location opens |
4 |
hoursOfOperation.closingTime |
time |
|
Time that the Location closes |
Row endpoint
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "endpoint" |
|
endpoint |
Reference |
|
Technical endpoints providing access to services operated for the location |
1 |
endpoint.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
2 |
endpoint.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
endpoint.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
3 |
endpoint.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
endpoint.identifier.type |
CodeableConcept |
|
Description of identifier |
|
endpoint.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
4 |
endpoint.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
5 |
endpoint.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
6 |
endpoint.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
7 |
endpoint.identifier.type.coding.display |
string |
|
Representation defined by the system |
8 |
endpoint.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
9 |
endpoint.identifier.type.text |
string |
|
Plain text representation of the concept |
10 |
endpoint.identifier.system |
uri |
|
The namespace for the identifier value |
11 |
endpoint.identifier.value |
string |
|
The value that is unique |
|
endpoint.identifier.period |
Period |
|
Time period when id is/was valid for use |
12 |
endpoint.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
13 |
endpoint.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
14 |
endpoint.display |
string |
|
Text alternative for the resource |
Examples
Example #1
Input CSV
Location,2,"amb","active",,,,,,"BUMC Ambulance","Ambulance provided by Burgers University Medical Center","kind",,,,,,,,,,,,"http://terminology.hl7.org/CodeSystem/location-physical-type",,"ve","Vehicle",,,,,,"Organization/f001",,,,,,,,,,,,,,,,,,,,,,,,,,,,
type,"http://terminology.hl7.org/CodeSystem/v3-RoleCode",,"AMB","Ambulance",,
telecom,"phone","2329","mobile",,,
Resulting resource
{
"resourceType": "Location",
"id": "amb",
"status": "active",
"name": "BUMC Ambulance",
"description": "Ambulance provided by Burgers University Medical Center",
"mode": "kind",
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "AMB",
"display": "Ambulance"
}
]
}
],
"telecom": [
{
"system": "phone",
"value": "2329",
"use": "mobile"
}
],
"physicalType": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
"code": "ve",
"display": "Vehicle"
}
]
},
"managingOrganization": {
"reference": "Organization/f001"
}
}
Example #2
Input CSV
Location,4,"hl7","active",,,,,,"Health Level Seven International","HL7 Headquarters","instance",,,,"3300 Washtenaw Avenue, Suite 227","Ann Arbor",,"MI","48104","USA",,,"http://terminology.hl7.org/CodeSystem/location-physical-type",,"bu","Building",,,42.2565,-83.69471,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
type,"http://terminology.hl7.org/CodeSystem/v3-RoleCode",,"SLEEP","Sleep disorders unit",,
telecom,"phone","(+1) 734-677-7777",,,,
telecom,"fax","(+1) 734-677-6622",,,,
telecom,"email","hq@HL7.org",,,,
Resulting resource
{
"resourceType": "Location",
"id": "hl7",
"status": "active",
"name": "Health Level Seven International",
"description": "HL7 Headquarters",
"mode": "instance",
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "SLEEP",
"display": "Sleep disorders unit"
}
]
}
],
"telecom": [
{
"system": "phone",
"value": "(+1) 734-677-7777"
},
{
"system": "fax",
"value": "(+1) 734-677-6622"
},
{
"system": "email",
"value": "hq@HL7.org"
}
],
"address": {
"line": [
"3300 Washtenaw Avenue, Suite 227"
],
"city": "Ann Arbor",
"state": "MI",
"postalCode": "48104",
"country": "USA"
},
"physicalType": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
"code": "bu",
"display": "Building"
}
]
},
"position": {
"longitude": 42.2565,
"latitude": -83.69471
}
}
Example #3
Input CSV
Location,8,"1","active",,,,,,"South Wing, second floor","Second floor of the Old South Wing, formerly in use by Psychiatry","instance","work",,,"Galapagosweg 91, Building A","Den Burg",,,"9105 PZ","NLD",,,"http://terminology.hl7.org/CodeSystem/location-physical-type",,"wi","Wing",,,-83.6945691,42.25475478,0,"Organization/f001",,,,,,,,,,,,,,,,,,,,,,,,,,,,
identifier,,,,,,,,,"B1-S.F2",,
alias,"BU MC, SW, F2"
alias,"Burgers University Medical Center, South Wing, second floor"
telecom,"phone","2328","work",,,
telecom,"fax","2329","work",,,
telecom,"email","second wing admissions",,,,
telecom,"url","http://sampleorg.com/southwing","work",,,
endpoint,"Endpoint/example",,,,,,,,,,,,,
Resulting resource
{
"resourceType": "Location",
"id": "1",
"identifier": [
{
"value": "B1-S.F2"
}
],
"status": "active",
"name": "South Wing, second floor",
"alias": [
"BU MC, SW, F2",
"Burgers University Medical Center, South Wing, second floor"
],
"description": "Second floor of the Old South Wing, formerly in use by Psychiatry",
"mode": "instance",
"telecom": [
{
"system": "phone",
"value": "2328",
"use": "work"
},
{
"system": "fax",
"value": "2329",
"use": "work"
},
{
"system": "email",
"value": "second wing admissions"
},
{
"system": "url",
"value": "http://sampleorg.com/southwing",
"use": "work"
}
],
"address": {
"use": "work",
"line": [
"Galapagosweg 91, Building A"
],
"city": "Den Burg",
"postalCode": "9105 PZ",
"country": "NLD"
},
"physicalType": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
"code": "wi",
"display": "Wing"
}
]
},
"position": {
"longitude": -83.6945691,
"latitude": 42.25475478,
"altitude": 0
},
"managingOrganization": {
"reference": "Organization/f001"
},
"endpoint": [
{
"reference": "Endpoint/example"
}
]
}
Example #4
Input CSV
Location,1,"ph","active",,,,,,"Patient's Home","Patient's Home","kind",,,,,,,,,,,,"http://terminology.hl7.org/CodeSystem/location-physical-type",,"ho","House",,,,,,"Organization/f001",,,,,,,,,,,,,,,,,,,,,,,,,,,,
type,"http://terminology.hl7.org/CodeSystem/v3-RoleCode",,"PTRES","Patient's Residence",,
Resulting resource
{
"resourceType": "Location",
"id": "ph",
"status": "active",
"name": "Patient's Home",
"description": "Patient's Home",
"mode": "kind",
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "PTRES",
"display": "Patient's Residence"
}
]
}
],
"physicalType": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
"code": "ho",
"display": "House"
}
]
},
"managingOrganization": {
"reference": "Organization/f001"
}
}
Example #5
Input CSV
Location,5,"2","suspended","http://terminology.hl7.org/CodeSystem/v2-0116",,"H","Housekeeping",,"South Wing Neuro OR 1","Old South Wing, Neuro Radiology Operation Room 1 on second floor","instance",,,,,,,,,,,,"http://terminology.hl7.org/CodeSystem/location-physical-type",,"ro","Room",,,,,,"Organization/f001",,,,,,,,,,,,,,"Location/1",,,,,,,,,,,,,,
identifier,,,,,,,,,"B1-S.F2.1.00",,
alias,"South Wing OR 5"
alias,"Main Wing OR 2"
type,"http://terminology.hl7.org/CodeSystem/v3-RoleCode",,"RNEU","Neuroradiology unit",,
telecom,"phone","2329",,,,
Resulting resource
{
"resourceType": "Location",
"id": "2",
"identifier": [
{
"value": "B1-S.F2.1.00"
}
],
"status": "suspended",
"operationalStatus": {
"system": "http://terminology.hl7.org/CodeSystem/v2-0116",
"code": "H",
"display": "Housekeeping"
},
"name": "South Wing Neuro OR 1",
"alias": [
"South Wing OR 5",
"Main Wing OR 2"
],
"description": "Old South Wing, Neuro Radiology Operation Room 1 on second floor",
"mode": "instance",
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "RNEU",
"display": "Neuroradiology unit"
}
]
}
],
"telecom": [
{
"system": "phone",
"value": "2329"
}
],
"physicalType": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
"code": "ro",
"display": "Room"
}
]
},
"managingOrganization": {
"reference": "Organization/f001"
},
"partOf": {
"reference": "Location/1"
}
}