US Core Location
US Core Location Profile (Location) | I | http://hl7.org/fhir/StructureDefinition/Location | There are no (further) constraints on this element Element idLocation US Core Location Profile DefinitionDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated. http://hl7.org/fhir/StructureDefinition/Location Constraints
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idLocation.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. id |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idLocation.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. Meta |
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idLocation.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. uri |
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.language Language of the resource content DefinitionThe 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). code BindingA human language. ?? (extensible) | |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idLocation.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may 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 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 in formation is added later. Narrative Mappings
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idLocation.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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. Resource Mappings
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idLocation.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order 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. 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. Extension Mappings
| |
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idLocation.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. Usually modifier elements provide negation or qualification. In order 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. 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. Extension Mappings
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idLocation.identifier Unique code or number identifying the location to its users DefinitionUnique code or number identifying the location to its users. Organization label locations in registries, need to keep track of those. Identifier Mappings
|
status | S Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.status active | suspended | inactive DefinitionThe 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. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. code BindingIndicates whether the location is still in use. ?? (required)Mappings
|
operationalStatus | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idLocation.operationalStatus The Operational status of the location (typically only for a bed/room) DefinitionThe Operational status covers operation values most relevant to beds (but can also apply to rooms/units/chair/etc such as an isolation unit/dialisys chair). This typically covers concepts such as contamination, housekeeping and other activities like maintenance. Coding BindingThe operational status if the location (where typically a bed/room) ?? (preferred)Mappings
|
name | S Σ | 1..1 | string | There are no (further) constraints on this element Element idLocation.name Name of the location as used by humans DefinitionName of the location as used by humans. Does not need to be unique. If the name of an location changes, consider putting the old name in the alias column so that it can still be located through searches. string Mappings
|
alias | 0..* | string | There are no (further) constraints on this element Element idLocation.alias A list of alternate names that the location is known as, or was known as in the past DefinitionA list of alternate names that the location is known as, or was known as in the past. 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. 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. string Mappings
| |
description | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.description Additional details about the location that could be displayed as further information to identify the location beyond its name DefinitionDescription of the Location, which helps in finding or referencing the place. Humans need additional information to verify a correct location has been identified. string Mappings
|
mode | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.mode instance | kind DefinitionIndicates 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. This is labeled as a modifer because whether or not the location is a class of locations changes how it can be used and understood. code BindingIndicates whether a resource instance represents a specific location or a class of locations. ?? (required)Mappings
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idLocation.type Type of function performed DefinitionIndicates the type of function performed at the location. CodeableConcept BindingIndicates the type of function performed at the location. ?? (extensible)Mappings
|
telecom | S | 0..* | ContactPoint | There are no (further) constraints on this element Element idLocation.telecom Contact details of the location DefinitionThe contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. ContactPoint Mappings
|
address | S | 0..1 | Address | There are no (further) constraints on this element Element idLocation.address Physical location DefinitionPhysical location. If locations can be visited, we need to keep track of their address. This was kept as 0..1 as there is no use property on the address, so wouldn't be able to identify different address types. Address Mappings
|
id | 0..1 | string | There are no (further) constraints on this element Element idLocation.address.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string Mappings
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idLocation.address.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.address.use home | work | temp | old - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. code BindingThe use of an address ?? (required)Examples General home Mappings
|
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.address.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. code BindingThe type of an address (physical / postal) ?? (required)Examples General both Mappings
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.address.text Text representation of the address DefinitionA full text representation of the address. A renderable, unencoded form. Can provide both a text representation and parts. string ExamplesGeneral 137 Nowhere Street, Erewhon 9132 Mappings
|
line | S Σ | 0..* | string | There are no (further) constraints on this element Element idLocation.address.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. home | work | temp | old - purpose of this address. string ExamplesGeneral 137 Nowhere Street Mappings
|
city | S Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.address.city Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. string ExamplesGeneral Erewhon Mappings
|
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.address.district District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). 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. string ExamplesGeneral Madison Mappings
|
state | S Σ | 0..1 | stringBinding | There are no (further) constraints on this element Element idLocation.address.state Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). string BindingTwo letter USPS alphabetic codes. ?? (extensible)Mappings
|
postalCode | S Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.address.postalCode US Zip Codes Alternate namesZip DefinitionA postal code designating a region defined by the postal service. string ExamplesGeneral 9132 Mappings
|
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.address.country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a full country name. string Mappings
|
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idLocation.address.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. Period ExamplesGeneral { "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
physicalType | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idLocation.physicalType Physical form of the location DefinitionPhysical form of the location, e.g. building, room, vehicle, road. For purposes of showing relevant locations in queries, we need to categorize locations. CodeableConcept BindingPhysical form of the location ?? (example)Mappings
|
position | 0..1 | BackboneElement | There are no (further) constraints on this element Element idLocation.position The absolute geographic location DefinitionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). For mobile applications and automated route-finding knowing the exact location of the Location is required. BackboneElement Constraints
| |
id | 0..1 | string | There are no (further) constraints on this element Element idLocation.position.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string Mappings
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idLocation.position.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Extension Mappings
| |
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idLocation.position.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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. Extension Mappings
|
longitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.longitude Longitude with WGS84 datum DefinitionLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). decimal Mappings
| |
latitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.latitude Latitude with WGS84 datum DefinitionLatitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). decimal Mappings
| |
altitude | 0..1 | decimal | There are no (further) constraints on this element Element idLocation.position.altitude Altitude with WGS84 datum DefinitionAltitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). decimal Mappings
| |
managingOrganization | S Σ | 0..1 | Reference(http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization) | There are no (further) constraints on this element Element idLocation.managingOrganization Organization responsible for provisioning and upkeep DefinitionThe organization responsible for the provisioning and upkeep of the location. Need to know who manages 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. Reference(http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization) Mappings
|
partOf | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/Location) | There are no (further) constraints on this element Element idLocation.partOf Another Location this one is physically part of DefinitionAnother Location which this Location is physically part of. For purposes of location, display and identification, knowing which locations are located within other locations is important. Reference(http://hl7.org/fhir/StructureDefinition/Location) Mappings
| |
endpoint | 0..* | Reference(http://hl7.org/fhir/StructureDefinition/Endpoint) | There are no (further) constraints on this element Element idLocation.endpoint Technical endpoints providing access to services operated for the location DefinitionTechnical 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. Reference(http://hl7.org/fhir/StructureDefinition/Endpoint) Mappings
|