Profile EEBaseLocation


Profile Purpose

Location resource gives details and position information of a physical place where services are provided, and also where resources and participants may be stored, found, contained or accomodated.

Example Usage Scenarios

  • Query for locations general availability using the query parameter Location.status
  • Query for locations based on type of functions performed using the query parameter Location.type
  • Exchange Location information within a FHIR document or message

Snapshot View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
statusΣ ?!0..1codeBinding
operationalStatusΣ0..1CodingBinding
nameΣ0..1string
alias0..*string
descriptionΣ0..1string
modeΣ0..1codeBinding
typeΣ0..*CodeableConceptBinding
telecomI0..*ContactPoint
address0..1EEBase Address
physicalTypeΣ0..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
longitude1..1decimal
latitude1..1decimal
altitude0..1decimal
managingOrganizationΣ I0..1Reference(EEBase Organization)
partOfI0..1Reference(EEBase Location)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
daysOfWeek0..*codeBinding
allDay0..1boolean
openingTime0..1time
closingTime0..1time
availabilityExceptions0..1string
endpointI0..*Reference(Endpoint)

Differential View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
statusΣ ?!0..1codeBinding
operationalStatusΣ0..1CodingBinding
nameΣ0..1string
alias0..*string
descriptionΣ0..1string
modeΣ0..1codeBinding
typeΣ0..*CodeableConceptBinding
telecomI0..*ContactPoint
address0..1EEBase Address
physicalTypeΣ0..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
longitude1..1decimal
latitude1..1decimal
altitude0..1decimal
managingOrganizationΣ I0..1Reference(EEBase Organization)
partOfI0..1Reference(EEBase Location)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
daysOfWeek0..*codeBinding
allDay0..1boolean
openingTime0..1time
closingTime0..1time
availabilityExceptions0..1string
endpointI0..*Reference(Endpoint)

Hybrid View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
statusΣ ?!0..1codeBinding
operationalStatusΣ0..1CodingBinding
nameΣ0..1string
alias0..*string
descriptionΣ0..1string
modeΣ0..1codeBinding
typeΣ0..*CodeableConceptBinding
telecomI0..*ContactPoint
address0..1EEBase Address
physicalTypeΣ0..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
longitude1..1decimal
latitude1..1decimal
altitude0..1decimal
managingOrganizationΣ I0..1Reference(EEBase Organization)
partOfI0..1Reference(EEBase Location)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
daysOfWeek0..*codeBinding
allDay0..1boolean
openingTime0..1time
closingTime0..1time
availabilityExceptions0..1string
endpointI0..*Reference(Endpoint)

Table View

Location..
Location.addressEEBase Address..
Location.physicalType..
Location.managingOrganizationReference(EEBase Organization)..
Location.partOfReference(EEBase Location)..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="EEBase-Location" />
    <url value="https://hl7.ee/fhir/StructureDefinition/EEBase-Location" />
    <version value="1.0.0" />
    <name value="EEBaseLocation" />
    <title value="EEBase Location" />
    <status value="draft" />
    <date value="2022-11-21T13:50:44.2322254+00:00" />
    <publisher value="HL7 EE" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Location" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Location" />
    <derivation value="constraint" />
    <differential>
        <element id="Location.address">
            <path value="Location.address" />
            <type>
                <code value="Address" />
                <profile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Address" />
            </type>
        </element>
        <element id="Location.physicalType">
            <path value="Location.physicalType" />
            <binding>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
                    <valueString value="PhysicalType" />
                </extension>
                <strength value="preferred" />
            </binding>
        </element>
        <element id="Location.managingOrganization">
            <path value="Location.managingOrganization" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-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://hl7.ee/fhir/StructureDefinition/EEBase-Location" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "EEBase-Location",
    "url": "https://hl7.ee/fhir/StructureDefinition/EEBase-Location",
    "version": "1.0.0",
    "name": "EEBaseLocation",
    "title": "EEBase Location",
    "status": "draft",
    "date": "2022-11-21T13:50:44.2322254+00:00",
    "publisher": "HL7 EE",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Location",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Location",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Location.address",
                "path": "Location.address",
                "type":  [
                    {
                        "code": "Address",
                        "profile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Address"
                        ]
                    }
                ]
            },
            {
                "id": "Location.physicalType",
                "path": "Location.physicalType",
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "PhysicalType"
                        }
                    ],
                    "strength": "preferred"
                }
            },
            {
                "id": "Location.managingOrganization",
                "path": "Location.managingOrganization",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Location.partOf",
                "path": "Location.partOf",
                "type":  [
                    {
                        "extension":  [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
                                "valueBoolean": true
                            }
                        ],
                        "code": "Reference",
                        "targetProfile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Location"
                        ]
                    }
                ]
            }
        ]
    }
}


identifier

Unique code or number to identify the location.


status

Status indicates if the location is generally available. This does not cover momentary availability, which can be described by operationalStatus or by a schedule/slots element if they are configured for the location.

The required ValueSet used in this case is location-status, meaning these values MUST be exchanged. Local value sets SHOULD be mapped to the required ValueSet.

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].value[0]pa
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].value[0]trial-use
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].value[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."
        }
    ]
}


