org.hl7.fhir.dstu3.model.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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Location.LocationMode`
`static class`	`Location.LocationModeEnumFactory`
`static class`	`Location.LocationPositionComponent`
`static class`	`Location.LocationStatus`
`static class`	`Location.LocationStatusEnumFactory`

Field Summary

Fields
Modifier and Type	Field	Description
`protected Address`	`address`	Physical location.
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`ADDRESS`	Fluent Client search parameter constant for address
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`ADDRESS_CITY`	Fluent Client search parameter constant for address-city
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`ADDRESS_COUNTRY`	Fluent Client search parameter constant for address-country
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`ADDRESS_POSTALCODE`	Fluent Client search parameter constant for address-postalcode
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`ADDRESS_STATE`	Fluent Client search parameter constant for address-state
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`ADDRESS_USE`	Fluent Client search parameter constant for address-use
`protected List<StringType>`	`alias`	A list of�alternate names that the location is known as, or was known as in the past.
`protected StringType`	`description`	Description of the Location, which helps in finding or referencing the place.
`protected List<Reference>`	`endpoint`	Technical endpoints providing access to services operated for the location.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ENDPOINT`	Fluent Client search parameter constant for endpoint
`protected List<Endpoint>`	`endpointTarget`	The actual objects that are the target of the reference (Technical endpoints providing access to services operated for the location.)
`protected List<Identifier>`	`identifier`	Unique code or number identifying the location to its users.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER`	Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ENDPOINT`	Constant for fluent queries to be used to add include statements.
`static 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.
`protected Reference`	`managingOrganization`	The organization responsible for the provisioning and upkeep of the location.
`protected Organization`	`managingOrganizationTarget`	The actual object that is the target of the reference (The organization responsible for the provisioning and upkeep of the location.)
`protected Enumeration<Location.LocationMode>`	`mode`	Indicates whether a resource instance represents a specific location or a class of locations.
`protected StringType`	`name`	Name of the location as used by humans.
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`NAME`	Fluent Client search parameter constant for name
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`NEAR`	Fluent Client search parameter constant for near
`static ca.uhn.fhir.rest.gclient.QuantityClientParam`	`NEAR_DISTANCE`	Fluent Client search parameter constant for near-distance
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`OPERATIONAL_STATUS`	Fluent Client search parameter constant for operational-status
`protected Coding`	`operationalStatus`	The Operational status covers operation values most relevant to beds (but can also apply to rooms/units/chair/etc such as an isolation unit/dialisys chair).
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ORGANIZATION`	Fluent Client search parameter constant for organization
`protected Reference`	`partOf`	Another Location which this Location is physically part of.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PARTOF`	Fluent Client search parameter constant for partof
`protected Location`	`partOfTarget`	The actual object that is the target of the reference (Another Location which this Location is physically part of.)
`protected CodeableConcept`	`physicalType`	Physical form of the location, e.g.
`protected Location.LocationPositionComponent`	`position`	The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
`static String`	`SP_ADDRESS`	Search parameter: address
`static String`	`SP_ADDRESS_CITY`	Search parameter: address-city
`static String`	`SP_ADDRESS_COUNTRY`	Search parameter: address-country
`static String`	`SP_ADDRESS_POSTALCODE`	Search parameter: address-postalcode
`static String`	`SP_ADDRESS_STATE`	Search parameter: address-state
`static String`	`SP_ADDRESS_USE`	Search parameter: address-use
`static String`	`SP_ENDPOINT`	Search parameter: endpoint
`static String`	`SP_IDENTIFIER`	Search parameter: identifier
`static String`	`SP_NAME`	Search parameter: name
`static String`	`SP_NEAR`	Search parameter: near
`static String`	`SP_NEAR_DISTANCE`	Search parameter: near-distance
`static String`	`SP_OPERATIONAL_STATUS`	Search parameter: operational-status
`static String`	`SP_ORGANIZATION`	Search parameter: organization
`static String`	`SP_PARTOF`	Search parameter: partof
`static String`	`SP_STATUS`	Search parameter: status
`static String`	`SP_TYPE`	Search parameter: type
`protected Enumeration<Location.LocationStatus>`	`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.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS`	Fluent Client search parameter constant for status
`protected List<ContactPoint>`	`telecom`	The contact details of communication devices available at the location.
`protected CodeableConcept`	`type`	Indicates the type of function performed at the location.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`TYPE`	Fluent Client search parameter constant for type

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

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()
Constructor

Method Summary

Modifier and Type	Method	Description
`Location`	`addAlias(String value)`
`StringType`	`addAliasElement()`
`Base`	`addChild(String name)`
`Reference`	`addEndpoint()`
`Location`	`addEndpoint(Reference t)`
`Endpoint`	`addEndpointTarget()`	Deprecated. Use Reference#setResource(IBaseResource) instead
`Identifier`	`addIdentifier()`
`Location`	`addIdentifier(Identifier t)`
`ContactPoint`	`addTelecom()`
`Location`	`addTelecom(ContactPoint t)`
`Location`	`copy()`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`Address`	`getAddress()`
`List<StringType>`	`getAlias()`
`String`	`getDescription()`
`StringType`	`getDescriptionElement()`
`List<Reference>`	`getEndpoint()`
`Reference`	`getEndpointFirstRep()`
`List<Endpoint>`	`getEndpointTarget()`	Deprecated. Use Reference#setResource(IBaseResource) instead
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`Reference`	`getManagingOrganization()`
`Organization`	`getManagingOrganizationTarget()`
`Location.LocationMode`	`getMode()`
`Enumeration<Location.LocationMode>`	`getModeElement()`
`String`	`getName()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`StringType`	`getNameElement()`
`Coding`	`getOperationalStatus()`
`Reference`	`getPartOf()`
`Location`	`getPartOfTarget()`
`CodeableConcept`	`getPhysicalType()`
`Location.LocationPositionComponent`	`getPosition()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`ResourceType`	`getResourceType()`
`Location.LocationStatus`	`getStatus()`
`Enumeration<Location.LocationStatus>`	`getStatusElement()`
`List<ContactPoint>`	`getTelecom()`
`ContactPoint`	`getTelecomFirstRep()`
`CodeableConcept`	`getType()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasAddress()`
`boolean`	`hasAlias()`
`boolean`	`hasAlias(String value)`
`boolean`	`hasDescription()`
`boolean`	`hasDescriptionElement()`
`boolean`	`hasEndpoint()`
`boolean`	`hasIdentifier()`
`boolean`	`hasManagingOrganization()`
`boolean`	`hasMode()`
`boolean`	`hasModeElement()`
`boolean`	`hasName()`
`boolean`	`hasNameElement()`
`boolean`	`hasOperationalStatus()`
`boolean`	`hasPartOf()`
`boolean`	`hasPhysicalType()`
`boolean`	`hasPosition()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasTelecom()`
`boolean`	`hasType()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`Location`	`setAddress(Address value)`
`Location`	`setAlias(List<StringType> theAlias)`
`Location`	`setDescription(String value)`
`Location`	`setDescriptionElement(StringType value)`
`Location`	`setEndpoint(List<Reference> theEndpoint)`
`Location`	`setIdentifier(List<Identifier> theIdentifier)`
`Location`	`setManagingOrganization(Reference value)`
`Location`	`setManagingOrganizationTarget(Organization value)`
`Location`	`setMode(Location.LocationMode value)`
`Location`	`setModeElement(Enumeration<Location.LocationMode> value)`
`Location`	`setName(String value)`
`Location`	`setNameElement(StringType value)`
`Location`	`setOperationalStatus(Coding value)`
`Location`	`setPartOf(Reference value)`
`Location`	`setPartOfTarget(Location value)`
`Location`	`setPhysicalType(CodeableConcept value)`
`Location`	`setPosition(Location.LocationPositionComponent value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Location`	`setStatus(Location.LocationStatus value)`
`Location`	`setStatusElement(Enumeration<Location.LocationStatus> value)`
`Location`	`setTelecom(List<ContactPoint> theTelecom)`
`Location`	`setType(CodeableConcept value)`
`protected Location`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.dstu3.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, setId

