UK Core Implementation Guide 0.4.0 - STU1

StructureDefinition-UKCore-Location

Defines the UK Core constraints and extensions on the Location resource for the minimal set of data to query and retrieve location information.

Profile Purpose

This profile can be used to exchange details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. The location includes both incidental locations (a place which is used for healthcare without prior designation or authorisation) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages.

Snapshot View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!0..1codeBinding
operationalStatusΣ0..1CodingBinding
nameΣ0..1string
alias0..*string
descriptionΣ0..1string
modeΣ0..1codeBinding
typeΣ0..*CodeableConceptBinding
telecomI0..*ContactPoint
address0..1Address
physicalTypeΣ0..1CodeableConcept
longitude1..1decimal
latitude1..1decimal
altitude0..1decimal
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
daysOfWeek0..*codeBinding
allDay0..1boolean
openingTime0..1time
closingTime0..1time
availabilityExceptions0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string

Differential View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!0..1codeBinding
operationalStatusΣ0..1CodingBinding
nameΣ0..1string
alias0..*string
descriptionΣ0..1string
modeΣ0..1codeBinding
typeΣ0..*CodeableConceptBinding
telecomI0..*ContactPoint
address0..1Address
physicalTypeΣ0..1CodeableConcept
longitude1..1decimal
latitude1..1decimal
altitude0..1decimal
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
daysOfWeek0..*codeBinding
allDay0..1boolean
openingTime0..1time
closingTime0..1time
availabilityExceptions0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string

Hybrid View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!0..1codeBinding
operationalStatusΣ0..1CodingBinding
nameΣ0..1string
alias0..*string
descriptionΣ0..1string
modeΣ0..1codeBinding
typeΣ0..*CodeableConceptBinding
telecomI0..*ContactPoint
address0..1Address
physicalTypeΣ0..1CodeableConcept
longitude1..1decimal
latitude1..1decimal
altitude0..1decimal
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
daysOfWeek0..*codeBinding
allDay0..1boolean
openingTime0..1time
closingTime0..1time
availabilityExceptions0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string

Table View

Location..
Location.identifier..
Location.identifier..1
Location.identifier.system1..
Location.identifier.value1..
Location.identifier.assignerReference(UK Core Organization)..
Location.managingOrganizationReference(UK Core Organization)..
Location.managingOrganization.identifier..
Location.managingOrganization.identifier.assignerReference(UK Core Organization)..
Location.partOfReference(UK Core Location)..
Location.partOf.identifier..
Location.partOf.identifier.assignerReference(UK Core Organization)..
Location.endpoint..
Location.endpoint.identifier..
Location.endpoint.identifier.assignerReference(UK Core Organization)..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Location" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" />
    <version value="2.1.0" />
    <name value="UKCoreLocation" />
    <title value="UK Core Location" />
    <status value="active" />
    <date value="2021-09-10" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="secretariat@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <contact>
        <name value="NHS Digital" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="2" />
        </telecom>
    </contact>
    <description value="Defines the UK Core constraints and extensions on the Location resource for the minimal set of data to query and retrieve location information." />
    <purpose value="This profile can be used to exchange details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.\nA location includes both incidental locations (a place which is used for healthcare without prior designation or authorisation) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="Location" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Location" />
    <derivation value="constraint" />
    <differential>
        <element id="Location.identifier">
            <path value="Location.identifier" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="system" />
                </discriminator>
                <rules value="open" />
            </slicing>
        </element>
        <element id="Location.identifier:odsSiteCode">
            <path value="Location.identifier" />
            <sliceName value="odsSiteCode" />
            <short value="ODS Site code to identify the organisation at site level" />
            <definition value="ODS Site code to identify the organisation at site level." />
            <max value="1" />
        </element>
        <element id="Location.identifier:odsSiteCode.system">
            <path value="Location.identifier.system" />
            <short value="ODS Code" />
            <min value="1" />
            <fixedUri value="https://fhir.nhs.uk/Id/ods-site-code" />
        </element>
        <element id="Location.identifier:odsSiteCode.value">
            <path value="Location.identifier.value" />
            <min value="1" />
        </element>
        <element id="Location.identifier:odsSiteCode.assigner">
            <path value="Location.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Location.managingOrganization">
            <path value="Location.managingOrganization" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Location.managingOrganization.identifier.assigner">
            <path value="Location.managingOrganization.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Location.partOf">
            <path value="Location.partOf" />
            <type>
                <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy">
                    <valueBoolean value="true" />
                </extension>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" />
            </type>
        </element>
        <element id="Location.partOf.identifier.assigner">
            <path value="Location.partOf.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Location.endpoint.identifier.assigner">
            <path value="Location.endpoint.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Location",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location",
    "version": "2.1.0",
    "name": "UKCoreLocation",
    "title": "UK Core Location",
    "status": "active",
    "date": "2021-09-10",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "secretariat@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        },
        {
            "name": "NHS Digital",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 2
                }
            ]
        }
    ],
    "description": "Defines the UK Core constraints and extensions on the Location resource for the minimal set of data to query and retrieve location information.",
    "purpose": "This profile can be used to exchange details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.\nA location includes both incidental locations (a place which is used for healthcare without prior designation or authorisation) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Location",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Location",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Location.identifier",
                "path": "Location.identifier",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        }
                    ],
                    "rules": "open"
                }
            },
            {
                "id": "Location.identifier:odsSiteCode",
                "path": "Location.identifier",
                "sliceName": "odsSiteCode",
                "short": "ODS Site code to identify the organisation at site level",
                "definition": "ODS Site code to identify the organisation at site level.",
                "max": "1"
            },
            {
                "id": "Location.identifier:odsSiteCode.system",
                "path": "Location.identifier.system",
                "short": "ODS Code",
                "min": 1,
                "fixedUri": "https://fhir.nhs.uk/Id/ods-site-code"
            },
            {
                "id": "Location.identifier:odsSiteCode.value",
                "path": "Location.identifier.value",
                "min": 1
            },
            {
                "id": "Location.identifier:odsSiteCode.assigner",
                "path": "Location.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Location.managingOrganization",
                "path": "Location.managingOrganization",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Location.managingOrganization.identifier.assigner",
                "path": "Location.managingOrganization.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Location.partOf",
                "path": "Location.partOf",
                "type":  [
                    {
                        "extension":  [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
                                "valueBoolean": true
                            }
                        ],
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location"
                        ]
                    }
                ]
            },
            {
                "id": "Location.partOf.identifier.assigner",
                "path": "Location.partOf.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Location.endpoint.identifier.assigner",
                "path": "Location.endpoint.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            }
        ]
    }
}

Examples

SJUH Location - An example to illustrate a Cardiology department in a hospital
Example UKCore-Location-SJUH
General Practice Nurse Clinic location - An example to illustrate a General Practice Nurse Clinic
Example UKCore-Location-GeneralPracticeNurseClinic

Example Usage Scenarios

The following are example usage scenarios for the UK Core Location profile:

  • To describe care locations such as hospital wards
  • To describe locations where patient care has or may take place, including scenes of accidents like by the side of a road.

Profile specific implementation guidance:

Minimal Viable Content

As a minimum either a Location.identifier or Location.name should be provided.

All other elements are optional.


identifier

The identifier is the most important element of a FHIR resource for interoperability. It acts as the externally facing unique business identifier for the resource. A key phrase from the FHIR R4 standard is;

[for identifier] ...All resources that have an identifier element support searching by the identifier, so that records can be located by that method.

Provider Systems

It is recommended that the identifier value is odsSiteCode, but another identifier can be used.

Consumer Systems

Consumer systems MUST consume this data.

The ODS site code for the location

Location.identifier:odsSiteCode.use usual | official | temp | secondary | old (If known) Location.identifier:odsSiteCode.type This is not required with ODS Location.identifier:odsSiteCode.system The url is https://fhir.nhs.uk/Id/ods-site-code Location.identifier:odsSiteCode.value The ODS site code Location.identifier:odsSiteCode.period The period for which the code is valid - May be omitted Location.identifier:odsSiteCode.assigner Implicit for ODS site codes - Should be omitted


status

The general availability of the location.

This element is optional but if used must use a value from the codeSystem below:

HTML View

This code system http://hl7.org/fhir/location-status defines the following codes:

CodeDisplayDefinition
activeActiveThe location is operational.
suspendedSuspendedThe location is temporarily closed.
inactiveInactiveThe location is no longer used.

Table View

