
Class 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
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
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Location.Position
Block class for child element: Location.position () -
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.StringClientParam
ADDRESS
Fluent Client search parameter constant for addressstatic ca.uhn.fhir.rest.gclient.StringClientParam
ADDRESS_CITY
Fluent Client search parameter constant for address-citystatic ca.uhn.fhir.rest.gclient.StringClientParam
ADDRESS_COUNTRY
Fluent Client search parameter constant for address-countrystatic ca.uhn.fhir.rest.gclient.StringClientParam
ADDRESS_POSTALCODE
Fluent Client search parameter constant for address-postalcodestatic ca.uhn.fhir.rest.gclient.StringClientParam
ADDRESS_STATE
Fluent Client search parameter constant for address-statestatic ca.uhn.fhir.rest.gclient.TokenClientParam
ADDRESS_USE
Fluent Client search parameter constant for address-usestatic ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.Include
INCLUDE_ORGANIZATION
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PARTOF
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.StringClientParam
NAME
Fluent Client search parameter constant for namestatic ca.uhn.fhir.rest.gclient.TokenClientParam
NEAR
Fluent Client search parameter constant for nearstatic ca.uhn.fhir.rest.gclient.TokenClientParam
NEAR_DISTANCE
Fluent Client search parameter constant for near-distancestatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
ORGANIZATION
Fluent Client search parameter constant for organizationstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
PARTOF
Fluent Client search parameter constant for partofstatic String
SP_ADDRESS
Search parameter constant for addressstatic String
SP_ADDRESS_CITY
Search parameter constant for address-citystatic String
SP_ADDRESS_COUNTRY
Search parameter constant for address-countrystatic String
SP_ADDRESS_POSTALCODE
Search parameter constant for address-postalcodestatic String
SP_ADDRESS_STATE
Search parameter constant for address-statestatic String
SP_ADDRESS_USE
Search parameter constant for address-usestatic String
SP_IDENTIFIER
Search parameter constant for identifierstatic String
SP_NAME
Search parameter constant for namestatic String
SP_NEAR
Search parameter constant for nearstatic String
SP_NEAR_DISTANCE
Search parameter constant for near-distancestatic String
SP_ORGANIZATION
Search parameter constant for organizationstatic String
SP_PARTOF
Search parameter constant for partofstatic String
SP_STATUS
Search parameter constant for statusstatic String
SP_TYPE
Search parameter constant for typestatic ca.uhn.fhir.rest.gclient.TokenClientParam
STATUS
Fluent Client search parameter constant for statusstatic ca.uhn.fhir.rest.gclient.TokenClientParam
TYPE
Fluent Client search parameter constant for typeFields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
Constructors Constructor Description Location()
-
Method Summary
Modifier and Type Method 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 ca.uhn.fhir.model.api.IElement>
List<T>getAllPopulatedChildElementsOfType(Class<T> theType)
String
getDescription()
Gets the value(s) for description ().ca.uhn.fhir.model.primitive.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).ca.uhn.fhir.model.primitive.BoundCodeDt<LocationModeEnum>
getModeElement()
Gets the value(s) for mode (class).String
getName()
Gets the value(s) for name ().ca.uhn.fhir.model.primitive.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).ca.uhn.fhir.model.primitive.BoundCodeDt<LocationStatusEnum>
getStatusElement()
Gets the value(s) for status (status).ca.uhn.fhir.context.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(ca.uhn.fhir.model.primitive.StringDt theValue)
Sets the value(s) for description ()Location
setDescription(String theString)
Sets the value 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(LocationModeEnum theValue)
Sets the value(s) for mode (class)Location
setMode(ca.uhn.fhir.model.primitive.BoundCodeDt<LocationModeEnum> theValue)
Sets the value(s) for mode (class)Location
setName(ca.uhn.fhir.model.primitive.StringDt theValue)
Sets the value(s) for name ()Location
setName(String theString)
Sets the value 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(LocationStatusEnum theValue)
Sets the value(s) for status (status)Location
setStatus(ca.uhn.fhir.model.primitive.BoundCodeDt<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)Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getMeta, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString
Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, setUserData
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId
Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getMeta, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata
-
Field Details
-
SP_IDENTIFIER
Search parameter constant for identifierDescription:
Type: token
Path: Location.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription:
Type: token
Path: Location.identifier
-
SP_NAME
Search parameter constant for nameDescription: A (portion of the) name of the location
Type: string
Path: Location.name
- See Also:
- Constant Field Values
-
NAME
Fluent Client search parameter constant for nameDescription: A (portion of the) name of the location
Type: string
Path: Location.name
-
SP_TYPE
Search parameter constant for typeDescription: A code for the type of location
Type: token
Path: Location.type
- See Also:
- Constant Field Values
-
TYPE
Fluent Client search parameter constant for typeDescription: A code for the type of location
Type: token
Path: Location.type
-
SP_ADDRESS
Search parameter constant for addressDescription: A (part of the) address of the location
Type: string
Path: Location.address
- See Also:
- Constant Field Values
-
ADDRESS
Fluent Client search parameter constant for addressDescription: A (part of the) address of the location
Type: string
Path: Location.address
-
SP_ADDRESS_CITY
Search parameter constant for address-cityDescription: A city specified in an address
Type: string
Path: Location.address.city
- See Also:
- Constant Field Values
-
ADDRESS_CITY
Fluent Client search parameter constant for address-cityDescription: A city specified in an address
Type: string
Path: Location.address.city
-
SP_ADDRESS_STATE
Search parameter constant for address-stateDescription: A state specified in an address
Type: string
Path: Location.address.state
- See Also:
- Constant Field Values
-
ADDRESS_STATE
Fluent Client search parameter constant for address-stateDescription: A state specified in an address
Type: string
Path: Location.address.state
-
SP_ADDRESS_POSTALCODE
Search parameter constant for address-postalcodeDescription: A postal code specified in an address
Type: string
Path: Location.address.postalCode
- See Also:
- Constant Field Values
-
ADDRESS_POSTALCODE
Fluent Client search parameter constant for address-postalcodeDescription: A postal code specified in an address
Type: string
Path: Location.address.postalCode
-
SP_ADDRESS_COUNTRY
Search parameter constant for address-countryDescription: A country specified in an address
Type: string
Path: Location.address.country
- See Also:
- Constant Field Values
-
ADDRESS_COUNTRY
Fluent Client search parameter constant for address-countryDescription: A country specified in an address
Type: string
Path: Location.address.country
-
SP_ADDRESS_USE
Search parameter constant for address-useDescription: A use code specified in an address
Type: token
Path: Location.address.use
- See Also:
- Constant Field Values
-
ADDRESS_USE
Fluent Client search parameter constant for address-useDescription: A use code specified in an address
Type: token
Path: Location.address.use
-
SP_STATUS
Search parameter constant for statusDescription: Searches for locations with a specific kind of status
Type: token
Path: Location.status
- See Also:
- Constant Field Values
-
STATUS
Fluent Client search parameter constant for statusDescription: Searches for locations with a specific kind of status
Type: token
Path: Location.status
-
SP_PARTOF
Search parameter constant for partofDescription: The location of which this location is a part
Type: reference
Path: Location.partOf
- See Also:
- Constant Field Values
-
PARTOF
Fluent Client search parameter constant for partofDescription: The location of which this location is a part
Type: reference
Path: Location.partOf
-
SP_NEAR
Search parameter constant for nearDescription: 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
Fluent Client search parameter constant for nearDescription: 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
Search parameter constant for near-distanceDescription: 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
Fluent Client search parameter constant for near-distanceDescription: A distance quantity to limit the near search to locations within a specific distance
Type: token
Path: Location.position
-
SP_ORGANIZATION
Search parameter constant for organizationDescription: Searches for locations that are managed by the provided organization
Type: reference
Path: Location.managingOrganization
- See Also:
- Constant Field Values
-
ORGANIZATION
Fluent Client search parameter constant for organizationDescription: Searches for locations that are managed by the provided organization
Type: reference
Path: Location.managingOrganization
-
INCLUDE_ORGANIZATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Location:organization". -
INCLUDE_PARTOF
Constant for fluent queries to be used to add include statements. Specifies the path value of "Location:partof".
-
-
Constructor Details
-
Location
public Location()
-
-
Method Details
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.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 interfaceca.uhn.fhir.model.api.ICompositeElement
-
getIdentifier
Gets the value(s) for identifier (id). creating it if it does not exist. Will not returnnull
.Definition: Unique code or number identifying the location to its users
-
setIdentifier
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
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 benull
)
-
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
Gets the value(s) for status (status). creating it if it does not exist. Will not returnnull
.Definition:
-
getStatus
Gets the value(s) for status (status). creating it if it does not exist. This method may returnnull
.Definition:
-
setStatus
Sets the value(s) for status (status)Definition:
-
setStatus
Sets the value(s) for status (status)Definition:
-
getNameElement
Gets the value(s) for name (). creating it if it does not exist. Will not returnnull
.Definition: Name of the location as used by humans. Does not need to be unique.
-
getName
Gets the value(s) for name (). creating it if it does not exist. This method may returnnull
.Definition: Name of the location as used by humans. Does not need to be unique.
-
setName
Sets the value(s) for name ()Definition: Name of the location as used by humans. Does not need to be unique.
-
setName
Sets the value for name ()Definition: Name of the location as used by humans. Does not need to be unique.
-
getDescriptionElement
Gets the value(s) for description (). creating it if it does not exist. Will not returnnull
.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 returnnull
.Definition: Description of the Location, which helps in finding or referencing the place
-
setDescription
Sets the value(s) for description ()Definition: Description of the Location, which helps in finding or referencing the place
-
setDescription
Sets the value for description ()Definition: Description of the Location, which helps in finding or referencing the place
-
getModeElement
Gets the value(s) for mode (class). creating it if it does not exist. Will not returnnull
.Definition: Indicates whether a resource instance represents a specific location or a class of locations
-
getMode
Gets the value(s) for mode (class). creating it if it does not exist. This method may returnnull
.Definition: Indicates whether a resource instance represents a specific location or a class of locations
-
setMode
Sets the value(s) for mode (class)Definition: Indicates whether a resource instance represents a specific location or a class of locations
-
setMode
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 returnnull
.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
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 returnnull
.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
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
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 benull
)
-
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 returnnull
.Definition:
-
setAddress
Sets the value(s) for address ()Definition:
-
getPhysicalType
Gets the value(s) for physicalType (class). creating it if it does not exist. Will not returnnull
.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 returnnull
.Definition: The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML)
-
setPosition
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 returnnull
.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 returnnull
.Definition: Another Location which this Location is physically part of
-
setPartOf
Sets the value(s) for partOf ()Definition: Another Location which this Location is physically part of
-
getResourceName
- Specified by:
getResourceName
in interfaceca.uhn.fhir.model.api.IResource
-
getStructureFhirVersionEnum
- Specified by:
getStructureFhirVersionEnum
in interfaceorg.hl7.fhir.instance.model.api.IBaseResource
- Specified by:
getStructureFhirVersionEnum
in interfaceca.uhn.fhir.model.api.IResource
-