Field Details
- identifier
  
  protected List<Identifier> identifier
  
  Unique code or number identifying the location to its users.
- status
  
  protected Enumeration<Location.LocationStatus> 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
  
  protected Coding operationalStatus
  
  The Operational status covers operation values most relevant to beds (but can also apply to rooms/units/chair/etc such as an isolation unit/dialisys 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
  
  protected StringType description
  
  Description of the Location, which helps in finding or referencing the place.
- mode
  
  protected Enumeration<Location.LocationMode> mode
  
  Indicates whether a resource instance represents a specific location or a class of locations.
- type
  
  protected CodeableConcept type
  
  Indicates the type of function performed at the location.
- telecom
  
  protected List<ContactPoint> 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
  
  protected CodeableConcept physicalType
  
  Physical form of the location, e.g. building, room, vehicle, road.
- position
  
  protected Location.LocationPositionComponent position
  
  The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
- managingOrganization
  
  protected Reference managingOrganization
  
  The organization responsible for the provisioning and upkeep of the location.
- managingOrganizationTarget
  
  protected Organization managingOrganizationTarget
  
  The actual object that is the target of the reference (The organization responsible for the provisioning and upkeep of the location.)
- partOf
  
  protected Reference partOf
  
  Another Location which this Location is physically part of.
- partOfTarget
  
  protected Location partOfTarget
  
  The actual object that is the target of the reference (Another Location which this Location is physically part of.)
- endpoint
  
  protected List<Reference> endpoint
  
  Technical endpoints providing access to services operated for the location.
- endpointTarget
  
  protected List<Endpoint> endpointTarget
  
  The actual objects that are the target of the reference (Technical endpoints providing access to services operated for the location.)
- SP_IDENTIFIER
  
  public static final String SP_IDENTIFIER
  
  Search parameter: identifier
  Description: An identifier for the location
  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: An identifier for the location
  Type: token
  Path: Location.identifier
- 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:
  
  Constant Field Values
- 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_NEAR_DISTANCE
  
  public static final String SP_NEAR_DISTANCE
  
  Search parameter: near-distance
  Description: A distance quantity to limit the near search to locations within a specific distance Requires the near parameter to also be included
  Type: quantity
  Path: Location.position
  
  See Also:
  
  Constant Field Values
- NEAR_DISTANCE
  
  public static final ca.uhn.fhir.rest.gclient.QuantityClientParam 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 Requires the near parameter to also be included
  Type: quantity
  Path: Location.position
- 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:
  
  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_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:
  
  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_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:
  
  Constant Field Values
- 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_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:
  
  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_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:
  
  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: 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_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:
  
  Constant Field Values
- 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_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:
  
  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".
- 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:
  
  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 location's name or alias
  Type: string
  Path: Location.name, Location.alias
- 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:
  
  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_NEAR
  
  public static final String SP_NEAR
  
  Search parameter: near
  Description: The coordinates expressed as [latitude]:[longitude] (using the WGS84 datum, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency) Requires the near-distance parameter to be provided also
  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 [latitude]:[longitude] (using the WGS84 datum, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency) Requires the near-distance parameter to be provided also
  Type: token
  Path: Location.position
- 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:
  
  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_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:
  
  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
Constructor Details
- Location
  
  public Location()
  
  Constructor
Method Details
- getIdentifier
  
  public List<Identifier> getIdentifier()
  
  Returns:
  
  identifier (Unique code or number identifying the location to its users.)
- setIdentifier
  
  public Location setIdentifier(List<Identifier> theIdentifier)
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasIdentifier
  
  public boolean hasIdentifier()
- addIdentifier
  
  public Identifier addIdentifier()
- addIdentifier
  
  public Location addIdentifier(Identifier t)
- getIdentifierFirstRep
  
  public Identifier getIdentifierFirstRep()
  
  Returns:
  
  The first repetition of repeating field identifier, creating it if it does not already exist
- getStatusElement
  
  public Enumeration<Location.LocationStatus> getStatusElement()
  
  Returns:
  
  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.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
- hasStatusElement
  
  public boolean hasStatusElement()
- hasStatus
  
  public boolean hasStatus()
- setStatusElement
  
  public Location setStatusElement(Enumeration<Location.LocationStatus> value)
  
  Parameters:
  
  value - 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.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
- getStatus
  
  public Location.LocationStatus getStatus()
  
  Returns:
  
  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.
- setStatus
  
  public Location setStatus(Location.LocationStatus value)
  
  Parameters:
  
  value - 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.
- getOperationalStatus
  
  public Coding getOperationalStatus()
  
  Returns:
  
  operationalStatus (The Operational status covers operation values most relevant to beds (but can also apply to rooms/units/chair/etc such as an isolation unit/dialisys chair). This typically covers concepts such as contamination, housekeeping and other activities�like maintenance.)
- hasOperationalStatus
  
  public boolean hasOperationalStatus()
- setOperationalStatus
  
  public Location setOperationalStatus(Coding value)
  
  Parameters:
  
  value - operationalStatus (The Operational status covers operation values most relevant to beds (but can also apply to rooms/units/chair/etc such as an isolation unit/dialisys chair). This typically covers concepts such as contamination, housekeeping and other activities�like maintenance.)
- getNameElement
  
  public StringType getNameElement()
  
  Returns:
  
  name (Name of the location as used by humans. Does not need to be unique.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
- hasNameElement
  
  public boolean hasNameElement()
- hasName
  
  public boolean hasName()
- setNameElement
  
  public Location setNameElement(StringType value)
  
  Parameters:
  
  value - name (Name of the location as used by humans. Does not need to be unique.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
- getName
  
  public String getName()
  
  Returns:
  
  Name of the location as used by humans. Does not need to be unique.
- setName
  
  public Location setName(String value)
  
  Parameters:
  
  value - Name of the location as used by humans. Does not need to be unique.
- getAlias
  
  public List<StringType> getAlias()
  
  Returns:
  
  alias (A list of�alternate names that the location is known as, or was known as in the past.)
- setAlias
  
  public Location setAlias(List<StringType> theAlias)
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasAlias
  
  public boolean hasAlias()
- addAliasElement
  
  public StringType addAliasElement()
  
  Returns:
  
  alias (A list of�alternate names that the location is known as, or was known as in the past.)
- addAlias
  
  public Location addAlias(String value)
  
  Parameters:
  
  value - alias (A list of�alternate names that the location is known as, or was known as in the past.)
- hasAlias
  
  public boolean hasAlias(String value)
  
  Parameters:
  
  value - alias (A list of�alternate names that the location is known as, or was known as in the past.)
- getDescriptionElement
  
  public StringType getDescriptionElement()
  
  Returns:
  
  description (Description of the Location, which helps in finding or referencing the place.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
- hasDescriptionElement
  
  public boolean hasDescriptionElement()
- hasDescription
  
  public boolean hasDescription()
- setDescriptionElement
  
  public Location setDescriptionElement(StringType value)
  
  Parameters:
  
  value - description (Description of the Location, which helps in finding or referencing the place.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
- getDescription
  
  public String getDescription()
  
  Returns:
  
  Description of the Location, which helps in finding or referencing the place.
- setDescription
  
  public Location setDescription(String value)
  
  Parameters:
  
  value - Description of the Location, which helps in finding or referencing the place.
- getModeElement
  
  public Enumeration<Location.LocationMode> getModeElement()
  
  Returns:
  
  mode (Indicates whether a resource instance represents a specific location or a class of locations.). This is the underlying object with id, value and extensions. The accessor "getMode" gives direct access to the value
- hasModeElement
  
  public boolean hasModeElement()
- hasMode
  
  public boolean hasMode()
- setModeElement
  
  public Location setModeElement(Enumeration<Location.LocationMode> value)
  
  Parameters:
  
  value - mode (Indicates whether a resource instance represents a specific location or a class of locations.). This is the underlying object with id, value and extensions. The accessor "getMode" gives direct access to the value
- getMode
  
  public Location.LocationMode getMode()
  
  Returns:
  
  Indicates whether a resource instance represents a specific location or a class of locations.
- setMode
  
  public Location setMode(Location.LocationMode value)
  
  Parameters:
  
  value - Indicates whether a resource instance represents a specific location or a class of locations.
- getType
  
  public CodeableConcept getType()
  
  Returns:
  
  type (Indicates the type of function performed at the location.)
- hasType
  
  public boolean hasType()
- setType
  
  public Location setType(CodeableConcept value)
  
  Parameters:
  
  value - type (Indicates the type of function performed at the location.)
- getTelecom
  
  public List<ContactPoint> getTelecom()
  
  Returns:
  
  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.)
- setTelecom
  
  public Location setTelecom(List<ContactPoint> theTelecom)
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasTelecom
  
  public boolean hasTelecom()
- addTelecom
  
  public ContactPoint addTelecom()
- addTelecom
  
  public Location addTelecom(ContactPoint t)
- getTelecomFirstRep
  
  public ContactPoint getTelecomFirstRep()
  
  Returns:
  
  The first repetition of repeating field telecom, creating it if it does not already exist
- getAddress
  
  public Address getAddress()
  
  Returns:
  
  address (Physical location.)
- hasAddress
  
  public boolean hasAddress()
- setAddress
  
  public Location setAddress(Address value)
  
  Parameters:
  
  value - address (Physical location.)
- getPhysicalType
  
  public CodeableConcept getPhysicalType()
  
  Returns:
  
  physicalType (Physical form of the location, e.g. building, room, vehicle, road.)
- hasPhysicalType
  
  public boolean hasPhysicalType()
- setPhysicalType
  
  public Location setPhysicalType(CodeableConcept value)
  
  Parameters:
  
  value - physicalType (Physical form of the location, e.g. building, room, vehicle, road.)
- getPosition
  
  public Location.LocationPositionComponent getPosition()
  
  Returns:
  
  position (The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).)
- hasPosition
  
  public boolean hasPosition()
- setPosition
  
  public Location setPosition(Location.LocationPositionComponent value)
  
  Parameters:
  
  value - position (The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).)
- getManagingOrganization
  
  public Reference getManagingOrganization()
  
  Returns:
  
  managingOrganization (The organization responsible for the provisioning and upkeep of the location.)
- hasManagingOrganization
  
  public boolean hasManagingOrganization()
- setManagingOrganization
  
  public Location setManagingOrganization(Reference value)
  
  Parameters:
  
  value - managingOrganization (The organization responsible for the provisioning and upkeep of the location.)
- getManagingOrganizationTarget
  
  public Organization getManagingOrganizationTarget()
  
  Returns:
  
  managingOrganization The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The organization responsible for the provisioning and upkeep of the location.)
- setManagingOrganizationTarget
  
  public Location setManagingOrganizationTarget(Organization value)
  
  Parameters:
  
  value - managingOrganization The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The organization responsible for the provisioning and upkeep of the location.)
