The Location resource provides information and details on the physical location and the services provided.
Name | Card. | Type | Description & Constraints |
---|---|---|---|
Location | Location | Details and position information for a physical place | |
id | 0..1 | Id | Logical id of this artifact |
meta | 0..1 | Meta | Metadata about the resource |
implicitRules | 0..1 | Uri | A set of rules under which this content was created |
language | 0..1 | Code | Language of the resource content Binding A human language. (http://tools.ietf.org/html/bcp47) Binding Strength Required |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources |
identifier | Unique code or number identifying the location to its users Slice: Ordering: Unordered, Discriminator: system, Rules: Open at End | ||
identifier (ODS Site Code) | 0..1 | Identifier | ODS Site code to identify the organisation at site level |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
system | 1..1 | Uri | ODS Code Fixed Value https://fhir.nhs.uk/Id/ods-site-code |
value | 1..1 | String | The ODS Site code name, to reflect the code used Example Value 123456 |
identifier (localIdentifier) | 0..1 | Identifier | Unique code or number identifying the location to its users |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
use | 0..1 | Code | usual | official | temp | secondary (If known) Binding Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/ValueSet/identifier-use) Binding Strength Required |
type | 0..1 | CodeableConcept | Description of identifier Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type) Binding Strength Extensible |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
coding | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
system | 0..1 | Uri | Identity of the terminology system |
version | 0..1 | String | Version of the system - if relevant |
code | 0..1 | Code | Symbol in syntax defined by the system |
display | 0..1 | String | Representation defined by the system |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
system | 1..1 | Uri | The namespace for the identifier Fixed Value https://fhir.nhs.uk/Id/local-location-identifier |
value | 1..1 | String | The Local Location Identifier code name, to reflect the code used Example Value 123456 |
period | 0..1 | Period | Time period when id is/was valid for use |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
start | 0..1 | DateTime | Starting time with inclusive boundary |
end | 0..1 | DateTime | End time with inclusive boundary, if not ongoing |
assigner | 0..1 | Reference (CareConnect-Organization-1) | Organization that issued id (may be just text) |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
reference | 0..1 | String | Relative, internal or absolute URL reference |
display | 0..1 | String | Text alternative for the resource |
status | 0..1 | Code | active | suspended | inactive Binding Indicates whether the location is still in use. (http://hl7.org/fhir/ValueSet/location-status) Binding Strength Required |
name | 0..1 | String | Name of the location as used by humans |
description | 0..1 | String | Description of the location |
mode | 0..1 | Code | instance | kind Binding Indicates whether a resource instance represents a specific location or a class of locations. (http://hl7.org/fhir/ValueSet/location-mode) Binding Strength Required |
type | 0..1 | CodeableConcept | Type of function performed Binding Indicates the type of function performed at the location. (http://hl7.org/fhir/ValueSet/v3-ServiceDeliveryLocationRoleType) Binding Strength Extensible |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
coding | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
system | 0..1 | Uri | Identity of the terminology system |
version | 0..1 | String | Version of the system - if relevant |
code | 0..1 | Code | Symbol in syntax defined by the system |
display | 0..1 | String | Representation defined by the system |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
telecom | 0..* | ContactPoint | Contact details of the location |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
system | 0..1 | Code | phone | fax | email | pager | other Binding Telecommunications form for contact point (http://hl7.org/fhir/ValueSet/contact-point-system) Binding Strength Required |
value | 0..1 | String | The actual contact point details |
use | 0..1 | Code | home | work | temp | old | mobile - purpose of this contact point Binding Use of contact point (http://hl7.org/fhir/ValueSet/contact-point-use) Binding Strength Required |
rank | 0..1 | PositiveInt | Specify preferred order of use (1 = highest) |
period | 0..1 | Period | Time period when the contact point was/is in use |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
start | 0..1 | DateTime | Starting time with inclusive boundary |
end | 0..1 | DateTime | End time with inclusive boundary, if not ongoing |
address | 0..1 | Address | Physical location |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
use | 0..1 | Code | home | work | temp | old - purpose of this address Binding The use of an address (http://hl7.org/fhir/ValueSet/address-use) Binding Strength Required Example Value work |
type | 0..1 | Code | postal | physical | both Binding The type of an address (physical / postal) (http://hl7.org/fhir/ValueSet/address-type) Binding Strength Required Example Value both |
text | 0..1 | String | Text representation of the address Example Value Denmark Hill, London, SE5 9RS |
line | 0..* | String | Street name, number, direction & P.O. Box etc. Example Value Denmark Hill |
city | 0..1 | String | Name of city, town etc. Example Value London |
district | 0..1 | String | District name (aka county) Example Value |
postalCode | 0..1 | String | Postal code for area Example Value SE5 9RS |
country | 0..1 | String | Country (can be ISO 3166 3 letter code) Example Value GBR |
period | 0..1 | Period | Time period when address was/is in use Example Value Hl7.Fhir.Model.Period |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
start | 0..1 | DateTime | Starting time with inclusive boundary |
end | 0..1 | DateTime | End time with inclusive boundary, if not ongoing |
physicalType | 0..1 | CodeableConcept | Physical form of the location Binding Physical form of the location (http://hl7.org/fhir/ValueSet/location-physical-type) Binding Strength Example |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
coding | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
system | 0..1 | Uri | Identity of the terminology system |
version | 0..1 | String | Version of the system - if relevant |
code | 0..1 | Code | Symbol in syntax defined by the system |
display | 0..1 | String | Representation defined by the system |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
position | 0..1 | BackboneElement | The absolute geographic location |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
longitude | 1..1 | Decimal | Longitude with WGS84 datum |
latitude | 1..1 | Decimal | Latitude with WGS84 datum |
altitude | 0..1 | Decimal | Altitude with WGS84 datum |
managingOrganization | 0..1 | Reference (CareConnect-Organization-1) | Organization responsible for provisioning and upkeep |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
reference | 0..1 | String | Relative, internal or absolute URL reference |
display | 0..1 | String | Text alternative for the resource |
partOf | 0..1 | Reference (CareConnect-Location-1) | Another Location this one is physically part of |
id | 0..1 | Id | xml:id (or equivalent in JSON) |
reference | 0..1 | String | Relative, internal or absolute URL reference |
display | 0..1 | String | Text alternative for the resource |
Path | Name | Binding Strength | ValueSet |
---|---|---|---|
Location.language | language | Required | http://tools.ietf.org/html/bcp47 |
Location.identifier.use | use | Required | http://hl7.org/fhir/ValueSet/identifier-use |
Location.identifier.type | type | Extensible | http://hl7.org/fhir/ValueSet/identifier-type |
Location.status | status | Required | http://hl7.org/fhir/ValueSet/location-status |
Location.mode | mode | Required | http://hl7.org/fhir/ValueSet/location-mode |
Location.type | type | Extensible | http://hl7.org/fhir/ValueSet/v3-ServiceDeliveryLocationRoleType |
Location.telecom.system | system | Required | http://hl7.org/fhir/ValueSet/contact-point-system |
Location.telecom.use | use | Required | http://hl7.org/fhir/ValueSet/contact-point-use |
Location.address.use | use | Required | http://hl7.org/fhir/ValueSet/address-use |
Location.address.type | type | Required | http://hl7.org/fhir/ValueSet/address-type |
Location.physicalType | physicalType | Example | http://hl7.org/fhir/ValueSet/location-physical-type |