Location (HAPI FHIR - Core Library 0.7 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseResource
  - - ca.uhn.fhir.model.dstu.resource.Location

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class Location
extends BaseResource
implements IResource
```
HAPI/FHIR Location Resource (Details and position information for a physical place)
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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Location.Position
Block class for child element: Location.position (The absolute geographic location)

Nested Classes
Modifier and Type	Class and Description
`static class`	`Location.Position` Block class for child element: Location.position (The absolute geographic location)

Field Summary

Fields
Modifier and Type	Field and Description
`static StringClientParam`	`ADDRESS` Fluent Client search parameter constant for address
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_PARTOF` Constant for fluent queries to be used to add include statements.
`static StringClientParam`	`NAME` Fluent Client search parameter constant for name
`static TokenClientParam`	`NEAR` Fluent Client search parameter constant for near
`static TokenClientParam`	`NEAR_DISTANCE` Fluent Client search parameter constant for near-distance
`static ReferenceClientParam`	`PARTOF` Fluent Client search parameter constant for partof
`static String`	`SP_ADDRESS` Search parameter constant for address
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_NAME` Search parameter constant for name
`static String`	`SP_NEAR` Search parameter constant for near
`static String`	`SP_NEAR_DISTANCE` Search parameter constant for near-distance
`static String`	`SP_PARTOF` Search parameter constant for partof
`static String`	`SP_STATUS` Search parameter constant for status
`static String`	`SP_TYPE` Search parameter constant for type
`static TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`static TokenClientParam`	`TYPE` Fluent Client search parameter constant for type

Fields inherited from class ca.uhn.fhir.model.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

Location()

Constructors
Constructor and Description
`Location()`

Method Summary

Methods
Modifier and Type	Method and Description
`ContactDt`	`addTelecom()` Adds and returns a new value for telecom (Contact details of the location)
`Location`	`addTelecom(ContactUseEnum theContactUse, String theValue)` Adds a new value for telecom (Contact details of the location)
`Location`	`addTelecom(String theValue)` Adds a new value for telecom (Contact details of the location)
`AddressDt`	`getAddress()` Gets the value(s) for address (Physical location).
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`StringDt`	`getDescription()` Gets the value(s) for description (Description of the Location, which helps in finding or referencing the place).
`IdentifierDt`	`getIdentifier()` Gets the value(s) for identifier (Unique code or number identifying the location to its users).
`ResourceReferenceDt`	`getManagingOrganization()` Gets the value(s) for managingOrganization (The organization that is responsible for the provisioning and upkeep of the location).
`BoundCodeDt<LocationModeEnum>`	`getMode()` Gets the value(s) for mode (instance \| kind).
`StringDt`	`getName()` Gets the value(s) for name (Name of the location as used by humans).
`ResourceReferenceDt`	`getPartOf()` Gets the value(s) for partOf (Another Location which this Location is physically part of).
`CodeableConceptDt`	`getPhysicalType()` Gets the value(s) for physicalType (Physical form of the location).
`Location.Position`	`getPosition()` Gets the value(s) for position (The absolute geographic location).
`BoundCodeDt<LocationStatusEnum>`	`getStatus()` Gets the value(s) for status (active \| suspended \| inactive).
`List<ContactDt>`	`getTelecom()` Gets the value(s) for telecom (Contact details of the location).
`ContactDt`	`getTelecomFirstRep()` Gets the first repetition for telecom (Contact details of the location), creating it if it does not already exist.
`BoundCodeableConceptDt<LocationTypeEnum>`	`getType()` Gets the value(s) for type (Indicates the type of function performed at the location).
`boolean`	`isEmpty()`
`Location`	`setAddress(AddressDt theValue)` Sets the value(s) for address (Physical location)
`Location`	`setDescription(String theString)` Sets the value for description (Description of the Location, which helps in finding or referencing the place)
`Location`	`setDescription(StringDt theValue)` Sets the value(s) for description (Description of the Location, which helps in finding or referencing the place)
`Location`	`setIdentifier(IdentifierDt theValue)` Sets the value(s) for identifier (Unique code or number identifying the location to its users)
`Location`	`setIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Sets the value for identifier (Unique code or number identifying the location to its users)
`Location`	`setIdentifier(String theSystem, String theValue)` Sets the value for identifier (Unique code or number identifying the location to its users)
`Location`	`setManagingOrganization(ResourceReferenceDt theValue)` Sets the value(s) for managingOrganization (The organization that is responsible for the provisioning and upkeep of the location)
`Location`	`setMode(BoundCodeDt<LocationModeEnum> theValue)` Sets the value(s) for mode (instance \| kind)
`Location`	`setMode(LocationModeEnum theValue)` Sets the value(s) for mode (instance \| kind)
`Location`	`setName(String theString)` Sets the value for name (Name of the location as used by humans)
`Location`	`setName(StringDt theValue)` Sets the value(s) for name (Name of the location as used by humans)
`Location`	`setPartOf(ResourceReferenceDt theValue)` Sets the value(s) for partOf (Another Location which this Location is physically part of)
`Location`	`setPhysicalType(CodeableConceptDt theValue)` Sets the value(s) for physicalType (Physical form of the location)
`Location`	`setPosition(Location.Position theValue)` Sets the value(s) for position (The absolute geographic location)
`Location`	`setStatus(BoundCodeDt<LocationStatusEnum> theValue)` Sets the value(s) for status (active \| suspended \| inactive)
`Location`	`setStatus(LocationStatusEnum theValue)` Sets the value(s) for status (active \| suspended \| inactive)
`Location`	`setTelecom(List<ContactDt> theValue)` Sets the value(s) for telecom (Contact details of the location)
`Location`	`setType(BoundCodeableConceptDt<LocationTypeEnum> theValue)` Sets the value(s) for type (Indicates the type of function performed at the location)
`Location`	`setType(LocationTypeEnum theValue)` Sets the value(s) for type (Indicates the type of function performed at the location)

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

- Field Detail
  - 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 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 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 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 StringClientParam ADDRESS
```
    Fluent Client search parameter constant for address
    Description: A (part of the) address of the location
    Type: string
    Path: Location.address
  - 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 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 ReferenceClientParam PARTOF
```
    Fluent Client search parameter constant for partof
    Description: The location of which this location is a part
    Type: reference
    Path: Location.partOf
  - INCLUDE_PARTOF
```
public static final Include INCLUDE_PARTOF
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Location.partOf".
  - SP_NEAR
```
public static final String SP_NEAR
```
    Search parameter constant for near
    Description: The coordinates expressed as [lat],[long] (using KML, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency)
    Type: token
    Path:
    
    See Also:
    Constant Field Values
  - NEAR
```
public static final TokenClientParam NEAR
```
    Fluent Client search parameter constant for near
    Description: The coordinates expressed as [lat],[long] (using KML, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency)
    Type: token
    Path:
  - 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:
    
    See Also:
    Constant Field Values
  - NEAR_DISTANCE
```
public static final 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:
- Constructor Detail
  - Location
```
public Location()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getIdentifier
```
public IdentifierDt getIdentifier()
```
    Gets the value(s) for identifier (Unique code or number identifying the location to its users). 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(IdentifierDt theValue)
```
    Sets the value(s) for identifier (Unique code or number identifying the location to its users)
    Definition: Unique code or number identifying the location to its users
  - setIdentifier
```
public Location setIdentifier(IdentifierUseEnum theUse,
                     String theSystem,
                     String theValue,
                     String theLabel)
```
    Sets the value for identifier (Unique code or number identifying the location to its users)
    Definition: Unique code or number identifying the location to its users
  - setIdentifier
```
public Location setIdentifier(String theSystem,
                     String theValue)
```
    Sets the value for identifier (Unique code or number identifying the location to its users)
    Definition: Unique code or number identifying the location to its users
  - getName
```
public StringDt getName()
```
    Gets the value(s) for name (Name of the location as used by humans). 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.
  - setName
```
public Location setName(StringDt theValue)
```
    Sets the value(s) for name (Name of the location as used by humans)
    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 (Name of the location as used by humans)
    Definition: Name of the location as used by humans. Does not need to be unique.
  - getDescription
```
public StringDt getDescription()
```
    Gets the value(s) for description (Description of the Location, which helps in finding or referencing the place). creating it if it does not exist. Will not return null.
    Definition: Description of the Location, which helps in finding or referencing the place
  - setDescription
```
public Location setDescription(StringDt theValue)
```
    Sets the value(s) for description (Description of the Location, which helps in finding or referencing the place)
    Definition: Description of the Location, which helps in finding or referencing the place
  - setDescription
```
public Location setDescription(String theString)
```
    Sets the value for description (Description of the Location, which helps in finding or referencing the place)
    Definition: Description of the Location, which helps in finding or referencing the place
  - getType
```
public BoundCodeableConceptDt<LocationTypeEnum> getType()
```
    Gets the value(s) for type (Indicates the type of function performed at the location). creating it if it does not exist. Will not return null.
    Definition: Indicates the type of function performed at the location
  - setType
```
public Location setType(BoundCodeableConceptDt<LocationTypeEnum> theValue)
```
    Sets the value(s) for type (Indicates the type of function performed at the location)
    Definition: Indicates the type of function performed at the location
  - setType
```
public Location setType(LocationTypeEnum theValue)
```
    Sets the value(s) for type (Indicates the type of function performed at the location)
    Definition: Indicates the type of function performed at the location
  - getTelecom
```
public List<ContactDt> getTelecom()
```
    Gets the value(s) for telecom (Contact details of the location). 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<ContactDt> theValue)
```
    Sets the value(s) for telecom (Contact details of the location)
    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 ContactDt addTelecom()
```
    Adds and returns a new value for telecom (Contact details of the location)
    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
  - getTelecomFirstRep
```
public ContactDt getTelecomFirstRep()
```
    Gets the first repetition for telecom (Contact details of the location), 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
  - addTelecom
```
public Location addTelecom(ContactUseEnum theContactUse,
                  String theValue)
```
    Adds a new value for telecom (Contact details of the location)
    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
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addTelecom
```
public Location addTelecom(String theValue)
```
    Adds a new value for telecom (Contact details of the location)
    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
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getAddress
```
public AddressDt getAddress()
```
    Gets the value(s) for address (Physical location). creating it if it does not exist. Will not return null.
    Definition:
  - setAddress
```
public Location setAddress(AddressDt theValue)
```
    Sets the value(s) for address (Physical location)
    Definition:
  - getPhysicalType
```
public CodeableConceptDt getPhysicalType()
```
    Gets the value(s) for physicalType (Physical form of the location). creating it if it does not exist. Will not return null.
    Definition: Physical form of the location, e.g. building, room, vehicle, road
  - setPhysicalType
```
public Location setPhysicalType(CodeableConceptDt theValue)
```
    Sets the value(s) for physicalType (Physical form of the location)
    Definition: Physical form of the location, e.g. building, room, vehicle, road
  - getPosition
```
public Location.Position getPosition()
```
    Gets the value(s) for position (The absolute geographic location). creating it if it does not exist. Will not return null.
    Definition: The absolute geographic location of the Location, expressed in a KML compatible manner (see notes below for KML)
  - setPosition
```
public Location setPosition(Location.Position theValue)
```
    Sets the value(s) for position (The absolute geographic location)
    Definition: The absolute geographic location of the Location, expressed in a KML compatible manner (see notes below for KML)
  - getManagingOrganization
```
public ResourceReferenceDt getManagingOrganization()
```
    Gets the value(s) for managingOrganization (The organization that is responsible for the provisioning and upkeep of the location). creating it if it does not exist. Will not return null.
    Definition:
  - setManagingOrganization
```
public Location setManagingOrganization(ResourceReferenceDt theValue)
```
    Sets the value(s) for managingOrganization (The organization that is responsible for the provisioning and upkeep of the location)
    Definition:
  - getStatus
```
public BoundCodeDt<LocationStatusEnum> getStatus()
```
    Gets the value(s) for status (active | suspended | inactive). creating it if it does not exist. Will not return null.
    Definition:
  - setStatus
```
public Location setStatus(BoundCodeDt<LocationStatusEnum> theValue)
```
    Sets the value(s) for status (active | suspended | inactive)
    Definition:
  - setStatus
```
public Location setStatus(LocationStatusEnum theValue)
```
    Sets the value(s) for status (active | suspended | inactive)
    Definition:
  - getPartOf
```
public ResourceReferenceDt getPartOf()
```
    Gets the value(s) for partOf (Another Location which this Location is physically part of). creating it if it does not exist. Will not return null.
    Definition:
  - setPartOf
```
public Location setPartOf(ResourceReferenceDt theValue)
```
    Sets the value(s) for partOf (Another Location which this Location is physically part of)
    Definition:
  - getMode
```
public BoundCodeDt<LocationModeEnum> getMode()
```
    Gets the value(s) for mode (instance | kind). 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
  - setMode
```
public Location setMode(BoundCodeDt<LocationModeEnum> theValue)
```
    Sets the value(s) for mode (instance | kind)
    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 (instance | kind)
    Definition: Indicates whether a resource instance represents a specific location or a class of locations

Class Location

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Field Detail

SP_IDENTIFIER

IDENTIFIER

SP_NAME

NAME

SP_TYPE

TYPE

SP_ADDRESS

ADDRESS

SP_STATUS

STATUS

SP_PARTOF

PARTOF

INCLUDE_PARTOF

SP_NEAR

NEAR

SP_NEAR_DISTANCE

NEAR_DISTANCE

Constructor Detail

Location

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

setIdentifier

setIdentifier

getName

setName

setName

getDescription

setDescription

setDescription

getType

setType

setType

getTelecom

setTelecom

addTelecom

getTelecomFirstRep

addTelecom

addTelecom

getAddress

setAddress

getPhysicalType

setPhysicalType

getPosition

setPosition

getManagingOrganization

setManagingOrganization

getStatus

setStatus

setStatus

getPartOf

setPartOf

getMode

setMode

setMode