- getPartOf
  
  public Reference getPartOf()
  
  Returns:
  
  partOf (Another Location which this Location is physically part of.)
- hasPartOf
  
  public boolean hasPartOf()
- setPartOf
  
  public Location setPartOf(Reference value)
  
  Parameters:
  
  value - partOf (Another Location which this Location is physically part of.)
- getPartOfTarget
  
  public Location getPartOfTarget()
  
  Returns:
  
  partOf The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Another Location which this Location is physically part of.)
- setPartOfTarget
  
  public Location setPartOfTarget(Location value)
  
  Parameters:
  
  value - partOf The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Another Location which this Location is physically part of.)
- getEndpoint
  
  public List<Reference> getEndpoint()
  
  Returns:
  
  endpoint (Technical endpoints providing access to services operated for the location.)
- setEndpoint
  
  public Location setEndpoint(List<Reference> theEndpoint)
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasEndpoint
  
  public boolean hasEndpoint()
- addEndpoint
  
  public Reference addEndpoint()
- addEndpoint
  
  public Location addEndpoint(Reference t)
- getEndpointFirstRep
  
  public Reference getEndpointFirstRep()
  
  Returns:
  
  The first repetition of repeating field endpoint, creating it if it does not already exist
- getEndpointTarget
  
  @Deprecated public List<Endpoint> getEndpointTarget()
  
  Deprecated.
  Use Reference#setResource(IBaseResource) instead