CodeSystem.id[0]location-status
CodeSystem.meta[0].lastUpdated[0]2019-11-01T09:29:23.356+11:00
CodeSystem.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].valueCode[0]pa
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].valueCode[0]trial-use
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].valueInteger[0]3
CodeSystem.url[0]http://hl7.org/fhir/location-status
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.333
CodeSystem.version[0]4.0.1
CodeSystem.name[0]LocationStatus
CodeSystem.title[0]LocationStatus
CodeSystem.status[0]draft
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.publisher[0]HL7 (FHIR Project)
CodeSystem.contact[0].telecom[0].system[0]url
CodeSystem.contact[0].telecom[0].value[0]http://hl7.org/fhir
CodeSystem.contact[0].telecom[1].system[0]email
CodeSystem.contact[0].telecom[1].value[0]fhir@lists.hl7.org
CodeSystem.description[0]Indicates whether the location is still in use.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/location-status
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]active
CodeSystem.concept[0].display[0]Active
CodeSystem.concept[0].definition[0]The location is operational.
CodeSystem.concept[1].code[0]suspended
CodeSystem.concept[1].display[0]Suspended
CodeSystem.concept[1].definition[0]The location is temporarily closed.
CodeSystem.concept[2].code[0]inactive
CodeSystem.concept[2].display[0]Inactive
CodeSystem.concept[2].definition[0]The location is no longer used.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="location-status" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="pa" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="3" />
    </extension>
    <url value="http://hl7.org/fhir/location-status" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.333" />
    </identifier>
    <version value="4.0.1" />
    <name value="LocationStatus" />
    <title value="LocationStatus" />
    <status value="draft" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="HL7 (FHIR Project)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
        <telecom>
            <system value="email" />
            <value value="fhir@lists.hl7.org" />
        </telecom>
    </contact>
    <description value="Indicates whether the location is still in use." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/location-status" />
    <content value="complete" />
    <concept>
        <code value="active" />
        <display value="Active" />
        <definition value="The location is operational." />
    </concept>
    <concept>
        <code value="suspended" />
        <display value="Suspended" />
        <definition value="The location is temporarily closed." />
    </concept>
    <concept>
        <code value="inactive" />
        <display value="Inactive" />
        <definition value="The location is no longer used." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "location-status",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "pa"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "trial-use"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 3
        }
    ],
    "url": "http://hl7.org/fhir/location-status",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.333"
        }
    ],
    "version": "4.0.1",
    "name": "LocationStatus",
    "title": "LocationStatus",
    "status": "draft",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "publisher": "HL7 (FHIR Project)",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                },
                {
                    "system": "email",
                    "value": "fhir@lists.hl7.org"
                }
            ]
        }
    ],
    "description": "Indicates whether the location is still in use.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/location-status",
    "content": "complete",
    "concept":  [
        {
            "code": "active",
            "display": "Active",
            "definition": "The location is operational."
        },
        {
            "code": "suspended",
            "display": "Suspended",
            "definition": "The location is temporarily closed."
        },
        {
            "code": "inactive",
            "display": "Inactive",
            "definition": "The location is no longer used."
        }
    ]
}

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.


operationalStatus

The current operational status of the location (typically only for a bed/room).

This refers to the current operational status of a location not it's general availabity which is represented by Location.status.

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.

This ValueSet has a preferred binding in the FHIR standard and no UK Core alternative is currently used. Implementers may chaose to use an alternative CodeSystem if required by their use case.

HTML View

This code system http://terminology.hl7.org/CodeSystem/v2-0116 defines the following codes:

CodeDisplay
CClosed
HHousekeeping
IIsolated
KContaminated
OOccupied
UUnoccupied

Additional Language Displays

CodeDeutsch (German, de)Nederlands (Dutch, nl)
CNicht verfügbarGesloten
HReinigungOnderhoud
IIsoliertIn isolatie
KKontaminiertBesmet
ObelegtBezet
UFreiNiet-bezet

Table View