operationalStatus

The operational status of the location. This element is usually used for beds but can also apply to rooms/units etc.

The preferred ValueSet used in this case is hl7VS-bedStatus, meaning these values SHOULD be exchanged, however other ValueSets (either local or developed and published by the community) may be used if required. In that case mapping other ValueSets to hl7VS-bedStatus by using the ConceptMap resource is encouraged.


name

Name of the location, which doesn't have to be unique.


alias

Alternative names of the location. These can also be the names that have been used in the past.


description

Descriptive text of additional details about the location, which makes it easier to find or reference the specific place.


mode

This element indicates whether a resource instance represents a specific location or a class of locations. Class of locations is referred when the resource is used for scheduling or orders.

The required ValueSet used in this case is location-mode, meaning these values MUST be exchanged. Local value sets SHOULD be mapped to the required ValueSet.

HTML View

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

CodeDisplayDefinition
instanceInstanceThe Location resource represents a specific instance of a location (e.g. Operating Theatre 1A).
kindKindThe Location represents a class of locations (e.g. Any Operating Theatre) although this class of locations could be constrained within a specific boundary (such as organization, or parent location, address etc.).

Table View

CodeSystem.id[0]location-mode
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].value[0]pa
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].value[0]trial-use
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].value[0]3
CodeSystem.url[0]http://hl7.org/fhir/location-mode
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.331
CodeSystem.version[0]4.0.1
CodeSystem.name[0]LocationMode
CodeSystem.title[0]LocationMode
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 a resource instance represents a specific location or a class of locations.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/location-mode
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]instance
CodeSystem.concept[0].display[0]Instance
CodeSystem.concept[0].definition[0]The Location resource represents a specific instance of a location (e.g. Operating Theatre 1A).
CodeSystem.concept[1].code[0]kind
CodeSystem.concept[1].display[0]Kind
CodeSystem.concept[1].definition[0]The Location represents a class of locations (e.g. Any Operating Theatre) although this class of locations could be constrained within a specific boundary (such as organization, or parent location, address etc.).

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="location-mode" />
    <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-mode" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.331" />
    </identifier>
    <version value="4.0.1" />
    <name value="LocationMode" />
    <title value="LocationMode" />
    <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 a resource instance represents a specific location or a class of locations." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/location-mode" />
    <content value="complete" />
    <concept>
        <code value="instance" />
        <display value="Instance" />
        <definition value="The Location resource represents a specific instance of a location (e.g. Operating Theatre 1A)." />
    </concept>
    <concept>
        <code value="kind" />
        <display value="Kind" />
        <definition value="The Location represents a class of locations (e.g. Any Operating Theatre) although this class of locations could be constrained within a specific boundary (such as organization, or parent location, address etc.)." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "location-mode",
    "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-mode",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.331"
        }
    ],
    "version": "4.0.1",
    "name": "LocationMode",
    "title": "LocationMode",
    "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 a resource instance represents a specific location or a class of locations.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/location-mode",
    "content": "complete",
    "concept":  [
        {
            "code": "instance",
            "display": "Instance",
            "definition": "The Location resource represents a specific instance of a location (e.g. Operating Theatre 1A)."
        },
        {
            "code": "kind",
            "display": "Kind",
            "definition": "The Location represents a class of locations (e.g. Any Operating Theatre) although this class of locations could be constrained within a specific boundary (such as organization, or parent location, address etc.)."
        }
    ]
}


type

Type indicates a role of a location and what kind of function is performed there.

The ValueSet used in this case is v3.ServiceDeliveryLocationRoleType (Binding Strength = Extended), meaning these values SHOULD be exchanged, however, using additional concepts is allowed if necessary.


telecom

The contact details of available communication devices at the location. These can be phone numbers, fax numbers, mobile numbers, email addresses and web sites.


address

Please note that the Address datatype used by this element has been standardized, see Address profile for more details.
The address of the physical location.

physicalType

Physical form of the location, e.g. building, room, vehicle, road.

Coded value of the physical form of the Location. The preferred ValueSet used in this case is location-physical-type, meaning these values SHOULD be exchanged, however other ValueSets (either local or developed and published by the community) may be used if required. In that case mapping other ValueSets to location-physical-type by using the ConceptMap resource is encouraged.


position

Specifies the absolute geographic location of the Location using the WGS84 standard. Position is expressed by using longitude, latitude and altitude.


managingOrganization

The organization responsible for the location. Element references to EEBaseOrganization.


partOf

Reference to another Location which is physically part of this specific Location.


hoursOfOperation

Specifies what days or times during a week is this location usually open. Some services within the location may have different opening hours than the general location hours. Opening hours can be defined by days of week and by opening/closing time or by stating that the location is open all day.


availabilityExceptions

Descriptive text of opening hours of the location if they differ from the normal availability. For example public holidays.


endpoint

Please note that this data element includes a reference to Endpoint resource which has not been covered (profiled) in this Implementation Guide.
Technical endpoints providing access to services operated for the location.