- addEndpointTarget
  
  @Deprecated public Endpoint addEndpointTarget()
  
  Deprecated.
  Use Reference#setResource(IBaseResource) instead
- listChildren
  
  protected void listChildren(List<Property> children)
  
  Overrides:
  
  listChildren in class DomainResource
- getNamedProperty
  
  public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  getNamedProperty in class DomainResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- getProperty
  
  public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  getProperty in class DomainResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- setProperty
  
  public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  setProperty in class DomainResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- setProperty
  
  public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  setProperty in class DomainResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- makeProperty
  
  public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  makeProperty in class DomainResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- getTypesForProperty
  
  public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  getTypesForProperty in class DomainResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- addChild
  
  public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  addChild in class DomainResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- fhirType
  
  public String fhirType()
  
  Specified by:
  
  fhirType in interface org.hl7.fhir.instance.model.api.IBase
  
  Overrides:
  
  fhirType in class DomainResource
- copy
  
  public Location copy()
  
  Specified by:
  
  copy in class DomainResource
- typedCopy
  
  protected Location typedCopy()
- equalsDeep
  
  public boolean equalsDeep(Base other_)
  
  Overrides:
  
  equalsDeep in class DomainResource
- equalsShallow
  
  public boolean equalsShallow(Base other_)
  
  Overrides:
  
  equalsShallow in class DomainResource