CodeSystem.id[0]v2-0116
CodeSystem.meta[0].profile[0]http://hl7.org/fhir/StructureDefinition/shareablecodesystem
CodeSystem.language[0]en
CodeSystem.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[0].valueCode[0]external
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[1].valueInteger[0]0
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[2].valueCode[0]pa
CodeSystem.url[0]http://terminology.hl7.org/CodeSystem/v2-0116
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.18.47
CodeSystem.version[0]2.9
CodeSystem.name[0]v2.0116
CodeSystem.title[0]v2 BED STATUS
CodeSystem.status[0]active
CodeSystem.experimental[0]False
CodeSystem.publisher[0]HL7, Inc
CodeSystem.contact[0].telecom[0].system[0]url
CodeSystem.contact[0].telecom[0].value[0]http://hl7.org
CodeSystem.description[0]FHIR Value set/code system definition for HL7 v2 table 0116 ( BED STATUS)
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]C
CodeSystem.concept[0].display[0]Closed
CodeSystem.concept[0].designation[0].language[0]de
CodeSystem.concept[0].designation[0].use[0].system[0]http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[0].designation[0].use[0].code[0]display
CodeSystem.concept[0].designation[0].value[0]Nicht verfügbar
CodeSystem.concept[0].designation[1].language[0]nl
CodeSystem.concept[0].designation[1].use[0].system[0]http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[0].designation[1].use[0].code[0]display
CodeSystem.concept[0].designation[1].value[0]Gesloten
CodeSystem.concept[1].code[0]H
CodeSystem.concept[1].display[0]Housekeeping
CodeSystem.concept[1].designation[0].language[0]de
CodeSystem.concept[1].designation[0].use[0].system[0]http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[1].designation[0].use[0].code[0]display
CodeSystem.concept[1].designation[0].value[0]Reinigung
CodeSystem.concept[1].designation[1].language[0]nl
CodeSystem.concept[1].designation[1].use[0].system[0]http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[1].designation[1].use[0].code[0]display
CodeSystem.concept[1].designation[1].value[0]Onderhoud
CodeSystem.concept[2].code[0]I
CodeSystem.concept[2].display[0]Isolated
CodeSystem.concept[2].designation[0].language[0]de
CodeSystem.concept[2].designation[0].use[0].system[0]http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[2].designation[0].use[0].code[0]display
CodeSystem.concept[2].designation[0].value[0]Isoliert
CodeSystem.concept[2].designation[1].language[0]nl
CodeSystem.concept[2].designation[1].use[0].system[0]http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[2].designation[1].use[0].code[0]display
CodeSystem.concept[2].designation[1].value[0]In isolatie
CodeSystem.concept[3].code[0]K
CodeSystem.concept[3].display[0]Contaminated
CodeSystem.concept[3].designation[0].language[0]de
CodeSystem.concept[3].designation[0].use[0].system[0]http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[3].designation[0].use[0].code[0]display
CodeSystem.concept[3].designation[0].value[0]Kontaminiert
CodeSystem.concept[3].designation[1].language[0]nl
CodeSystem.concept[3].designation[1].use[0].system[0]http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[3].designation[1].use[0].code[0]display
CodeSystem.concept[3].designation[1].value[0]Besmet
CodeSystem.concept[4].code[0]O
CodeSystem.concept[4].display[0]Occupied
CodeSystem.concept[4].designation[0].language[0]de
CodeSystem.concept[4].designation[0].use[0].system[0]http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[4].designation[0].use[0].code[0]display
CodeSystem.concept[4].designation[0].value[0]belegt
CodeSystem.concept[4].designation[1].language[0]nl
CodeSystem.concept[4].designation[1].use[0].system[0]http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[4].designation[1].use[0].code[0]display
CodeSystem.concept[4].designation[1].value[0]Bezet
CodeSystem.concept[5].code[0]U
CodeSystem.concept[5].display[0]Unoccupied
CodeSystem.concept[5].designation[0].language[0]de
CodeSystem.concept[5].designation[0].use[0].system[0]http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[5].designation[0].use[0].code[0]display
CodeSystem.concept[5].designation[0].value[0]Frei
CodeSystem.concept[5].designation[1].language[0]nl
CodeSystem.concept[5].designation[1].use[0].system[0]http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[5].designation[1].use[0].code[0]display
CodeSystem.concept[5].designation[1].value[0]Niet-bezet

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="v2-0116" />
    <meta>
        <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem" />
    </meta>
    <language value="en" />
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="external" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="0" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="pa" />
    </extension>
    <url value="http://terminology.hl7.org/CodeSystem/v2-0116" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.18.47" />
    </identifier>
    <version value="2.9" />
    <name value="v2.0116" />
    <title value="v2 BED STATUS" />
    <status value="active" />
    <experimental value="false" />
    <publisher value="HL7, Inc" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org" />
        </telecom>
    </contact>
    <description value="FHIR Value set/code system definition for HL7 v2 table 0116 ( BED STATUS)" />
    <content value="complete" />
    <concept>
        <code value="C" />
        <display value="Closed" />
        <designation>
            <language value="de" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Nicht verf&#252;gbar" />
        </designation>
        <designation>
            <language value="nl" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Gesloten" />
        </designation>
    </concept>
    <concept>
        <code value="H" />
        <display value="Housekeeping" />
        <designation>
            <language value="de" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Reinigung" />
        </designation>
        <designation>
            <language value="nl" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Onderhoud" />
        </designation>
    </concept>
    <concept>
        <code value="I" />
        <display value="Isolated" />
        <designation>
            <language value="de" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Isoliert" />
        </designation>
        <designation>
            <language value="nl" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="In isolatie" />
        </designation>
    </concept>
    <concept>
        <code value="K" />
        <display value="Contaminated" />
        <designation>
            <language value="de" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Kontaminiert" />
        </designation>
        <designation>
            <language value="nl" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Besmet" />
        </designation>
    </concept>
    <concept>
        <code value="O" />
        <display value="Occupied" />
        <designation>
            <language value="de" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="belegt" />
        </designation>
        <designation>
            <language value="nl" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Bezet" />
        </designation>
    </concept>
    <concept>
        <code value="U" />
        <display value="Unoccupied" />
        <designation>
            <language value="de" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Frei" />
        </designation>
        <designation>
            <language value="nl" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Niet-bezet" />
        </designation>
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "v2-0116",
    "meta": {
        "profile":  [
            "http://hl7.org/fhir/StructureDefinition/shareablecodesystem"
        ]
    },
    "language": "en",
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "external"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 0
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "pa"
        }
    ],
    "url": "http://terminology.hl7.org/CodeSystem/v2-0116",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.18.47"
        }
    ],
    "version": "2.9",
    "name": "v2.0116",
    "title": "v2 BED STATUS",
    "status": "active",
    "experimental": false,
    "publisher": "HL7, Inc",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org"
                }
            ]
        }
    ],
    "description": "FHIR Value set/code system definition for HL7 v2 table 0116 ( BED STATUS)",
    "content": "complete",
    "concept":  [
        {
            "code": "C",
            "display": "Closed",
            "designation":  [
                {
                    "language": "de",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Nicht verfügbar"
                },
                {
                    "language": "nl",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Gesloten"
                }
            ]
        },
        {
            "code": "H",
            "display": "Housekeeping",
            "designation":  [
                {
                    "language": "de",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Reinigung"
                },
                {
                    "language": "nl",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Onderhoud"
                }
            ]
        },
        {
            "code": "I",
            "display": "Isolated",
            "designation":  [
                {
                    "language": "de",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Isoliert"
                },
                {
                    "language": "nl",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "In isolatie"
                }
            ]
        },
        {
            "code": "K",
            "display": "Contaminated",
            "designation":  [
                {
                    "language": "de",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Kontaminiert"
                },
                {
                    "language": "nl",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Besmet"
                }
            ]
        },
        {
            "code": "O",
            "display": "Occupied",
            "designation":  [
                {
                    "language": "de",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "belegt"
                },
                {
                    "language": "nl",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Bezet"
                }
            ]
        },
        {
            "code": "U",
            "display": "Unoccupied",
            "designation":  [
                {
                    "language": "de",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Frei"
                },
                {
                    "language": "nl",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Niet-bezet"
                }
            ]
        }
    ]
}


