Data Model Libraries
    Preparing search index...

    Class Location

    Location Class

    Details and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated.

    FHIR Specification

    • Short: Details and position information for a place
    • Definition: Details and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated.
    • FHIR Version: 5.0.0

    FHIR Location

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? locationStatusEnum status? operationalStatus? name? alias? description? locationModeEnum mode? type_? contact? address? form? position? managingOrganization? partOf? characteristic? hoursOfOperation? virtualService? endpoint?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getOperationalStatus setOperationalStatus hasOperationalStatus getNameElement setNameElement hasNameElement getName setName hasName getAliasElement setAliasElement addAliasElement hasAliasElement getAlias setAlias addAlias hasAlias getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getModeEnumType setModeEnumType hasModeEnumType getModeElement setModeElement hasModeElement getMode setMode hasMode getType setType addType hasType getContact setContact addContact hasContact getAddress setAddress hasAddress getForm setForm hasForm getPosition setPosition hasPosition getManagingOrganization setManagingOrganization hasManagingOrganization getPartOf setPartOf hasPartOf getCharacteristic setCharacteristic addCharacteristic hasCharacteristic getHoursOfOperation setHoursOfOperation addHoursOfOperation hasHoursOfOperation getVirtualService setVirtualService addVirtualService hasVirtualService getEndpoint setEndpoint addEndpoint hasEndpoint fhirType isEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isRequiredFieldsEmpty isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initAlias initType initContact initCharacteristic initHoursOfOperation initVirtualService initEndpoint

    Constructors

    Properties

    identifier?: Identifier[]

    Location.identifier Element

    FHIR Specification

    • Short: Unique code or number identifying the location to its users
    • Definition: Unique code or number identifying the location to its users.
    • Requirements: Organization label locations in registries, need to keep track of those.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    locationStatusEnum: LocationStatusEnum

    FHIR CodeSystem: LocationStatus

    LocationStatusEnum

    status?: EnumCodeType

    Location.status Element

    FHIR Specification

    • Short: active | suspended | inactive
    • Definition: 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.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid
    • isSummary: true

    CodeSystem Enumeration: LocationStatusEnum

    operationalStatus?: Coding

    Location.operationalStatus Element

    FHIR Specification

    • Short: The operational status of the location (typically only for a bed/room)
    • Definition: 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.
    • FHIR Type: Coding
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: StringType

    Location.name Element

    FHIR Specification

    • Short: Name of the location as used by humans
    • Definition: Name of the location as used by humans. Does not need to be unique.
    • Comment: If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    alias?: StringType[]

    Location.alias Element

    FHIR Specification

    • Short: A list of alternate names that the location is known as, or was known as, in the past
    • Definition: A list of alternate names that the location is known as, or was known as, in the past.
    • Comment: There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location.
    • Requirements: Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the location was known by can be very useful.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    Location.description Element

    FHIR Specification

    • Short: Additional details about the location that could be displayed as further information to identify the location beyond its name
    • Definition: Description of the Location, which helps in finding or referencing the place.
    • Requirements: Humans need additional information to verify a correct location has been identified.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    locationModeEnum: LocationModeEnum

    FHIR CodeSystem: LocationMode

    LocationModeEnum

    mode?: EnumCodeType

    Location.mode Element

    FHIR Specification

    • Short: instance | kind
    • Definition: Indicates whether a resource instance represents a specific location or a class of locations.
    • Comment: This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood.
    • Requirements: When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: LocationModeEnum

    Private Optionaltype_

    type_?: CodeableConcept[]

    Location.type Element

    FHIR Specification

    • Short: Type of function performed
    • Definition: Indicates the type of function performed at the location.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    contact?: ExtendedContactDetail[]

    Location.contact Element

    FHIR Specification

    • Short: Official contact details for the location
    • Definition: The contact details of communication devices available at the location. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.
    • Comment: The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the Healthcare itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc. If this is empty (or the type of interest is empty), refer to the organization's contacts.
    • Requirements: Need to keep track of both simple contact details and also assigned contacts within larger organizations.
    • FHIR Type: ExtendedContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    address?: Address

    Location.address Element

    FHIR Specification

    • Short: Physical location
    • Definition: Physical location.
    • Comment: Additional addresses should be recorded using another instance of the Location resource, or via the Organization.
    • Requirements: If locations can be visited, we need to keep track of their address.
    • FHIR Type: Address
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    form?: CodeableConcept

    Location.form Element

    FHIR Specification

    • Short: Physical form of the location
    • Definition: Physical form of the location, e.g. building, room, vehicle, road, virtual.
    • Requirements: For purposes of showing relevant locations in queries, we need to categorize locations.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    position?: LocationPositionComponent

    Location.position Element

    FHIR Specification

    • Short: The absolute geographic location
    • Definition: The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
    • Comment: To define a boundary shape for this location use the standard extension [http://hl7.org/fhir/StructureDefinition/location-boundary-geojson](http://hl7.org/fhir/extensions/https://hl7.org/fhir/StructureDefinition-location-boundary-geojson.html), and search using the contains special search parameter.
    • Requirements: For mobile applications and automated route-finding knowing the exact location of the Location is required.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    managingOrganization?: Reference

    Location.managingOrganization Element

    FHIR Specification

    • Short: Organization responsible for provisioning and upkeep
    • Definition: The organization responsible for the provisioning and upkeep of the location.
    • Comment: This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.
    • Requirements: Need to know who manages the location.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    partOf?: Reference

    Location.partOf Element

    FHIR Specification

    • Short: Another Location this one is physically a part of
    • Definition: Another Location of which this Location is physically a part of.
    • Requirements: For purposes of location, display and identification, knowing which locations are located within other locations is important.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    characteristic?: CodeableConcept[]

    Location.characteristic Element

    FHIR Specification

    • Short: Collection of characteristics (attributes)
    • Definition: Collection of characteristics (attributes).
    • Comment: These could be such things as is wheelchair accessible.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    hoursOfOperation?: Availability[]

    Location.hoursOfOperation Element

    FHIR Specification

    • Short: What days/times during a week is this location usually open (including exceptions)
    • Definition: What days/times during a week is this location usually open, and any exceptions where the location is not available.
    • Comment: This type of information is commonly found published in directories and on websites informing customers when the facility is available. Specific services within the location may have their own hours which could be shorter (or longer) than the locations hours. Systems may choose to render availability differently than it is exchanged on the interface. For example, rather than "Mon, Tue, Wed, Thur, Fri from 9am-12am; Mon, Tue, Wed, Thur, Fri from 1pm-5pm" as would be implied by two availableTime repetitions, an application could render this information as "Mon-Fri 9-12am and 1-5pm". The availableStartTime is the opening time, and the availableEndTime is the closing time.
    • FHIR Type: Availability
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    virtualService?: VirtualServiceDetail[]

    Location.virtualService Element

    FHIR Specification

    • Short: Connection details of a virtual service (e.g. conference call)
    • Definition: Connection details of a virtual service (e.g. shared conference call facility with dedicated number/details).
    • Comment: There are two types of virtual meetings that often exist: * a persistent, virtual meeting room that can only be used for a single purpose at a time, * and a dynamic virtual meeting room that is generated on demand for a specific purpose. Implementers may consider using Appointment.virtualService for virtual meeting rooms that are generated on-demand.
    • FHIR Type: VirtualServiceDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    endpoint?: Reference[]

    Location.endpoint Element

    FHIR Specification

    • Short: Technical endpoints providing access to services operated for the location
    • Definition: Technical endpoints providing access to services operated for the location.
    • Requirements: Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided Location JSON to instantiate the Location data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR Location

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Location

      Returns undefined | Location

      Location data model or undefined for Location

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided ManagingOrganization object value to the managingOrganization property.

      Parameters

      • value: undefined | Reference

        the managingOrganization object value

      Returns this

      this

      @ReferenceTargets('Location.managingOrganization', ['Organization',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetOperationalStatussetOperationalStatushasOperationalStatusgetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetAliasElementsetAliasElementaddAliasElementhasAliasElementgetAliassetAliasaddAliashasAliasgetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetModeEnumTypesetModeEnumTypehasModeEnumTypegetModeElementsetModeElementhasModeElementgetModesetModehasModegetTypesetTypeaddTypehasTypegetContactsetContactaddContacthasContactgetAddresssetAddresshasAddressgetFormsetFormhasFormgetPositionsetPositionhasPositiongetManagingOrganizationsetManagingOrganizationhasManagingOrganizationgetPartOfsetPartOfhasPartOfgetCharacteristicsetCharacteristicaddCharacteristichasCharacteristicgetHoursOfOperationsetHoursOfOperationaddHoursOfOperationhasHoursOfOperationgetVirtualServicesetVirtualServiceaddVirtualServicehasVirtualServicegetEndpointsetEndpointaddEndpointhasEndpointfhirTypeisEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisRequiredFieldsEmptyisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitAliasinitTypeinitContactinitCharacteristicinitHoursOfOperationinitVirtualServiceinitEndpoint