public class Location extends BaseResource implements IResource
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
Modifier and Type | Class and Description |
---|---|
static class |
Location.Position
Block class for child element: Location.position ()
|
Modifier and Type | Field and Description |
---|---|
static StringClientParam |
ADDRESS
Fluent Client search parameter constant for address
|
static StringClientParam |
ADDRESS_CITY
Fluent Client search parameter constant for address-city
|
static StringClientParam |
ADDRESS_COUNTRY
Fluent Client search parameter constant for address-country
|
static StringClientParam |
ADDRESS_POSTALCODE
Fluent Client search parameter constant for address-postalcode
|
static StringClientParam |
ADDRESS_STATE
Fluent Client search parameter constant for address-state
|
static TokenClientParam |
ADDRESS_USE
Fluent Client search parameter constant for address-use
|
static TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static Include |
INCLUDE_ORGANIZATION
Constant for fluent queries to be used to add include statements.
|
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 |
ORGANIZATION
Fluent Client search parameter constant for organization
|
static ReferenceClientParam |
PARTOF
Fluent Client search parameter constant for partof
|
static String |
SP_ADDRESS
Search parameter constant for address
|
static String |
SP_ADDRESS_CITY
Search parameter constant for address-city
|
static String |
SP_ADDRESS_COUNTRY
Search parameter constant for address-country
|
static String |
SP_ADDRESS_POSTALCODE
Search parameter constant for address-postalcode
|
static String |
SP_ADDRESS_STATE
Search parameter constant for address-state
|
static String |
SP_ADDRESS_USE
Search parameter constant for address-use
|
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_ORGANIZATION
Search parameter constant for organization
|
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
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGE
INCLUDE_ALL, WILDCARD_ALL_SET
Constructor and Description |
---|
Location() |
Modifier and Type | Method and Description |
---|---|
IdentifierDt |
addIdentifier()
Adds and returns a new value for identifier (id)
|
Location |
addIdentifier(IdentifierDt theValue)
Adds a given new value for identifier (id)
|
ContactPointDt |
addTelecom()
Adds and returns a new value for telecom ()
|
Location |
addTelecom(ContactPointDt theValue)
Adds a given new value for telecom ()
|
AddressDt |
getAddress()
Gets the value(s) for address ().
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
String |
getDescription()
Gets the value(s) for description ().
|
StringDt |
getDescriptionElement()
Gets the value(s) for description ().
|
List<IdentifierDt> |
getIdentifier()
Gets the value(s) for identifier (id).
|
IdentifierDt |
getIdentifierFirstRep()
Gets the first repetition for identifier (id),
creating it if it does not already exist.
|
ResourceReferenceDt |
getManagingOrganization()
Gets the value(s) for managingOrganization ().
|
String |
getMode()
Gets the value(s) for mode (class).
|
BoundCodeDt<LocationModeEnum> |
getModeElement()
Gets the value(s) for mode (class).
|
String |
getName()
Gets the value(s) for name ().
|
StringDt |
getNameElement()
Gets the value(s) for name ().
|
ResourceReferenceDt |
getPartOf()
Gets the value(s) for partOf ().
|
CodeableConceptDt |
getPhysicalType()
Gets the value(s) for physicalType (class).
|
Location.Position |
getPosition()
Gets the value(s) for position ().
|
String |
getResourceName() |
String |
getStatus()
Gets the value(s) for status (status).
|
BoundCodeDt<LocationStatusEnum> |
getStatusElement()
Gets the value(s) for status (status).
|
FhirVersionEnum |
getStructureFhirVersionEnum() |
List<ContactPointDt> |
getTelecom()
Gets the value(s) for telecom ().
|
ContactPointDt |
getTelecomFirstRep()
Gets the first repetition for telecom (),
creating it if it does not already exist.
|
BoundCodeableConceptDt<LocationTypeEnum> |
getType()
Gets the value(s) for type (class).
|
boolean |
isEmpty() |
Location |
setAddress(AddressDt theValue)
Sets the value(s) for address ()
|
Location |
setDescription(String theString)
Sets the value for description ()
|
Location |
setDescription(StringDt theValue)
Sets the value(s) for description ()
|
Location |
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier (id)
|
Location |
setManagingOrganization(ResourceReferenceDt theValue)
Sets the value(s) for managingOrganization ()
|
Location |
setMode(BoundCodeDt<LocationModeEnum> theValue)
Sets the value(s) for mode (class)
|
Location |
setMode(LocationModeEnum theValue)
Sets the value(s) for mode (class)
|
Location |
setName(String theString)
Sets the value for name ()
|
Location |
setName(StringDt theValue)
Sets the value(s) for name ()
|
Location |
setPartOf(ResourceReferenceDt theValue)
Sets the value(s) for partOf ()
|
Location |
setPhysicalType(CodeableConceptDt theValue)
Sets the value(s) for physicalType (class)
|
Location |
setPosition(Location.Position theValue)
Sets the value(s) for position ()
|
Location |
setStatus(BoundCodeDt<LocationStatusEnum> theValue)
Sets the value(s) for status (status)
|
Location |
setStatus(LocationStatusEnum theValue)
Sets the value(s) for status (status)
|
Location |
setTelecom(List<ContactPointDt> theValue)
Sets the value(s) for telecom ()
|
Location |
setType(BoundCodeableConceptDt<LocationTypeEnum> theValue)
Sets the value(s) for type (class)
|
Location |
setType(LocationTypeEnum theValue)
Sets the value(s) for type (class)
|
getContained, getId, getIdElement, getLanguage, getMeta, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, hasFormatComment
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getContained, getId, getLanguage, getMeta, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata
getIdElement, setId, setId
public static final String SP_IDENTIFIER
Description:
Type: token
Path: Location.identifier
public static final TokenClientParam IDENTIFIER
Description:
Type: token
Path: Location.identifier
public static final String SP_NAME
Description: A (portion of the) name of the location
Type: string
Path: Location.name
public static final StringClientParam NAME
Description: A (portion of the) name of the location
Type: string
Path: Location.name
public static final String SP_TYPE
Description: A code for the type of location
Type: token
Path: Location.type
public static final TokenClientParam TYPE
Description: A code for the type of location
Type: token
Path: Location.type
public static final String SP_ADDRESS
Description: A (part of the) address of the location
Type: string
Path: Location.address
public static final StringClientParam ADDRESS
Description: A (part of the) address of the location
Type: string
Path: Location.address
public static final String SP_ADDRESS_CITY
Description: A city specified in an address
Type: string
Path: Location.address.city
public static final StringClientParam ADDRESS_CITY
Description: A city specified in an address
Type: string
Path: Location.address.city
public static final String SP_ADDRESS_STATE
Description: A state specified in an address
Type: string
Path: Location.address.state
public static final StringClientParam ADDRESS_STATE
Description: A state specified in an address
Type: string
Path: Location.address.state
public static final String SP_ADDRESS_POSTALCODE
Description: A postal code specified in an address
Type: string
Path: Location.address.postalCode
public static final StringClientParam ADDRESS_POSTALCODE
Description: A postal code specified in an address
Type: string
Path: Location.address.postalCode
public static final String SP_ADDRESS_COUNTRY
Description: A country specified in an address
Type: string
Path: Location.address.country
public static final StringClientParam ADDRESS_COUNTRY
Description: A country specified in an address
Type: string
Path: Location.address.country
public static final String SP_ADDRESS_USE
Description: A use code specified in an address
Type: token
Path: Location.address.use
public static final TokenClientParam ADDRESS_USE
Description: A use code specified in an address
Type: token
Path: Location.address.use
public static final String SP_STATUS
Description: Searches for locations with a specific kind of status
Type: token
Path: Location.status
public static final TokenClientParam STATUS
Description: Searches for locations with a specific kind of status
Type: token
Path: Location.status
public static final String SP_PARTOF
Description: The location of which this location is a part
Type: reference
Path: Location.partOf
public static final ReferenceClientParam PARTOF
Description: The location of which this location is a part
Type: reference
Path: Location.partOf
public static final String SP_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
public static final TokenClientParam 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
public static final String SP_NEAR_DISTANCE
Description: A distance quantity to limit the near search to locations within a specific distance
Type: token
Path: Location.position
public static final TokenClientParam NEAR_DISTANCE
Description: A distance quantity to limit the near search to locations within a specific distance
Type: token
Path: Location.position
public static final String SP_ORGANIZATION
Description: Searches for locations that are managed by the provided organization
Type: reference
Path: Location.managingOrganization
public static final ReferenceClientParam ORGANIZATION
Description: Searches for locations that are managed by the provided organization
Type: reference
Path: Location.managingOrganization
public static final Include INCLUDE_ORGANIZATION
public static final Include INCLUDE_PARTOF
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType
in interface ICompositeElement
public List<IdentifierDt> getIdentifier()
null
.
Definition: Unique code or number identifying the location to its users
public Location setIdentifier(List<IdentifierDt> theValue)
Definition: Unique code or number identifying the location to its users
public IdentifierDt addIdentifier()
Definition: Unique code or number identifying the location to its users
public Location addIdentifier(IdentifierDt theValue)
Definition: Unique code or number identifying the location to its users
theValue
- The identifier to add (must not be null
)public IdentifierDt getIdentifierFirstRep()
Definition: Unique code or number identifying the location to its users
public BoundCodeDt<LocationStatusEnum> getStatusElement()
null
.
Definition:
public String getStatus()
null
.
Definition:
public Location setStatus(BoundCodeDt<LocationStatusEnum> theValue)
Definition:
public Location setStatus(LocationStatusEnum theValue)
Definition:
public StringDt getNameElement()
null
.
Definition: Name of the location as used by humans. Does not need to be unique.
public String getName()
null
.
Definition: Name of the location as used by humans. Does not need to be unique.
public Location setName(StringDt theValue)
Definition: Name of the location as used by humans. Does not need to be unique.
public Location setName(String theString)
Definition: Name of the location as used by humans. Does not need to be unique.
public StringDt getDescriptionElement()
null
.
Definition: Description of the Location, which helps in finding or referencing the place
public String getDescription()
null
.
Definition: Description of the Location, which helps in finding or referencing the place
public Location setDescription(StringDt theValue)
Definition: Description of the Location, which helps in finding or referencing the place
public Location setDescription(String theString)
Definition: Description of the Location, which helps in finding or referencing the place
public BoundCodeDt<LocationModeEnum> getModeElement()
null
.
Definition: Indicates whether a resource instance represents a specific location or a class of locations
public String getMode()
null
.
Definition: Indicates whether a resource instance represents a specific location or a class of locations
public Location setMode(BoundCodeDt<LocationModeEnum> theValue)
Definition: Indicates whether a resource instance represents a specific location or a class of locations
public Location setMode(LocationModeEnum theValue)
Definition: Indicates whether a resource instance represents a specific location or a class of locations
public BoundCodeableConceptDt<LocationTypeEnum> getType()
null
.
Definition: Indicates the type of function performed at the location
public Location setType(BoundCodeableConceptDt<LocationTypeEnum> theValue)
Definition: Indicates the type of function performed at the location
public Location setType(LocationTypeEnum theValue)
Definition: Indicates the type of function performed at the location
public List<ContactPointDt> getTelecom()
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
public Location setTelecom(List<ContactPointDt> theValue)
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
public ContactPointDt addTelecom()
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
public Location addTelecom(ContactPointDt theValue)
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
theValue
- The telecom to add (must not be null
)public ContactPointDt getTelecomFirstRep()
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
public AddressDt getAddress()
null
.
Definition:
public Location setAddress(AddressDt theValue)
Definition:
public CodeableConceptDt getPhysicalType()
null
.
Definition: Physical form of the location, e.g. building, room, vehicle, road
public Location setPhysicalType(CodeableConceptDt theValue)
Definition: Physical form of the location, e.g. building, room, vehicle, road
public Location.Position getPosition()
null
.
Definition: The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML)
public Location setPosition(Location.Position theValue)
Definition: The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML)
public ResourceReferenceDt getManagingOrganization()
null
.
Definition: The organization responsible for the provisioning and upkeep of the location
public Location setManagingOrganization(ResourceReferenceDt theValue)
Definition: The organization responsible for the provisioning and upkeep of the location
public ResourceReferenceDt getPartOf()
null
.
Definition: Another Location which this Location is physically part of
public Location setPartOf(ResourceReferenceDt theValue)
Definition: Another Location which this Location is physically part of
public String getResourceName()
getResourceName
in interface IResource
public FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum
in interface IResource
getStructureFhirVersionEnum
in interface IBaseResource
Copyright © 2014–2019 University Health Network. All rights reserved.