name

The name of the location.


alias

Alternative names for the location


description

Additional details about the location that could be displayed as further information to identify the location beyond its name.


mode

The Location.mode element can be used to indicate whether a Location resource represents a specific (potentially identifiable) Location (instance), or a class of Locations (kind). Especially Resources capturing orders, resource scheduling, plans and definitions may refer to Locations in kind mode. For these domains, it is often not necessary to refer to a specific Location, but rather to a class of Locations. An example of this is found in planning, where we need to allocate an "isolation room" for a patient, or need to dispatch "an ambulance" at a certain time. In these cases it is not important exactly which isolation room or ambulance is allocated, and it is sufficient to just indicate a kind of Location.

Note that kind should not be used to represent Locations where an actual instance of a Location was involved, but identifying information is missing. E.g. when a patient arrived 'by ambulance', but it is not known by which ambulance, this should be represented using a Location in instance mode with a missing identifier, not a Location of kind ambulance.

Some of Location's data elements are only relevant when mode is instance and should not be used when mode is kind: (however this information could still be included if was relevant, such as when it is a generic item, but not globally generic, e.g. a Burgers MU ambulance).


type

Indicates the type of function performed at the location.


telecom

A contact detail (e.g. a telephone number or an email address) by which the location may be contacted.

telecom uses the ContactPoint datatype.


