Generated Narrative: StructureDefinition amk-location Name Flags Card. Type Description & Constraints Location 0..* Location Details and position information for a place #xD; status 1..1 code active | suspended | inactive Required Pattern: active #xD; name 1..1 string Name of the location as used by humans #xD; type 1..1 CodeableConcept Types of services available at this location #xD; position 1..1 BackboneElement The absolute geographic location #xD; managingOrganization 0..1 Reference(AMK Organization) Organization responsible for provisioning and upkeep #xD; Documentation for this format
Location resource representing a physical or virtual location, including GPS coordinates.
Used by permission of HL7 International, all rights reserved Creative Commons License
Details and position information for a place
Details and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
Entity, Role, or Act,.Role[classCode=SDLC]
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resource id depends on the given use case.
The 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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A 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. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the [additionalImplicitRules](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-additionalImplicitRules.html) extension.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A 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.
Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an [additional resource](http://build.fhir.org/resource.html#additional).
Extensions are always sliced by (at least) url
Additional content defined by implementations
May 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 managable, 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.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
May 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 managable, 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).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://build.fhir.org/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Unique code or number identifying the location to its users
Unique code or number identifying the location to its users.
Organization label locations in registries, need to keep track of those.
The status property covers the general availability of the resource, not the current value which may be covered by the operationalStatus, or by a schedule/slots if they are configured for the location.
This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid
Indicates whether the location is still in use.
The operational status of the location (typically only for a bed/room)
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.
The operational status if the location (where typically a bed/room).
A coded representation of this Location, where the codes may be found in a geospatial system.
`Location.code` may be used when there are existing code sets for geospatial or administrative regions, such as states, districts, municipalities, etc., where the code represents the geospatial identity of the Location. When indicating that a Location is located within some broader geospatial or administrative Location. When representing unique identifiers for intra-facility locations like rooms, beds, etc., Location.identifier is preferable. Further details will be available in the Administration Incubator.
Codes for representing locations, such as country codes.
Name of the location as used by humans. Does not need to be unique.
If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches.
A list of alternate names that the location is known as, or was known as, in the past
A list of alternate names that the location is known as, or was known as, in the past.
There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location.
Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the location was known by can be very useful.
Additional details about the location that could be displayed as further information to identify the location beyond its name
Description of the Location, which helps in finding or referencing the place.
Humans need additional information to verify a correct location has been identified.
.playingEntity[classCode=PLC determinerCode=INSTANCE].desc
Indicates whether a resource instance represents a specific location or a class of locations.
When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.
Types of services available at this location
Indicates the type of services that are available at this location.
Official contact details for the location
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.
The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the Healthcare itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc. If this is empty (or the type of interest is empty), refer to the organization's contacts.
Need to keep track of both simple contact details and also assigned contacts within larger organizations.
.telecom and .addr and other .role(relevant datatype properties mapped from role into extendedcontactdetail)
Additional addresses should be recorded using another instance of the Location resource, or via the Organization.
If locations can be visited, we need to keep track of their address.
Form of the location, e.g. building, room, vehicle, road, virtual.
Locations with a virtual form can be used to represent virtual locations, for example for telehealth visits, and can contain additional related details in virtualService.
For purposes of showing relevant locations in queries, we need to categorize locations.
The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
To define a boundary shape for this location use the standard extension `[Location Boundary (GeoJSON)](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-location-boundary-geojson.html)`, and search using the `contains` special search parameter.
For mobile applications and automated route-finding knowing the exact location of the Location is required.
All FHIR elements must have a @value or children or both
.playingEntity [classCode=PLC determinerCode=INSTANCE].positionText
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
May 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 managable, 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.
Extensions that cannot be ignored even if unrecognized
May 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 managable, 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).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes on Location main page).
(RIM Opted not to map the sub-elements of GPS location, is now an OBS)
Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes on Location main page).
Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes on Location main page).
Organization responsible for provisioning and upkeep
The organization responsible for the provisioning and upkeep of the location.
This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.
.scopingEntity[classCode=ORG determinerKind=INSTANCE]
Another Location this one is physically a part of
Another Location of which this Location is physically a part of.
For purposes of location, display and identification, knowing which locations are located within other locations is important.
Collection of characteristics (attributes)
Collection of characteristics (attributes).
These could be such things as is wheelchair accessible.
A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
What days/times during a week is this location usually open (including exceptions)
What days/times during a week is this location usually open, and any exceptions where the location is not available.
This type of information is commonly found published in directories and on websites informing customers when the facility is available. Specific services within the location may have their own hours which could be shorter (or longer) than the locations hours. Systems may choose to render availability differently than it is exchanged on the interface. For example, rather than "Mon, Tue, Wed, Thur, Fri from 9am-12am; Mon, Tue, Wed, Thur, Fri from 1pm-5pm" as would be implied by two availableTime repetitions, an application could render this information as "Mon-Fri 9-12am and 1-5pm". The availableStartTime is the opening time, and the availableEndTime is the closing time.
Connection details of a virtual service (e.g. conference call)
Connection details of a virtual service (e.g. shared conference call facility with dedicated number/details).
There are two types of virtual meetings that often exist: * a persistent, virtual meeting room that can only be used for a single purpose at a time, * and a dynamic virtual meeting room that is generated on demand for a specific purpose. Implementers may consider using Appointment.virtualService for virtual meeting rooms that are generated on-demand.
Technical endpoints providing access to services operated for the location
Technical endpoints providing access to services operated for the location.
Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.