Package org.hl7.fhir.r5.model

Class Location

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.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 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 enum	Location.LocationMode
static class	Location.LocationModeEnumFactory
static class	Location.LocationPositionComponent
static enum	Location.LocationStatus
static class	Location.LocationStatusEnumFactory

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected Address	address	Physical location.
static final ca.uhn.fhir.rest.gclient.StringClientParam	ADDRESS	Fluent Client search parameter constant for address
static final ca.uhn.fhir.rest.gclient.StringClientParam	ADDRESS_CITY	Fluent Client search parameter constant for address-city
static final ca.uhn.fhir.rest.gclient.StringClientParam	ADDRESS_COUNTRY	Fluent Client search parameter constant for address-country
static final ca.uhn.fhir.rest.gclient.StringClientParam	ADDRESS_POSTALCODE	Fluent Client search parameter constant for address-postalcode
static final ca.uhn.fhir.rest.gclient.StringClientParam	ADDRESS_STATE	Fluent Client search parameter constant for address-state
static final 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 List<CodeableConcept>	characteristic	Collection of characteristics (attributes).
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CHARACTERISTIC	Fluent Client search parameter constant for characteristic
protected List<ExtendedContactDetail>	contact	The contact details of communication devices available at the location.
static final ca.uhn.fhir.rest.gclient.SpecialClientParam	CONTAINS	Fluent Client search parameter constant for contains
protected MarkdownType	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 final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENDPOINT	Fluent Client search parameter constant for endpoint
protected CodeableConcept	form	Physical form of the location, e.g.
protected List<Availability>	hoursOfOperation	What days/times during a week is this location usually open, and any exceptions where the location is not available.
protected List<Identifier>	identifier	Unique code or number identifying the location to its users.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_ENDPOINT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ORGANIZATION	Constant for fluent queries to be used to add include statements.
static final 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 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 final ca.uhn.fhir.rest.gclient.StringClientParam	NAME	Fluent Client search parameter constant for name
static final ca.uhn.fhir.rest.gclient.SpecialClientParam	NEAR	Fluent Client search parameter constant for near
static final 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/chairs/etc.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ORGANIZATION	Fluent Client search parameter constant for organization
protected Reference	partOf	Another Location of which this Location is physically a part of.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PARTOF	Fluent Client search parameter constant for partof
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 final String	SP_ADDRESS	Search parameter: address
static final String	SP_ADDRESS_CITY	Search parameter: address-city
static final String	SP_ADDRESS_COUNTRY	Search parameter: address-country
static final String	SP_ADDRESS_POSTALCODE	Search parameter: address-postalcode
static final String	SP_ADDRESS_STATE	Search parameter: address-state
static final String	SP_ADDRESS_USE	Search parameter: address-use
static final String	SP_CHARACTERISTIC	Search parameter: characteristic
static final String	SP_CONTAINS	Search parameter: contains
static final String	SP_ENDPOINT	Search parameter: endpoint
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_NAME	Search parameter: name
static final String	SP_NEAR	Search parameter: near
static final String	SP_OPERATIONAL_STATUS	Search parameter: operational-status
static final String	SP_ORGANIZATION	Search parameter: organization
static final String	SP_PARTOF	Search parameter: partof
static final String	SP_STATUS	Search parameter: status
static final 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 final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected List<CodeableConcept>	type	Indicates the type of function performed at the location.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TYPE	Fluent Client search parameter constant for type
protected List<VirtualServiceDetail>	virtualService	Connection details of a virtual service (e.g.

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

contained, extension, modifierExtension, SP_TEXT, text, TEXT

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

id, implicitRules, language, meta

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

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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()
CodeableConcept	addCharacteristic()
Location	addCharacteristic(CodeableConcept t)
Base	addChild(String name)
ExtendedContactDetail	addContact()
Location	addContact(ExtendedContactDetail t)
Reference	addEndpoint()
Location	addEndpoint(Reference t)
Availability	addHoursOfOperation()
Location	addHoursOfOperation(Availability t)
Identifier	addIdentifier()
Location	addIdentifier(Identifier t)
CodeableConcept	addType()
Location	addType(CodeableConcept t)
VirtualServiceDetail	addVirtualService()
Location	addVirtualService(VirtualServiceDetail t)
Location	copy()
void	copyValues(Location dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Address	getAddress()
List<StringType>	getAlias()
List<CodeableConcept>	getCharacteristic()
CodeableConcept	getCharacteristicFirstRep()
List<ExtendedContactDetail>	getContact()
ExtendedContactDetail	getContactFirstRep()
String	getDescription()
MarkdownType	getDescriptionElement()
List<Reference>	getEndpoint()
Reference	getEndpointFirstRep()
CodeableConcept	getForm()
List<Availability>	getHoursOfOperation()
Availability	getHoursOfOperationFirstRep()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
Reference	getManagingOrganization()
Location.LocationMode	getMode()
Enumeration<Location.LocationMode>	getModeElement()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
Coding	getOperationalStatus()
Reference	getPartOf()
Location.LocationPositionComponent	getPosition()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
Location.LocationStatus	getStatus()
Enumeration<Location.LocationStatus>	getStatusElement()
List<CodeableConcept>	getType()
CodeableConcept	getTypeFirstRep()
String[]	getTypesForProperty(int hash, String name)
List<VirtualServiceDetail>	getVirtualService()
VirtualServiceDetail	getVirtualServiceFirstRep()
boolean	hasAddress()
boolean	hasAlias()
boolean	hasAlias(String value)
boolean	hasCharacteristic()
boolean	hasContact()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasEndpoint()
boolean	hasForm()
boolean	hasHoursOfOperation()
boolean	hasIdentifier()
boolean	hasManagingOrganization()
boolean	hasMode()
boolean	hasModeElement()
boolean	hasName()
boolean	hasNameElement()
boolean	hasOperationalStatus()
boolean	hasPartOf()
boolean	hasPosition()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasType()
boolean	hasVirtualService()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Location	setAddress(Address value)
Location	setAlias(List<StringType> theAlias)
Location	setCharacteristic(List<CodeableConcept> theCharacteristic)
Location	setContact(List<ExtendedContactDetail> theContact)
Location	setDescription(String value)
Location	setDescriptionElement(MarkdownType value)
Location	setEndpoint(List<Reference> theEndpoint)
Location	setForm(CodeableConcept value)
Location	setHoursOfOperation(List<Availability> theHoursOfOperation)
Location	setIdentifier(List<Identifier> theIdentifier)
Location	setManagingOrganization(Reference 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	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	setType(List<CodeableConcept> theType)
Location	setVirtualService(List<VirtualServiceDetail> theVirtualService)
protected Location	typedCopy()

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

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

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

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

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

getStructureFhirVersionEnum, isResource, setId

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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, isDeleted, 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/chairs/etc. such as an isolation unit/dialysis 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 MarkdownType 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 List<CodeableConcept> type

Indicates the type of function performed at the location.

contact

protected List<ExtendedContactDetail> contact

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

address

protected Address address

Physical location.

form

protected CodeableConcept form

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

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.

partOf

protected Reference partOf

Another Location of which this Location is physically a part of.

characteristic

protected List<CodeableConcept> characteristic

Collection of characteristics (attributes).

hoursOfOperation

protected List<Availability> hoursOfOperation

What days/times during a week is this location usually open, and any exceptions where the location is not available.

virtualService

protected List<VirtualServiceDetail> virtualService

Connection details of a virtual service (e.g. shared conference call facility with dedicated number/details).

endpoint

protected List<Reference> endpoint

Technical endpoints providing access to services operated for the location.

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_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_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_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_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_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_CHARACTERISTIC

public static final String SP_CHARACTERISTIC

Search parameter: characteristic

Description: One of the Location's characteristics
Type: token
Path: Location.characteristic

See Also:

• Constant Field Values

CHARACTERISTIC

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CHARACTERISTIC

Fluent Client search parameter constant for characteristic

Description: One of the Location's characteristics
Type: token
Path: Location.characteristic

SP_CONTAINS

public static final String SP_CONTAINS

Search parameter: contains

Description: Select locations that contain the specified co-ordinates
Type: special
Path: Location.extension('http://hl7.org/fhir/StructureDefinition/location-boundary-geojson').value

See Also:

• Constant Field Values

CONTAINS

public static final ca.uhn.fhir.rest.gclient.SpecialClientParam CONTAINS

Fluent Client search parameter constant for contains

Description: Select locations that contain the specified co-ordinates
Type: special
Path: Location.extension('http://hl7.org/fhir/StructureDefinition/location-boundary-geojson').value

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_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_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_NEAR

public static final String SP_NEAR

Search parameter: near

Description: Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). Servers which support the near parameter SHALL support the unit string 'km' for kilometers and SHOULD support '[mi_us]' for miles, support for other units is optional. If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant). If the server is unable to understand the units (and does support the near search parameter), it MIGHT return an OperationOutcome and fail the search with a http status 400 BadRequest. If the server does not support the near parameter, the parameter MIGHT report the unused parameter in a bundled OperationOutcome and still perform the search ignoring the near parameter. Note: The algorithm to determine the distance is not defined by the specification, and systems might have different engines that calculate things differently. They could consider geographic point to point, or path via road, or including current traffic conditions, or just simple neighboring postcodes/localities if that's all it had access to.
Type: special
Path: Location.position

See Also:

• Constant Field Values

NEAR

public static final ca.uhn.fhir.rest.gclient.SpecialClientParam NEAR

Fluent Client search parameter constant for near

Description: Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). Servers which support the near parameter SHALL support the unit string 'km' for kilometers and SHOULD support '[mi_us]' for miles, support for other units is optional. If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant). If the server is unable to understand the units (and does support the near search parameter), it MIGHT return an OperationOutcome and fail the search with a http status 400 BadRequest. If the server does not support the near parameter, the parameter MIGHT report the unused parameter in a bundled OperationOutcome and still perform the search ignoring the near parameter. Note: The algorithm to determine the distance is not defined by the specification, and systems might have different engines that calculate things differently. They could consider geographic point to point, or path via road, or including current traffic conditions, or just simple neighboring postcodes/localities if that's all it had access to.
Type: special
Path: Location.position

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_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_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_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

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

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 {3}

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/chairs/etc. such as an isolation unit/dialysis 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/chairs/etc. such as an isolation unit/dialysis 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 MarkdownType 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(MarkdownType 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 List<CodeableConcept> getType()

Returns:

type (Indicates the type of function performed at the location.)

setType

public Location setType(List<CodeableConcept> theType)

Returns:

Returns a reference to this for easy method chaining

hasType

public boolean hasType()

addType

public CodeableConcept addType()

addType

public Location addType(CodeableConcept t)

getTypeFirstRep

public CodeableConcept getTypeFirstRep()

Returns:

The first repetition of repeating field type, creating it if it does not already exist {3}

getContact

public List<ExtendedContactDetail> getContact()

Returns:

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

setContact

public Location setContact(List<ExtendedContactDetail> theContact)

Returns:

Returns a reference to this for easy method chaining

hasContact

public boolean hasContact()

addContact

public ExtendedContactDetail addContact()

addContact

public Location addContact(ExtendedContactDetail t)

getContactFirstRep

public ExtendedContactDetail getContactFirstRep()

Returns:

The first repetition of repeating field contact, creating it if it does not already exist {3}

getAddress

public Address getAddress()

Returns:

address (Physical location.)

hasAddress

public boolean hasAddress()

setAddress

public Location setAddress(Address value)

Parameters:

value - address (Physical location.)

getForm

public CodeableConcept getForm()

Returns:

form (Physical form of the location, e.g. building, room, vehicle, road, virtual.)

hasForm

public boolean hasForm()

setForm

public Location setForm(CodeableConcept value)

Parameters:

value - form (Physical form of the location, e.g. building, room, vehicle, road, virtual.)

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.)

