Class Location

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.Location
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class Location
extends BaseResource
implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR Location Resource (administrative.entity)

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

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/Location

See Also:
Serialized Form
  • Field Details

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter constant for identifier

      Description:
      Type: token
      Path: Location.identifier

      See Also:
      Constant Field Values
    • IDENTIFIER

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

      Description:
      Type: token
      Path: Location.identifier

    • SP_NAME

      public static final String SP_NAME
      Search parameter constant for name

      Description: A (portion of the) name of the location
      Type: string
      Path: Location.name

      See Also:
      Constant Field Values
    • NAME

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

      Description: A (portion of the) name of the location
      Type: string
      Path: Location.name

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter constant for type

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

      See Also:
      Constant Field Values
    • 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

    • SP_ADDRESS

      public static final String SP_ADDRESS
      Search parameter constant for address

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

      See Also:
      Constant Field Values
    • 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_ADDRESS_CITY

      public static final String SP_ADDRESS_CITY
      Search parameter constant for address-city

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

      See Also:
      Constant Field Values
    • 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_STATE

      public static final String SP_ADDRESS_STATE
      Search parameter constant for address-state

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

      See Also:
      Constant Field Values
    • 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_POSTALCODE

      public static final String SP_ADDRESS_POSTALCODE
      Search parameter constant for address-postalcode

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

      See Also:
      Constant Field Values
    • 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_COUNTRY

      public static final String SP_ADDRESS_COUNTRY
      Search parameter constant for address-country

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

      See Also:
      Constant Field Values
    • 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_USE

      public static final String SP_ADDRESS_USE
      Search parameter constant for address-use

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

      See Also:
      Constant Field Values
    • 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_STATUS

      public static final String SP_STATUS
      Search parameter constant for status

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

      See Also:
      Constant Field Values
    • 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_PARTOF

      public static final String SP_PARTOF
      Search parameter constant for partof

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

      See Also:
      Constant Field Values
    • PARTOF

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

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

    • SP_NEAR

      public static final String SP_NEAR
      Search parameter constant for near

      Description: The coordinates expressed as [lat],[long] (using the WGS84 datum, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency)
      Type: token
      Path: Location.position

      See Also:
      Constant Field Values
    • NEAR

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

      Description: The coordinates expressed as [lat],[long] (using the WGS84 datum, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency)
      Type: token
      Path: Location.position

    • SP_NEAR_DISTANCE

      public static final String SP_NEAR_DISTANCE
      Search parameter constant for near-distance

      Description: A distance quantity to limit the near search to locations within a specific distance
      Type: token
      Path: Location.position

      See Also:
      Constant Field Values
    • NEAR_DISTANCE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam NEAR_DISTANCE
      Fluent Client search parameter constant for near-distance

      Description: A distance quantity to limit the near search to locations within a specific distance
      Type: token
      Path: Location.position

    • SP_ORGANIZATION

      public static final String SP_ORGANIZATION
      Search parameter constant for organization

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

      See Also:
      Constant Field Values
    • 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".
    • 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".
  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • getIdentifier

      Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

      Definition: Unique code or number identifying the location to its users

    • setIdentifier

      public Location setIdentifier​(List<IdentifierDt> theValue)
      Sets the value(s) for identifier (id)

      Definition: Unique code or number identifying the location to its users

    • addIdentifier

      Adds and returns a new value for identifier (id)

      Definition: Unique code or number identifying the location to its users

    • addIdentifier

      public Location addIdentifier​(IdentifierDt theValue)
      Adds a given new value for identifier (id)

      Definition: Unique code or number identifying the location to its users

      Parameters:
      theValue - The identifier to add (must not be null)
    • getIdentifierFirstRep

      Gets the first repetition for identifier (id), creating it if it does not already exist.

      Definition: Unique code or number identifying the location to its users

    • getStatusElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<LocationStatusEnum> getStatusElement()
      Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

      Definition:

    • getStatus

      public String getStatus()
      Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

      Definition:

    • setStatus

      public Location setStatus​(ca.uhn.fhir.model.primitive.BoundCodeDt<LocationStatusEnum> theValue)
      Sets the value(s) for status (status)

      Definition:

    • setStatus

      public Location setStatus​(LocationStatusEnum theValue)
      Sets the value(s) for status (status)

      Definition:

    • getNameElement

      public ca.uhn.fhir.model.primitive.StringDt getNameElement()
      Gets the value(s) for name (). creating it if it does not exist. Will not return null.

      Definition: Name of the location as used by humans. Does not need to be unique.

    • getName

      public String getName()
      Gets the value(s) for name (). creating it if it does not exist. This method may return null.

      Definition: Name of the location as used by humans. Does not need to be unique.

    • setName

      public Location setName​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for name ()

      Definition: Name of the location as used by humans. Does not need to be unique.

    • setName

      public Location setName​(String theString)
      Sets the value for name ()

      Definition: Name of the location as used by humans. Does not need to be unique.

    • getDescriptionElement

      public ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
      Gets the value(s) for description (). creating it if it does not exist. Will not return null.

      Definition: Description of the Location, which helps in finding or referencing the place

    • getDescription

      Gets the value(s) for description (). creating it if it does not exist. This method may return null.

      Definition: Description of the Location, which helps in finding or referencing the place

    • setDescription

      public Location setDescription​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for description ()

      Definition: Description of the Location, which helps in finding or referencing the place

    • setDescription

      public Location setDescription​(String theString)
      Sets the value for description ()

      Definition: Description of the Location, which helps in finding or referencing the place

    • getModeElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<LocationModeEnum> getModeElement()
      Gets the value(s) for mode (class). creating it if it does not exist. Will not return null.

      Definition: Indicates whether a resource instance represents a specific location or a class of locations

    • getMode

      public String getMode()
      Gets the value(s) for mode (class). creating it if it does not exist. This method may return null.

      Definition: Indicates whether a resource instance represents a specific location or a class of locations

    • setMode

      public Location setMode​(ca.uhn.fhir.model.primitive.BoundCodeDt<LocationModeEnum> theValue)
      Sets the value(s) for mode (class)

      Definition: Indicates whether a resource instance represents a specific location or a class of locations

    • setMode

      public Location setMode​(LocationModeEnum theValue)
      Sets the value(s) for mode (class)

      Definition: Indicates whether a resource instance represents a specific location or a class of locations

    • getType

      Gets the value(s) for type (class). creating it if it does not exist. Will not return null.

      Definition: Indicates the type of function performed at the location

    • setType

      Sets the value(s) for type (class)

      Definition: Indicates the type of function performed at the location

    • setType

      public Location setType​(LocationTypeEnum theValue)
      Sets the value(s) for type (class)

      Definition: Indicates the type of function performed at the location

    • getTelecom

      Gets the value(s) for telecom (). creating it if it does not exist. Will not return null.

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

    • setTelecom

      public Location setTelecom​(List<ContactPointDt> theValue)
      Sets the value(s) for telecom ()

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

    • addTelecom

      Adds and returns a new value for telecom ()

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

    • addTelecom

      public Location addTelecom​(ContactPointDt theValue)
      Adds a given new value for telecom ()

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

      Parameters:
      theValue - The telecom to add (must not be null)
    • getTelecomFirstRep

      Gets the first repetition for telecom (), creating it if it does not already exist.

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

    • getAddress

      Gets the value(s) for address (). creating it if it does not exist. Will not return null.

      Definition:

    • setAddress

      public Location setAddress​(AddressDt theValue)
      Sets the value(s) for address ()

      Definition:

    • getPhysicalType

      Gets the value(s) for physicalType (class). creating it if it does not exist. Will not return null.

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

    • setPhysicalType

      Sets the value(s) for physicalType (class)

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

    • getPosition

      Gets the value(s) for position (). creating it if it does not exist. Will not return null.

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

    • setPosition

      public Location setPosition​(Location.Position theValue)
      Sets the value(s) for position ()

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

    • getManagingOrganization

      Gets the value(s) for managingOrganization (). creating it if it does not exist. Will not return null.

      Definition: The organization responsible for the provisioning and upkeep of the location

    • setManagingOrganization

      Sets the value(s) for managingOrganization ()

      Definition: The organization responsible for the provisioning and upkeep of the location

    • getPartOf

      Gets the value(s) for partOf (). creating it if it does not exist. Will not return null.

      Definition: Another Location which this Location is physically part of

    • setPartOf

      public Location setPartOf​(ResourceReferenceDt theValue)
      Sets the value(s) for partOf ()

      Definition: Another Location which this Location is physically part of

    • getResourceName

      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource
    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource