Skip to main content

Location

PropertyValue
Publisher
NameLocation
URLhttp://hl7.org/fhir/StructureDefinition/Location
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
Location0..*LocationDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Location.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Location.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Location.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Location.language0..1codeThe base language in which the resource is written.
Location.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Location.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Location.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Location.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Location.identifier0..*IdentifierUnique code or number identifying the location to its users.
Location.status0..1codeThe 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.
Location.operationalStatus0..1CodingThe 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.
Location.name0..1stringName of the location as used by humans. Does not need to be unique.
Location.alias0..*stringA list of alternate names that the location is known as, or was known as, in the past.
Location.description0..1stringDescription of the Location, which helps in finding or referencing the place.
Location.mode0..1codeIndicates whether a resource instance represents a specific location or a class of locations.
Location.type0..*CodeableConceptIndicates the type of function performed at the location.
Location.telecom0..*ContactPointThe contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
Location.address0..1AddressPhysical location.
Location.physicalType0..1CodeableConceptPhysical form of the location, e.g. building, room, vehicle, road.
Location.position0..1BackboneElementThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
Location.position.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Location.position.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Location.position.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Location.position.longitude1..1decimalLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).
Location.position.latitude1..1decimalLatitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).
Location.position.altitude0..1decimalAltitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).
Location.managingOrganization0..1ReferenceThe organization responsible for the provisioning and upkeep of the location.
Location.partOf0..1ReferenceAnother Location of which this Location is physically a part of.
Location.hoursOfOperation0..*BackboneElementWhat days/times during a week is this location usually open.
Location.hoursOfOperation.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Location.hoursOfOperation.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Location.hoursOfOperation.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Location.hoursOfOperation.daysOfWeek0..*codeIndicates which days of the week are available between the start and end Times.
Location.hoursOfOperation.allDay0..1booleanThe Location is open all day.
Location.hoursOfOperation.openingTime0..1timeTime that the Location opens.
Location.hoursOfOperation.closingTime0..1timeTime that the Location closes.
Location.availabilityExceptions0..1stringA 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.
Location.endpoint0..*ReferenceTechnical endpoints providing access to services operated for the location.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
addressstringA (part of the) address of the locationLocation.address
address-citystringA city specified in an addressLocation.address.city
address-countrystringA country specified in an addressLocation.address.country
address-postalcodestringA postal code specified in an addressLocation.address.postalCode
address-statestringA state specified in an addressLocation.address.state
address-usetokenA use code specified in an addressLocation.address.use
endpointreferenceTechnical endpoints providing access to services operated for the locationLocation.endpoint
identifiertokenAn identifier for the locationLocation.identifier
namestringA portion of the location's name or aliasLocation.name / Location.alias
nearspecialSearch 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).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)Servers may search using various techniques that might have differing accuracies, depending on implementation efficiency.Requires the near-distance parameter to be provided alsoLocation.position
operational-statustokenSearches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)Location.operationalStatus
organizationreferenceSearches for locations that are managed by the provided organizationLocation.managingOrganization
partofreferenceA location of which this location is a partLocation.partOf
statustokenSearches for locations with a specific kind of statusLocation.status
typetokenA code for the type of locationLocation.type
_iguhealth-version-seqnumberThe version sequence of the resourceResource.meta.extension.where(url='https://iguhealth.app/version-sequence').value
_iguhealth-authorreferenceThe author of the resourceResource.meta.extension.where(url='https://iguhealth.app/author').value