getPartOf

public Reference getPartOf()

Returns:

partOf (Another Location of which this Location is physically a part of.)

hasPartOf

public boolean hasPartOf()

setPartOf

public Location setPartOf(Reference value)

Parameters:

value - partOf (Another Location of which this Location is physically a part of.)

getCharacteristic

public List<CodeableConcept> getCharacteristic()

Returns:

characteristic (Collection of characteristics (attributes).)

setCharacteristic

public Location setCharacteristic(List<CodeableConcept> theCharacteristic)

Returns:

Returns a reference to this for easy method chaining

hasCharacteristic

public boolean hasCharacteristic()

addCharacteristic

public CodeableConcept addCharacteristic()

addCharacteristic

public Location addCharacteristic(CodeableConcept t)

getCharacteristicFirstRep

public CodeableConcept getCharacteristicFirstRep()

Returns:

The first repetition of repeating field characteristic, creating it if it does not already exist {3}

getHoursOfOperation

public List<Availability> getHoursOfOperation()

Returns:

hoursOfOperation (What days/times during a week is this location usually open, and any exceptions where the location is not available.)

setHoursOfOperation

public Location setHoursOfOperation(List<Availability> theHoursOfOperation)

Returns:

Returns a reference to this for easy method chaining

hasHoursOfOperation

public boolean hasHoursOfOperation()

addHoursOfOperation

public Availability addHoursOfOperation()

addHoursOfOperation

public Location addHoursOfOperation(Availability t)

getHoursOfOperationFirstRep

public Availability getHoursOfOperationFirstRep()

Returns:

The first repetition of repeating field hoursOfOperation, creating it if it does not already exist {3}

getVirtualService

public List<VirtualServiceDetail> getVirtualService()

Returns:

virtualService (Connection details of a virtual service (e.g. shared conference call facility with dedicated number/details).)

setVirtualService

public Location setVirtualService(List<VirtualServiceDetail> theVirtualService)

Returns:

Returns a reference to this for easy method chaining

hasVirtualService

public boolean hasVirtualService()

addVirtualService

public VirtualServiceDetail addVirtualService()

addVirtualService

public Location addVirtualService(VirtualServiceDetail t)

getVirtualServiceFirstRep

public VirtualServiceDetail getVirtualServiceFirstRep()

Returns:

The first repetition of repeating field virtualService, creating it if it does not already exist {3}

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 {3}

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

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild 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

Returns:

the FHIR type name of the instance (not the java class name)

copy

public Location copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(Location dst)

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