Location (HAPI FHIR Structures - HL7.org DSTU2 3.3.0 API)

java.lang.Object
- org.hl7.fhir.instance.model.Base
- - org.hl7.fhir.instance.model.BaseResource
  - - org.hl7.fhir.instance.model.Resource
    - - org.hl7.fhir.instance.model.DomainResource
      - org.hl7.fhir.instance.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 and 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 and Description
`protected Address`	`address` Physical location.
`protected StringType`	`description` Description of the Location, which helps in finding or referencing the place.
`protected List<Identifier>`	`identifier` Unique code or number identifying the location to its users.
`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.
`protected Reference`	`partOf` Another Location which this Location is physically part of.
`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`
`static String`	`SP_ADDRESSCITY`
`static String`	`SP_ADDRESSCOUNTRY`
`static String`	`SP_ADDRESSPOSTALCODE`
`static String`	`SP_ADDRESSSTATE`
`static String`	`SP_ADDRESSUSE`
`static String`	`SP_IDENTIFIER`
`static String`	`SP_NAME`
`static String`	`SP_NEAR`
`static String`	`SP_NEARDISTANCE`
`static String`	`SP_ORGANIZATION`
`static String`	`SP_PARTOF`
`static String`	`SP_STATUS`
`static String`	`SP_TYPE`
`protected Enumeration<Location.LocationStatus>`	`status` active \| suspended \| inactive.
`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.

Fields inherited from class org.hl7.fhir.instance.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.instance.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 and Description

Location()

Constructors
Constructor and Description
`Location()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`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()`
`String`	`getDescription()`
`StringType`	`getDescriptionElement()`
`List<Identifier>`	`getIdentifier()`
`Reference`	`getManagingOrganization()`
`Organization`	`getManagingOrganizationTarget()`
`Location.LocationMode`	`getMode()`
`Enumeration<Location.LocationMode>`	`getModeElement()`
`String`	`getName()`
`StringType`	`getNameElement()`
`Reference`	`getPartOf()`
`Location`	`getPartOfTarget()`
`CodeableConcept`	`getPhysicalType()`
`Location.LocationPositionComponent`	`getPosition()`
`ResourceType`	`getResourceType()`
`Location.LocationStatus`	`getStatus()`
`Enumeration<Location.LocationStatus>`	`getStatusElement()`
`List<ContactPoint>`	`getTelecom()`
`CodeableConcept`	`getType()`
`boolean`	`hasAddress()`
`boolean`	`hasDescription()`
`boolean`	`hasDescriptionElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasManagingOrganization()`
`boolean`	`hasMode()`
`boolean`	`hasModeElement()`
`boolean`	`hasName()`
`boolean`	`hasNameElement()`
`boolean`	`hasPartOf()`
`boolean`	`hasPhysicalType()`
`boolean`	`hasPosition()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasTelecom()`
`boolean`	`hasType()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Location`	`setAddress(Address value)`
`Location`	`setDescription(String value)`
`Location`	`setDescriptionElement(StringType value)`
`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`	`setPartOf(Reference value)`
`Location`	`setPartOfTarget(Location value)`
`Location`	`setPhysicalType(CodeableConcept value)`
`Location`	`setPosition(Location.LocationPositionComponent value)`
`void`	`setProperty(String name, Base value)`
`Location`	`setStatus(Location.LocationStatus value)`
`Location`	`setStatusElement(Enumeration<Location.LocationStatus> value)`
`Location`	`setType(CodeableConcept value)`
`protected Location`	`typedCopy()`

Methods inherited from class org.hl7.fhir.instance.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.instance.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, getStructureFhirVersionEnum, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.instance.model.BaseResource
setId

Methods inherited from class org.hl7.fhir.instance.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    Unique code or number identifying the location to its users.
  - status
```
protected Enumeration<Location.LocationStatus> status
```
    active | suspended | inactive.
  - name
```
protected StringType name
```
    Name of the location as used by humans. Does not need to be unique.
  - 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.)
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - SP_PARTOF
```
public static final String SP_PARTOF
```
    See Also:
    
    Constant Field Values
  - SP_NEARDISTANCE
```
public static final String SP_NEARDISTANCE
```
    See Also:
    
    Constant Field Values
  - SP_ADDRESS
```
public static final String SP_ADDRESS
```
    See Also:
    
    Constant Field Values
  - SP_ADDRESSSTATE
```
public static final String SP_ADDRESSSTATE
```
    See Also:
    
    Constant Field Values
  - SP_TYPE
```
public static final String SP_TYPE
```
    See Also:
    
    Constant Field Values
  - SP_ADDRESSPOSTALCODE
```
public static final String SP_ADDRESSPOSTALCODE
```
    See Also:
    
    Constant Field Values
  - SP_ADDRESSCOUNTRY
```
public static final String SP_ADDRESSCOUNTRY
```
    See Also:
    
    Constant Field Values
  - SP_ORGANIZATION
```
public static final String SP_ORGANIZATION
```
    See Also:
    
    Constant Field Values
  - SP_NAME
```
public static final String SP_NAME
```
    See Also:
    
    Constant Field Values
  - SP_ADDRESSUSE
```
public static final String SP_ADDRESSUSE
```
    See Also:
    
    Constant Field Values
  - SP_NEAR
```
public static final String SP_NEAR
```
    See Also:
    
    Constant Field Values
  - SP_ADDRESSCITY
```
public static final String SP_ADDRESSCITY
```
    See Also:
    
    Constant Field Values
  - SP_STATUS
```
public static final String SP_STATUS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Location
```
public Location()
```
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (Unique code or number identifying the location to its users.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    identifier (Unique code or number identifying the location to its users.)
  - addIdentifier
```
public Location addIdentifier(Identifier t)
```
  - getStatusElement
```
public Enumeration<Location.LocationStatus> getStatusElement()
```
    Returns:
    
    status (active | suspended | inactive.). 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 (active | suspended | inactive.). 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:
    
    active | suspended | inactive.
  - setStatus
```
public Location setStatus(Location.LocationStatus value)
```
    Parameters:
    
    value - active | suspended | inactive.
  - 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.
  - 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.)
  - hasTelecom
```
public boolean hasTelecom()
```
  - addTelecom
```
public ContactPoint addTelecom()
```
    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.)
  - addTelecom
```
public Location addTelecom(ContactPoint t)
```
  - 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.)
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - setProperty
```
public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty 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()
```
    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.instance.model.DomainResource

Fields inherited from class org.hl7.fhir.instance.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.instance.model.DomainResource

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

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

Methods inherited from class org.hl7.fhir.instance.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.IBaseResource

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

Field Detail

identifier

status

name

description

mode

type

telecom

address

physicalType

position

managingOrganization

managingOrganizationTarget

partOf

partOfTarget

SP_IDENTIFIER

SP_PARTOF

SP_NEARDISTANCE

SP_ADDRESS

SP_ADDRESSSTATE

SP_TYPE

SP_ADDRESSPOSTALCODE

SP_ADDRESSCOUNTRY

SP_ORGANIZATION

SP_NAME

SP_ADDRESSUSE

SP_NEAR

SP_ADDRESSCITY

SP_STATUS

Constructor Detail

Location

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getNameElement

hasNameElement

hasName

setNameElement

getName

setName

getDescriptionElement

hasDescriptionElement

hasDescription

setDescriptionElement

getDescription

setDescription

getModeElement

hasModeElement

hasMode

setModeElement

getMode

setMode

getType

hasType

setType