address

The address of the location using the Address datatype.


physicalType

The physical type of the location. e.g. Bed, ward, building from this set of codes.

This element has an example binding to a HL7 ValueSet. No UKCore ValueSet is currently defined and therefore implementers are free to use either HL7 ValueSet or an alternative if they wish to do so. If deemed a requirement future releases will address this by defining an appropriate UK Core ValueSet.

HTML View

This code system http://terminology.hl7.org/CodeSystem/location-physical-type defines the following codes:

CodeDisplayDefinition
siSiteA collection of buildings or other locations such as a site or a campus.
buBuildingAny Building or structure. This may contain rooms, corridors, wings, etc. It might not have walls, or a roof, but is considered a defined/allocated space.
wiWingA Wing within a Building, this often contains levels, rooms and corridors.
waWardA Ward is a section of a medical facility that may contain rooms and other types of location.
lvlLevelA Level in a multi-level Building/Structure.
coCorridorAny corridor within a Building, that may connect rooms.
roRoomA space that is allocated as a room, it may have walls/roof etc., but does not require these.
bdBedA space that is allocated for sleeping/laying on. This is not the physical bed/trolley that may be moved about, but the space it may occupy.
veVehicleA means of transportation.
hoHouseA residential dwelling. Usually used to reference a location that a person/patient may reside.
caCabinetA container that can store goods, equipment, medications or other items.
rdRoadA defined path to travel between 2 points that has a known name.
areaAreaA defined physical boundary of something, such as a flood risk zone, region, postcode
jdnJurisdictionA wide scope that covers a conceptual domain, such as a Nation (Country wide community or Federal Government - e.g. Ministry of Health), Province or State (community or Government), Business (throughout the enterprise), Nation with a business scope of an agency (e.g. CDC, FDA etc.) or a Business segment (UK Pharmacy), not just an physical boundary

Table View

