Class Location
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.Location
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") 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.Maturity level: FMM3 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Location.Builder
static class
Location.HoursOfOperation
What days/times during a week is this location usually open.static class
Location.Position
The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static Location.Builder
builder()
boolean
equals(java.lang.Object obj)
Address
getAddress()
Physical location.java.util.List<String>
getAlias()
A list of alternate names that the location is known as, or was known as, in the past.String
getAvailabilityExceptions()
A description of when the locations opening ours are different to normal, e.g.String
getDescription()
Description of the Location, which helps in finding or referencing the place.java.util.List<Reference>
getEndpoint()
Technical endpoints providing access to services operated for the location.java.util.List<Location.HoursOfOperation>
getHoursOfOperation()
What days/times during a week is this location usually open.java.util.List<Identifier>
getIdentifier()
Unique code or number identifying the location to its users.Reference
getManagingOrganization()
The organization responsible for the provisioning and upkeep of the location.LocationMode
getMode()
Indicates whether a resource instance represents a specific location or a class of locations.String
getName()
Name of the location as used by humans.Coding
getOperationalStatus()
The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc.Reference
getPartOf()
Another Location of which this Location is physically a part of.CodeableConcept
getPhysicalType()
Physical form of the location, e.g.Location.Position
getPosition()
The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).LocationStatus
getStatus()
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.java.util.List<ContactPoint>
getTelecom()
The contact details of communication devices available at the location.java.util.List<CodeableConcept>
getType()
Indicates the type of function performed at the location.boolean
hasChildren()
int
hashCode()
Location.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
Unique code or number identifying the location to its users.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getStatus
public LocationStatus getStatus()
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.- Returns:
- An immutable object of type
LocationStatus
that may be null.
-
getOperationalStatus
public Coding getOperationalStatus()
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.- Returns:
- An immutable object of type
Coding
that may be null.
-
getName
public String getName()
Name of the location as used by humans. Does not need to be unique.- Returns:
- An immutable object of type
String
that may be null.
-
getAlias
public java.util.List<String> getAlias()
A list of alternate names that the location is known as, or was known as, in the past.- Returns:
- An unmodifiable list containing immutable objects of type
String
that may be empty.
-
getDescription
public String getDescription()
Description of the Location, which helps in finding or referencing the place.- Returns:
- An immutable object of type
String
that may be null.
-
getMode
public LocationMode getMode()
Indicates whether a resource instance represents a specific location or a class of locations.- Returns:
- An immutable object of type
LocationMode
that may be null.
-
getType
public java.util.List<CodeableConcept> getType()
Indicates the type of function performed at the location.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getTelecom
public java.util.List<ContactPoint> getTelecom()
The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.- Returns:
- An unmodifiable list containing immutable objects of type
ContactPoint
that may be empty.
-
getAddress
public Address getAddress()
Physical location.- Returns:
- An immutable object of type
Address
that may be null.
-
getPhysicalType
public CodeableConcept getPhysicalType()
Physical form of the location, e.g. building, room, vehicle, road.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getPosition
public Location.Position getPosition()
The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).- Returns:
- An immutable object of type
Location.Position
that may be null.
-
getManagingOrganization
public Reference getManagingOrganization()
The organization responsible for the provisioning and upkeep of the location.- Returns:
- An immutable object of type
Reference
that may be null.
-
getPartOf
public Reference getPartOf()
Another Location of which this Location is physically a part of.- Returns:
- An immutable object of type
Reference
that may be null.
-
getHoursOfOperation
public java.util.List<Location.HoursOfOperation> getHoursOfOperation()
What days/times during a week is this location usually open.- Returns:
- An unmodifiable list containing immutable objects of type
Location.HoursOfOperation
that may be empty.
-
getAvailabilityExceptions
public String getAvailabilityExceptions()
A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.- Returns:
- An immutable object of type
String
that may be null.
-
getEndpoint
public java.util.List<Reference> getEndpoint()
Technical endpoints providing access to services operated for the location.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public Location.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static Location.Builder builder()
-
-