0.3.0 - Second STU ballot

This page is part of a downloaded copy of this specification. This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v0.3.0: STU 1 Ballot 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

## StructureDefinition: LocationR4 - Detailed Descriptions

Definitions for the profile-location-r4 Profile.

1. Location
Definition | Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Control | 0..*
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: 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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: 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()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.div.exists())
2. Location.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
3. Location.meta
Definition | 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.
Control | 0..1
Type | Meta
4. Location.implicitRules
Definition | 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.
Control | 0..1
Type | uri
Is Modifier | true
Comments | 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 it's narrative along with other profiles, value sets, etc.
5. Location.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | A human language. The codes SHOULD be taken from CommonLanguages Max Binding: AllLanguages
Type | code
Comments | 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).
6. Location.text
Definition | 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.
Control | 0..1
Type | Narrative
Alternate Names | narrative, html, xhtml, display
Comments | Contained resources do not have 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.
7. Location.contained
Definition | These 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.
Control | 0..*
Type | Resource
Alternate Names | inline resources, anonymous resources, contained resources
Comments | 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.
8. Location.extension
Definition | 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 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.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Comments | 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.
9. Location.modifierExtension
Definition | 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 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).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | 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.
Alternate Names | extensions, user content
Comments | 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.
10. Location.identifier
Definition | Unique code or number identifying the location to its users.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Requirements | Organization label locations in registries, need to keep track of those.
11. Location.status
Definition | 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.
Control | 0..1
Binding | Indicates whether the location is still in use. The codes SHALL be taken from LocationStatus
Type | code
Is Modifier | true
Must Support | true
12. Location.operationalStatus
Definition | 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.
Control | 0..1
Binding | The operational status if the location (where typically a bed/room). The codes SHOULD be taken from v2 BED STATUS
Type | Coding
13. Location.name
Definition | Name of the location as used by humans. Does not need to be unique.
Control | 1..1
Type | string
Must Support | true
Comments | 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.
14. Location.alias
Definition | A list of alternate names that the location is known as, or was known as, in the past.
Control | 0..*
Type | string
Requirements | 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.
Comments | 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.
15. Location.description
Definition | Description of the Location, which helps in finding or referencing the place.
Control | 0..1
Type | string
Requirements | Humans need additional information to verify a correct location has been identified.
16. Location.mode
Definition | Indicates whether a resource instance represents a specific location or a class of locations.
Control | 0..1
Binding | Indicates whether a resource instance represents a specific location or a class of locations. The codes SHALL be taken from LocationMode
Type | code
Requirements | 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.
Comments | This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood.
17. Location.type
Definition | Indicates the type of function performed at the location.
Control | 0..*
Binding | Indicates the type of function performed at the location. The codes SHALL be taken from V3 Value SetServiceDeliveryLocationRoleType; other codes may be used where these codes are not suitable
Type | CodeableConcept
18. Location.telecom
Definition | The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
Control | 0..*
Type | ContactPoint
Must Support | true
19. Location.address
Definition | Physical location.
Control | 1..1
Type | Address
Must Support | true
Requirements | If locations can be visited, we need to keep track of their address.
Comments | Additional addresses should be recorded using another instance of the Location resource, or via the Organization.
20. Location.address.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
21. Location.address.extension
Definition | 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 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.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Comments | 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.
22. Location.address.use
Definition | The purpose of this address.
Control | 0..1
Binding | The use of an address. The codes SHALL be taken from AddressUse
Type | code
Is Modifier | true
Requirements | Allows an appropriate address to be chosen from a list of many.
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old.
Example | General:home
23. Location.address.type
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
Control | 0..1
Binding | Address Type for CRD The codes SHALL be taken from CRD Location Address Types
Type | code
Must Support | true
Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).
Example | General:both
24. Location.address.text
Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
Control | 0..1
Type | string
Requirements | A renderable, unencoded form.
Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
Example | General:137 Nowhere Street, Erewhon 9132
25. Location.address.line
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
Control | 0..*
Type | string
Must Support | true
Example | General:137 Nowhere Street
26. Location.address.city
Definition | The name of the city, town, suburb, village or other community or delivery center.
Control | 0..1
Type | string
Must Support | true
Alternate Names | Municpality
Example | General:Erewhon
27. Location.address.district
Definition | The name of the administrative area (county).
Control | 0..1
Type | string
Alternate Names | County
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
Example | General:Madison
28. Location.address.state
Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
Control | 0..1
Binding | Two letter USPS alphabetic codes. The codes SHALL be taken from USPS Two Letter Alphabetic Codes; other codes may be used where these codes are not suitable
Type | string
Must Support | true
Alternate Names | Province, Territory
29. Location.address.postalCode
Definition | A postal code designating a region defined by the postal service.
Control | 0..1
Type | string
Must Support | true
Alternate Names | Zip
Example | General:9132
30. Location.address.country
Definition | Country - a nation as commonly understood or generally accepted.
Control | 0..1
Type | string
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name.
31. Location.address.period
Definition | Time period when address was/is in use.
Control | 0..1
Type | Period
Requirements | Allows addresses to be placed in historical context.
Example | General:<valuePeriod xmlns="http://hl7.org/fhir"> <start value="2010-03-23T11:00:00+11:00"/> <end value="2010-07-01T10:00:00+10:00"/> </valuePeriod>
32. Location.physicalType
Definition | Physical form of the location, e.g. building, room, vehicle, road.
Control | 0..1
Binding | Physical form of the location. For example codes, see LocationType
Type | CodeableConcept
Requirements | For purposes of showing relevant locations in queries, we need to categorize locations.
33. Location.position
Definition | The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
Control | 0..1
Type | BackboneElement
Requirements | For mobile applications and automated route-finding knowing the exact location of the Location is required.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. Location.position.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
35. Location.position.extension
Definition | 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 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.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Comments | 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.
36. Location.position.modifierExtension
Definition | 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 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).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | 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.
Alternate Names | extensions, user content, modifiers
Comments | 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.
37. Location.position.longitude
Definition | Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).
Control | 1..1
Type | decimal
38. Location.position.latitude
Definition | Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).
Control | 1..1
Type | decimal
39. Location.position.altitude
Definition | Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).
Control | 0..1
Type | decimal
40. Location.managingOrganization
Definition | The organization responsible for the provisioning and upkeep of the location.
Control | 1..1
Type | Reference(OrganizationR4)
Must Support | true
Requirements | Need to know who manages the location.
Comments | 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.
41. Location.partOf
Definition | Another Location of which this Location is physically a part of.
Control | 0..1
Type | Reference(LocationR4)
Requirements | For purposes of location, display and identification, knowing which locations are located within other locations is important.
42. Location.hoursOfOperation
Definition | What days/times during a week is this location usually open.
Control | 0..*
Type | BackboneElement
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. Location.hoursOfOperation.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
44. Location.hoursOfOperation.extension
Definition | 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 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.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Comments | 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.
45. Location.hoursOfOperation.modifierExtension
Definition | 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 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).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | 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.
Alternate Names | extensions, user content, modifiers
Comments | 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.
46. Location.hoursOfOperation.daysOfWeek
Definition | Indicates which days of the week are available between the start and end Times.
Control | 0..*
Binding | The days of the week. The codes SHALL be taken from DaysOfWeek
Type | code
47. Location.hoursOfOperation.allDay
Definition | The Location is open all day.
Control | 0..1
Type | boolean
48. Location.hoursOfOperation.openingTime
Definition | Time that the Location opens.
Control | 0..1
Type | time
49. Location.hoursOfOperation.closingTime
Definition | Time that the Location closes.
Control | 0..1
Type | time
50. Location.availabilityExceptions
Definition | 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.
Control | 0..1
Type | string
51. Location.endpoint
Definition | Technical endpoints providing access to services operated for the location.
Control | 0..*
Type | Reference(Endpoint)
Requirements | 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.