CodeSystem.id[0]location-physical-type
CodeSystem.meta[0].lastUpdated[0]2019-11-01T09:29:23.356+11:00
CodeSystem.meta[0].profile[0]http://hl7.org/fhir/StructureDefinition/shareablecodesystem
CodeSystem.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].valueCode[0]pa
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].valueCode[0]draft
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].valueInteger[0]1
CodeSystem.url[0]http://terminology.hl7.org/CodeSystem/location-physical-type
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.1108
CodeSystem.version[0]4.0.1
CodeSystem.name[0]LocationType
CodeSystem.title[0]Location type
CodeSystem.status[0]draft
CodeSystem.experimental[0]False
CodeSystem.publisher[0]FHIR Project team
CodeSystem.contact[0].telecom[0].system[0]url
CodeSystem.contact[0].telecom[0].value[0]http://hl7.org/fhir
CodeSystem.description[0]This example value set defines a set of codes that can be used to indicate the physical form of the Location.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/location-physical-type
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]si
CodeSystem.concept[0].display[0]Site
CodeSystem.concept[0].definition[0]A collection of buildings or other locations such as a site or a campus.
CodeSystem.concept[1].code[0]bu
CodeSystem.concept[1].display[0]Building
CodeSystem.concept[1].definition[0]Any Building or structure. This may contain rooms, corridors, wings, etc. It might not have walls, or a roof, but is considered a defined/allocated space.
CodeSystem.concept[2].code[0]wi
CodeSystem.concept[2].display[0]Wing
CodeSystem.concept[2].definition[0]A Wing within a Building, this often contains levels, rooms and corridors.
CodeSystem.concept[3].code[0]wa
CodeSystem.concept[3].display[0]Ward
CodeSystem.concept[3].definition[0]A Ward is a section of a medical facility that may contain rooms and other types of location.
CodeSystem.concept[4].code[0]lvl
CodeSystem.concept[4].display[0]Level
CodeSystem.concept[4].definition[0]A Level in a multi-level Building/Structure.
CodeSystem.concept[5].code[0]co
CodeSystem.concept[5].display[0]Corridor
CodeSystem.concept[5].definition[0]Any corridor within a Building, that may connect rooms.
CodeSystem.concept[6].code[0]ro
CodeSystem.concept[6].display[0]Room
CodeSystem.concept[6].definition[0]A space that is allocated as a room, it may have walls/roof etc., but does not require these.
CodeSystem.concept[7].code[0]bd
CodeSystem.concept[7].display[0]Bed
CodeSystem.concept[7].definition[0]A space that is allocated for sleeping/laying on. This is not the physical bed/trolley that may be moved about, but the space it may occupy.
CodeSystem.concept[8].code[0]ve
CodeSystem.concept[8].display[0]Vehicle
CodeSystem.concept[8].definition[0]A means of transportation.
CodeSystem.concept[9].code[0]ho
CodeSystem.concept[9].display[0]House
CodeSystem.concept[9].definition[0]A residential dwelling. Usually used to reference a location that a person/patient may reside.
CodeSystem.concept[10].code[0]ca
CodeSystem.concept[10].display[0]Cabinet
CodeSystem.concept[10].definition[0]A container that can store goods, equipment, medications or other items.
CodeSystem.concept[11].code[0]rd
CodeSystem.concept[11].display[0]Road
CodeSystem.concept[11].definition[0]A defined path to travel between 2 points that has a known name.
CodeSystem.concept[12].code[0]area
CodeSystem.concept[12].display[0]Area
CodeSystem.concept[12].definition[0]A defined physical boundary of something, such as a flood risk zone, region, postcode
CodeSystem.concept[13].code[0]jdn
CodeSystem.concept[13].display[0]Jurisdiction
CodeSystem.concept[13].definition[0]A wide scope that covers a conceptual domain, such as a Nation (Country wide community or Federal Government - e.g. Ministry of Health), Province or State (community or Government), Business (throughout the enterprise), Nation with a business scope of an agency (e.g. CDC, FDA etc.) or a Business segment (UK Pharmacy), not just an physical boundary

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="location-physical-type" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
        <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="pa" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="draft" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="1" />
    </extension>
    <url value="http://terminology.hl7.org/CodeSystem/location-physical-type" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.1108" />
    </identifier>
    <version value="4.0.1" />
    <name value="LocationType" />
    <title value="Location type" />
    <status value="draft" />
    <experimental value="false" />
    <publisher value="FHIR Project team" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
    </contact>
    <description value="This example value set defines a set of codes that can be used to indicate the physical form of the Location." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/location-physical-type" />
    <content value="complete" />
    <concept>
        <code value="si" />
        <display value="Site" />
        <definition value="A collection of buildings or other locations such as a site or a campus." />
    </concept>
    <concept>
        <code value="bu" />
        <display value="Building" />
        <definition value="Any Building or structure. This may contain rooms, corridors, wings, etc. It might not have walls, or a roof, but is considered a defined/allocated space." />
    </concept>
    <concept>
        <code value="wi" />
        <display value="Wing" />
        <definition value="A Wing within a Building, this often contains levels, rooms and corridors." />
    </concept>
    <concept>
        <code value="wa" />
        <display value="Ward" />
        <definition value="A Ward is a section of a medical facility that may contain rooms and other types of location." />
    </concept>
    <concept>
        <code value="lvl" />
        <display value="Level" />
        <definition value="A Level in a multi-level Building/Structure." />
    </concept>
    <concept>
        <code value="co" />
        <display value="Corridor" />
        <definition value="Any corridor within a Building, that may connect rooms." />
    </concept>
    <concept>
        <code value="ro" />
        <display value="Room" />
        <definition value="A space that is allocated as a room, it may have walls/roof etc., but does not require these." />
    </concept>
    <concept>
        <code value="bd" />
        <display value="Bed" />
        <definition value="A space that is allocated for sleeping/laying on. This is not the physical bed/trolley that may be moved about, but the space it may occupy." />
    </concept>
    <concept>
        <code value="ve" />
        <display value="Vehicle" />
        <definition value="A means of transportation." />
    </concept>
    <concept>
        <code value="ho" />
        <display value="House" />
        <definition value="A residential dwelling. Usually used to reference a location that a person/patient may reside." />
    </concept>
    <concept>
        <code value="ca" />
        <display value="Cabinet" />
        <definition value="A container that can store goods, equipment, medications or other items." />
    </concept>
    <concept>
        <code value="rd" />
        <display value="Road" />
        <definition value="A defined path to travel between 2 points that has a known name." />
    </concept>
    <concept>
        <code value="area" />
        <display value="Area" />
        <definition value="A defined physical boundary of something, such as a flood risk zone, region, postcode" />
    </concept>
    <concept>
        <code value="jdn" />
        <display value="Jurisdiction" />
        <definition value="A wide scope that covers a conceptual domain, such as a Nation (Country wide community or Federal Government - e.g. Ministry of Health),  Province or State (community or Government), Business (throughout the enterprise), Nation with a business scope of an agency (e.g. CDC, FDA etc.) or a Business segment (UK Pharmacy), not just an physical boundary" />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "location-physical-type",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00",
        "profile":  [
            "http://hl7.org/fhir/StructureDefinition/shareablecodesystem"
        ]
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "pa"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "draft"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 1
        }
    ],
    "url": "http://terminology.hl7.org/CodeSystem/location-physical-type",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.1108"
        }
    ],
    "version": "4.0.1",
    "name": "LocationType",
    "title": "Location type",
    "status": "draft",
    "experimental": false,
    "publisher": "FHIR Project team",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                }
            ]
        }
    ],
    "description": "This example value set defines a set of codes that can be used to indicate the physical form of the Location.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/location-physical-type",
    "content": "complete",
    "concept":  [
        {
            "code": "si",
            "display": "Site",
            "definition": "A collection of buildings or other locations such as a site or a campus."
        },
        {
            "code": "bu",
            "display": "Building",
            "definition": "Any Building or structure. This may contain rooms, corridors, wings, etc. It might not have walls, or a roof, but is considered a defined/allocated space."
        },
        {
            "code": "wi",
            "display": "Wing",
            "definition": "A Wing within a Building, this often contains levels, rooms and corridors."
        },
        {
            "code": "wa",
            "display": "Ward",
            "definition": "A Ward is a section of a medical facility that may contain rooms and other types of location."
        },
        {
            "code": "lvl",
            "display": "Level",
            "definition": "A Level in a multi-level Building/Structure."
        },
        {
            "code": "co",
            "display": "Corridor",
            "definition": "Any corridor within a Building, that may connect rooms."
        },
        {
            "code": "ro",
            "display": "Room",
            "definition": "A space that is allocated as a room, it may have walls/roof etc., but does not require these."
        },
        {
            "code": "bd",
            "display": "Bed",
            "definition": "A space that is allocated for sleeping/laying on. This is not the physical bed/trolley that may be moved about, but the space it may occupy."
        },
        {
            "code": "ve",
            "display": "Vehicle",
            "definition": "A means of transportation."
        },
        {
            "code": "ho",
            "display": "House",
            "definition": "A residential dwelling. Usually used to reference a location that a person/patient may reside."
        },
        {
            "code": "ca",
            "display": "Cabinet",
            "definition": "A container that can store goods, equipment, medications or other items."
        },
        {
            "code": "rd",
            "display": "Road",
            "definition": "A defined path to travel between 2 points that has a known name."
        },
        {
            "code": "area",
            "display": "Area",
            "definition": "A defined physical boundary of something, such as a flood risk zone, region, postcode"
        },
        {
            "code": "jdn",
            "display": "Jurisdiction",
            "definition": "A wide scope that covers a conceptual domain, such as a Nation (Country wide community or Federal Government - e.g. Ministry of Health),  Province or State (community or Government), Business (throughout the enterprise), Nation with a business scope of an agency (e.g. CDC, FDA etc.) or a Business segment (UK Pharmacy), not just an physical boundary"
        }
    ]
}

position

The absolute geographic location of the Location, expressed using the WGS84 datum

e.g.

  • Location.position.longitude -1.530941
  • Location.position.latitude 53.798135
  • Location.position.altitude 55 (metres above mean sea level - optional).

managingOrganization

The organization responsible for the provisioning and upkeep of the location as a reference. The resource being referenced should conform to Profile UKCore-Organization.


partOf

Another Location of which this Location is physically a part of, as a reference. The resource being referenced should conform to Profile UKCore-Location.


hoursOfOperation

What days/times during a week is this location usually open.

Opening times can be specified as the opening and closing times for each day of the week. Where a location is open 24 hours opening and closing times should not be specified and Location.hoursOfOperation.allDay should be set to true.


availabilityExceptions

A description, as a text string, of when the locations opening hours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in hoursOfOperation.

e.g. "closed bank holidays".


endpoint

Technical endpoints providing access to services operated for the organization. The resource being referenced must conform to the FHIR Endpoint resource

Can be used to define multiple technical endpoints.


back to top