- isEmpty
  
  public boolean isEmpty()
  
  Specified by:
  
  isEmpty in interface org.hl7.fhir.instance.model.api.IBase
  
  Overrides:
  
  isEmpty in class DomainResource
- getResourceType
  
  public ResourceType getResourceType()
  
  Specified by:
  
  getResourceType in class Resource

Class Location

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource

Methods inherited from class org.hl7.fhir.dstu3.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Field Details

identifier

status

operationalStatus

name

alias

description

mode

type

telecom

address

physicalType

position

managingOrganization

managingOrganizationTarget

partOf

partOfTarget

endpoint

endpointTarget

SP_IDENTIFIER

IDENTIFIER

SP_PARTOF

PARTOF

INCLUDE_PARTOF

SP_NEAR_DISTANCE

NEAR_DISTANCE

SP_ADDRESS

ADDRESS

SP_ADDRESS_STATE

ADDRESS_STATE

SP_OPERATIONAL_STATUS

OPERATIONAL_STATUS

SP_TYPE

TYPE

SP_ADDRESS_POSTALCODE

ADDRESS_POSTALCODE

SP_ADDRESS_COUNTRY

ADDRESS_COUNTRY

SP_ENDPOINT

ENDPOINT

INCLUDE_ENDPOINT

SP_ORGANIZATION

ORGANIZATION

INCLUDE_ORGANIZATION

SP_NAME

NAME

SP_ADDRESS_USE

ADDRESS_USE

SP_NEAR

NEAR

SP_ADDRESS_CITY

ADDRESS_CITY

SP_STATUS

STATUS

Constructor Details

Location

Method Details

getIdentifier

setIdentifier

hasIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep