Class Location

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class Location extends DomainResource
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
See Also:
  • Field Details

    • identifier

      Unique code or number identifying the location to its users.
    • status

      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 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.
    • name

      protected StringType name
      Name of the location as used by humans. Does not need to be unique.
    • alias

      protected List<StringType> alias
      A list of alternate names that the location is known as, or was known as, in the past.
    • description

      Description of the Location, which helps in finding or referencing the place.
    • mode

      Indicates whether a resource instance represents a specific location or a class of locations.
    • type

      Indicates the type of function performed at the location.
    • telecom

      The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
    • address

      protected Address address
      Physical location.
    • physicalType

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

      The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
    • managingOrganization

      The organization responsible for the provisioning and upkeep of the location.
    • partOf

      protected Reference partOf
      Another Location of which this Location is physically a part of.
    • hoursOfOperation

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

      A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.
    • endpoint

      protected List<Reference> endpoint
      Technical endpoints providing access to services operated for the location.
    • SP_ADDRESS_CITY

      public static final String SP_ADDRESS_CITY
      Search parameter: address-city

      Description: A city specified in an address
      Type: string
      Path: Location.address.city

      See Also:
    • ADDRESS_CITY

      public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_CITY
      Fluent Client search parameter constant for address-city

      Description: A city specified in an address
      Type: string
      Path: Location.address.city

    • SP_ADDRESS_COUNTRY

      public static final String SP_ADDRESS_COUNTRY
      Search parameter: address-country

      Description: A country specified in an address
      Type: string
      Path: Location.address.country

      See Also:
    • ADDRESS_COUNTRY

      public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_COUNTRY
      Fluent Client search parameter constant for address-country

      Description: A country specified in an address
      Type: string
      Path: Location.address.country

    • SP_ADDRESS_POSTALCODE

      public static final String SP_ADDRESS_POSTALCODE
      Search parameter: address-postalcode

      Description: A postal code specified in an address
      Type: string
      Path: Location.address.postalCode

      See Also:
    • ADDRESS_POSTALCODE

      public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_POSTALCODE
      Fluent Client search parameter constant for address-postalcode

      Description: A postal code specified in an address
      Type: string
      Path: Location.address.postalCode

    • SP_ADDRESS_STATE

      public static final String SP_ADDRESS_STATE
      Search parameter: address-state

      Description: A state specified in an address
      Type: string
      Path: Location.address.state

      See Also:
    • ADDRESS_STATE

      public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_STATE
      Fluent Client search parameter constant for address-state

      Description: A state specified in an address
      Type: string
      Path: Location.address.state

    • SP_ADDRESS_USE

      public static final String SP_ADDRESS_USE
      Search parameter: address-use

      Description: A use code specified in an address
      Type: token
      Path: Location.address.use

      See Also:
    • ADDRESS_USE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam ADDRESS_USE
      Fluent Client search parameter constant for address-use

      Description: A use code specified in an address
      Type: token
      Path: Location.address.use

    • SP_ADDRESS

      public static final String SP_ADDRESS
      Search parameter: address

      Description: A (part of the) address of the location
      Type: string
      Path: Location.address

      See Also:
    • ADDRESS

      public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS
      Fluent Client search parameter constant for address

      Description: A (part of the) address of the location
      Type: string
      Path: Location.address

    • SP_ENDPOINT

      public static final String SP_ENDPOINT
      Search parameter: endpoint

      Description: Technical endpoints providing access to services operated for the location
      Type: reference
      Path: Location.endpoint

      See Also:
    • ENDPOINT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENDPOINT
      Fluent Client search parameter constant for endpoint

      Description: Technical endpoints providing access to services operated for the location
      Type: reference
      Path: Location.endpoint

    • INCLUDE_ENDPOINT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ENDPOINT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Location:endpoint".
    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: An identifier for the location
      Type: token
      Path: Location.identifier

      See Also:
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: An identifier for the location
      Type: token
      Path: Location.identifier

    • SP_NAME

      public static final String SP_NAME
      Search parameter: name

      Description: A portion of the location's name or alias
      Type: string
      Path: Location.name | Location.alias

      See Also:
    • NAME

      public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
      Fluent Client search parameter constant for name

      Description: A portion of the location's name or alias
      Type: string
      Path: Location.name | Location.alias

    • SP_NEAR

      public static final String SP_NEAR
      Search parameter: near

      Description: Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant) Servers may search using various techniques that might have differing accuracies, depending on implementation efficiency.
      Type: special
      Path: Location.position

      See Also:
    • NEAR

      public static final ca.uhn.fhir.rest.gclient.SpecialClientParam NEAR
      Fluent Client search parameter constant for near

      Description: Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant) Servers may search using various techniques that might have differing accuracies, depending on implementation efficiency.
      Type: special
      Path: Location.position

    • SP_OPERATIONAL_STATUS

      public static final String SP_OPERATIONAL_STATUS
      Search parameter: operational-status

      Description: Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)
      Type: token
      Path: Location.operationalStatus

      See Also:
    • OPERATIONAL_STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam OPERATIONAL_STATUS
      Fluent Client search parameter constant for operational-status

      Description: Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)
      Type: token
      Path: Location.operationalStatus

    • SP_ORGANIZATION

      public static final String SP_ORGANIZATION
      Search parameter: organization

      Description: Searches for locations that are managed by the provided organization
      Type: reference
      Path: Location.managingOrganization

      See Also:
    • ORGANIZATION

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ORGANIZATION
      Fluent Client search parameter constant for organization

      Description: Searches for locations that are managed by the provided organization
      Type: reference
      Path: Location.managingOrganization

    • INCLUDE_ORGANIZATION

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ORGANIZATION
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Location:organization".
    • SP_PARTOF

      public static final String SP_PARTOF
      Search parameter: partof

      Description: A location of which this location is a part
      Type: reference
      Path: Location.partOf

      See Also:
    • PARTOF

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARTOF
      Fluent Client search parameter constant for partof

      Description: A location of which this location is a part
      Type: reference
      Path: Location.partOf

    • INCLUDE_PARTOF

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PARTOF
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Location:partof".
    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: Searches for locations with a specific kind of status
      Type: token
      Path: Location.status

      See Also:
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: Searches for locations with a specific kind of status
      Type: token
      Path: Location.status

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter: type

      Description: A code for the type of location
      Type: token
      Path: Location.type

      See Also:
    • TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
      Fluent Client search parameter constant for type

      Description: A code for the type of location
      Type: token
      Path: Location.type

  • Constructor Details

    • Location

      public Location()
      Constructor
  • Method Details