FHIR Artifacts > Structure Definition: Location Profile
Structure Definition: Location Profile
Canonical URL:http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Location
Simplifier project page: Location
Derived from: Location (R4)
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work
Differential View
Location | I | Location | There are no (further) constraints on this element Element IdLocation Details and position information for a physical place DefinitionDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
| |
meta | S Σ | 1..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 might not always be associated with version changes to the resource.
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element IdLocation.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdLocation.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdLocation.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
profile | S Σ | 1..* | canonical(StructureDefinition) | Element IdLocation.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdLocation.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdLocation.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example)Constraints
|
extension | I | 0..* | Extension | 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. 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. 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. Unordered, Open, by url(Value) Constraints
|
GeoJSON | S I | 0..1 | Extension(Complex) | Element IdLocation.extension:GeoJSON The absolute geographic location Alternate namesextensions, user content DefinitionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). The extension can be further extended to include unique geolocation identifiers, confidence, altitude, etc. Extension(Complex) Extension URLhttp://hl7.org/fhir/StructureDefinition/geolocation Constraints
|
identifier | S Σ | 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.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdLocation.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdLocation.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdLocation.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdLocation.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdLocation.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
status | S Σ ?! | 0..1 | codeBinding | 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. Note that FHIR strings SHALL NOT exceed 1MB in size Indicates whether the location is still in use. LocationStatus (required)Constraints
|
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/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. The operational status if the location (where typically a bed/room). v2.0116 (preferred)Constraints
|
name | S Σ | 0..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 a location changes, consider putting the old name in the alias column so that it can still be located through searches.
|
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.
| |
description | S Σ | 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
mode | Σ | 0..1 | codeBinding | 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 modifier because whether or not the location is a class of locations changes how it can be used and understood. Indicates whether a resource instance represents a specific location or a class of locations. LocationMode (required)Constraints
|
type | S Σ | 0..* | 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. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Indicates the type of function performed at the location. v3.ServiceDeliveryLocationRoleType (extensible)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdLocation.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdLocation.type.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.type.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdLocation.type.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.type.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdLocation.type.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.type.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
telecom | S I | 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.
|
system | S Σ I | 0..1 | codeBinding | There are no (further) constraints on this element Element IdLocation.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point. ContactPointSystem (required)Constraints
|
value | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.telecom.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdLocation.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point. ContactPointUse (required)Constraints
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdLocation.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdLocation.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
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. Additional addresses should be recorded using another instance of the Location resource, or via the Organization.
|
use | S Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdLocation.address.use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address. AddressUse (required)Constraints
General home Mappings
|
type | S Σ | 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. 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). The type of an address (physical / postal). AddressType (required)Constraints
General both Mappings
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.address.text Text representation of the address DefinitionSpecifies 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. A renderable, unencoded form. 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.
General 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. Note that FHIR strings SHALL NOT exceed 1MB in size
General 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, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General 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.
General Madison Mappings
|
state | S Σ | 0..1 | string | 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 (e.g. US 2 letter state codes). Note that FHIR strings SHALL NOT exceed 1MB in size
|
postalCode | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.address.postalCode Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
country | S Σ | 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 human readable country name.
|
period | Σ I | 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. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
General { "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
physicalType | S Σ | 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. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Physical form of the location. LocationType (example)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdLocation.physicalType.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdLocation.physicalType.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.physicalType.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdLocation.physicalType.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.physicalType.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdLocation.physicalType.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.physicalType.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
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.
| |
longitude | S | 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). Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
latitude | S | 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). Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
altitude | S | 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). Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
managingOrganization | Σ I | 0..1 | Reference(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.
|
partOf | I | 0..1 | Reference(Location) | There are no (further) constraints on this element Element IdLocation.partOf Another Location this one is physically a part of DefinitionAnother 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
hoursOfOperation | 0..* | BackboneElement | There are no (further) constraints on this element Element IdLocation.hoursOfOperation What days/times during a week is this location usually open DefinitionWhat days/times during a week is this location usually open. 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.
| |
daysOfWeek | S | 0..* | codeBinding | There are no (further) constraints on this element Element IdLocation.hoursOfOperation.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week. DaysOfWeek (required)Constraints
|
allDay | S | 0..1 | boolean | There are no (further) constraints on this element Element IdLocation.hoursOfOperation.allDay The Location is open all day DefinitionThe Location is open all day.
|
openingTime | S | 0..1 | time | There are no (further) constraints on this element Element IdLocation.hoursOfOperation.openingTime Time that the Location opens DefinitionTime that the Location opens.
|
closingTime | S | 0..1 | time | There are no (further) constraints on this element Element IdLocation.hoursOfOperation.closingTime Time that the Location closes DefinitionTime that the Location closes.
|
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element IdLocation.availabilityExceptions Description of availability exceptions DefinitionA 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. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
endpoint | I | 0..* | Reference(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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Hybrid View
Location | I | Location | There are no (further) constraints on this element Element IdLocation Details and position information for a physical place DefinitionDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
| |
meta | S Σ | 1..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 might not always be associated with version changes to the resource.
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element IdLocation.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdLocation.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdLocation.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
profile | S Σ | 1..* | canonical(StructureDefinition) | Element IdLocation.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdLocation.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdLocation.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example)Constraints
|
extension | I | 0..* | Extension | 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. 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. 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. Unordered, Open, by url(Value) Constraints
|
GeoJSON | S I | 0..1 | Extension(Complex) | Element IdLocation.extension:GeoJSON The absolute geographic location Alternate namesextensions, user content DefinitionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). The extension can be further extended to include unique geolocation identifiers, confidence, altitude, etc. Extension(Complex) Extension URLhttp://hl7.org/fhir/StructureDefinition/geolocation Constraints
|
identifier | S Σ | 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.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdLocation.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdLocation.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdLocation.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdLocation.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdLocation.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
status | S Σ ?! | 0..1 | codeBinding | 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. Note that FHIR strings SHALL NOT exceed 1MB in size Indicates whether the location is still in use. LocationStatus (required)Constraints
|
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/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. The operational status if the location (where typically a bed/room). v2.0116 (preferred)Constraints
|
name | S Σ | 0..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 a location changes, consider putting the old name in the alias column so that it can still be located through searches.
|
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.
| |
description | S Σ | 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
mode | Σ | 0..1 | codeBinding | 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 modifier because whether or not the location is a class of locations changes how it can be used and understood. Indicates whether a resource instance represents a specific location or a class of locations. LocationMode (required)Constraints
|
type | S Σ | 0..* | 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. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Indicates the type of function performed at the location. v3.ServiceDeliveryLocationRoleType (extensible)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdLocation.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdLocation.type.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.type.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdLocation.type.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.type.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdLocation.type.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.type.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
telecom | S I | 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.
|
system | S Σ I | 0..1 | codeBinding | There are no (further) constraints on this element Element IdLocation.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point. ContactPointSystem (required)Constraints
|
value | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.telecom.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdLocation.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point. ContactPointUse (required)Constraints
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdLocation.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdLocation.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
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. Additional addresses should be recorded using another instance of the Location resource, or via the Organization.
|
use | S Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdLocation.address.use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address. AddressUse (required)Constraints
General home Mappings
|
type | S Σ | 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. 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). The type of an address (physical / postal). AddressType (required)Constraints
General both Mappings
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.address.text Text representation of the address DefinitionSpecifies 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. A renderable, unencoded form. 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.
General 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. Note that FHIR strings SHALL NOT exceed 1MB in size
General 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, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General 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.
General Madison Mappings
|
state | S Σ | 0..1 | string | 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 (e.g. US 2 letter state codes). Note that FHIR strings SHALL NOT exceed 1MB in size
|
postalCode | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.address.postalCode Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
country | S Σ | 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 human readable country name.
|
period | Σ I | 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. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
General { "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
physicalType | S Σ | 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. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Physical form of the location. LocationType (example)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdLocation.physicalType.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdLocation.physicalType.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.physicalType.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdLocation.physicalType.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.physicalType.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdLocation.physicalType.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.physicalType.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
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.
| |
longitude | S | 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). Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
latitude | S | 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). Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
altitude | S | 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). Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
managingOrganization | Σ I | 0..1 | Reference(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.
|
partOf | I | 0..1 | Reference(Location) | There are no (further) constraints on this element Element IdLocation.partOf Another Location this one is physically a part of DefinitionAnother 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
hoursOfOperation | 0..* | BackboneElement | There are no (further) constraints on this element Element IdLocation.hoursOfOperation What days/times during a week is this location usually open DefinitionWhat days/times during a week is this location usually open. 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.
| |
daysOfWeek | S | 0..* | codeBinding | There are no (further) constraints on this element Element IdLocation.hoursOfOperation.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week. DaysOfWeek (required)Constraints
|
allDay | S | 0..1 | boolean | There are no (further) constraints on this element Element IdLocation.hoursOfOperation.allDay The Location is open all day DefinitionThe Location is open all day.
|
openingTime | S | 0..1 | time | There are no (further) constraints on this element Element IdLocation.hoursOfOperation.openingTime Time that the Location opens DefinitionTime that the Location opens.
|
closingTime | S | 0..1 | time | There are no (further) constraints on this element Element IdLocation.hoursOfOperation.closingTime Time that the Location closes DefinitionTime that the Location closes.
|
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element IdLocation.availabilityExceptions Description of availability exceptions DefinitionA 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. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
endpoint | I | 0..* | Reference(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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Snapshot View
Location | I | Location | There are no (further) constraints on this element Element IdLocation Details and position information for a physical place DefinitionDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
| |
meta | S Σ | 1..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 might not always be associated with version changes to the resource.
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element IdLocation.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdLocation.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdLocation.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
profile | S Σ | 1..* | canonical(StructureDefinition) | Element IdLocation.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdLocation.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdLocation.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example)Constraints
|
extension | I | 0..* | Extension | 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. 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. 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. Unordered, Open, by url(Value) Constraints
|
GeoJSON | S I | 0..1 | Extension(Complex) | Element IdLocation.extension:GeoJSON The absolute geographic location Alternate namesextensions, user content DefinitionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). The extension can be further extended to include unique geolocation identifiers, confidence, altitude, etc. Extension(Complex) Extension URLhttp://hl7.org/fhir/StructureDefinition/geolocation Constraints
|
identifier | S Σ | 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.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdLocation.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdLocation.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdLocation.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdLocation.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdLocation.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
status | S Σ ?! | 0..1 | codeBinding | 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. Note that FHIR strings SHALL NOT exceed 1MB in size Indicates whether the location is still in use. LocationStatus (required)Constraints
|
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/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. The operational status if the location (where typically a bed/room). v2.0116 (preferred)Constraints
|
name | S Σ | 0..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 a location changes, consider putting the old name in the alias column so that it can still be located through searches.
|
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.
| |
description | S Σ | 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
mode | Σ | 0..1 | codeBinding | 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 modifier because whether or not the location is a class of locations changes how it can be used and understood. Indicates whether a resource instance represents a specific location or a class of locations. LocationMode (required)Constraints
|
type | S Σ | 0..* | 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. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Indicates the type of function performed at the location. v3.ServiceDeliveryLocationRoleType (extensible)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdLocation.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdLocation.type.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.type.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdLocation.type.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.type.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdLocation.type.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.type.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
telecom | S I | 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.
|
system | S Σ I | 0..1 | codeBinding | There are no (further) constraints on this element Element IdLocation.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point. ContactPointSystem (required)Constraints
|
value | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.telecom.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdLocation.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point. ContactPointUse (required)Constraints
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdLocation.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdLocation.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
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. Additional addresses should be recorded using another instance of the Location resource, or via the Organization.
|
use | S Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdLocation.address.use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address. AddressUse (required)Constraints
General home Mappings
|
type | S Σ | 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. 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). The type of an address (physical / postal). AddressType (required)Constraints
General both Mappings
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.address.text Text representation of the address DefinitionSpecifies 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. A renderable, unencoded form. 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.
General 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. Note that FHIR strings SHALL NOT exceed 1MB in size
General 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, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General 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.
General Madison Mappings
|
state | S Σ | 0..1 | string | 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 (e.g. US 2 letter state codes). Note that FHIR strings SHALL NOT exceed 1MB in size
|
postalCode | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.address.postalCode Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
country | S Σ | 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 human readable country name.
|
period | Σ I | 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. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
General { "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
physicalType | S Σ | 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. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Physical form of the location. LocationType (example)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdLocation.physicalType.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdLocation.physicalType.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.physicalType.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdLocation.physicalType.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.physicalType.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdLocation.physicalType.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdLocation.physicalType.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
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.
| |
longitude | S | 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). Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
latitude | S | 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). Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
altitude | S | 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). Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
managingOrganization | Σ I | 0..1 | Reference(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.
|
partOf | I | 0..1 | Reference(Location) | There are no (further) constraints on this element Element IdLocation.partOf Another Location this one is physically a part of DefinitionAnother 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
hoursOfOperation | 0..* | BackboneElement | There are no (further) constraints on this element Element IdLocation.hoursOfOperation What days/times during a week is this location usually open DefinitionWhat days/times during a week is this location usually open. 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.
| |
daysOfWeek | S | 0..* | codeBinding | There are no (further) constraints on this element Element IdLocation.hoursOfOperation.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week. DaysOfWeek (required)Constraints
|
allDay | S | 0..1 | boolean | There are no (further) constraints on this element Element IdLocation.hoursOfOperation.allDay The Location is open all day DefinitionThe Location is open all day.
|
openingTime | S | 0..1 | time | There are no (further) constraints on this element Element IdLocation.hoursOfOperation.openingTime Time that the Location opens DefinitionTime that the Location opens.
|
closingTime | S | 0..1 | time | There are no (further) constraints on this element Element IdLocation.hoursOfOperation.closingTime Time that the Location closes DefinitionTime that the Location closes.
|
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element IdLocation.availabilityExceptions Description of availability exceptions DefinitionA 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. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
endpoint | I | 0..* | Reference(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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Table View
Location | .. | |
Location.meta | 1.. | |
Location.meta.profile | 1.. | |
Location.extension | 0.. | |
Location.extension | Extension | 0..1 |
Location.identifier | .. | |
Location.identifier.system | .. | |
Location.identifier.value | .. | |
Location.status | .. | |
Location.name | .. | |
Location.description | .. | |
Location.mode | .. | |
Location.type | .. | |
Location.type.coding | .. | |
Location.type.coding.system | .. | |
Location.type.coding.code | .. | |
Location.type.coding.display | .. | |
Location.type.text | .. | |
Location.telecom | .. | |
Location.telecom.system | .. | |
Location.telecom.value | .. | |
Location.address | .. | |
Location.address.use | .. | |
Location.address.type | .. | |
Location.address.text | .. | |
Location.address.line | .. | |
Location.address.city | .. | |
Location.address.state | .. | |
Location.address.postalCode | .. | |
Location.address.country | .. | |
Location.physicalType | .. | |
Location.physicalType.coding | .. | |
Location.physicalType.coding.system | .. | |
Location.physicalType.coding.code | .. | |
Location.physicalType.coding.display | .. | |
Location.position | .. | |
Location.position.longitude | .. | |
Location.position.latitude | .. | |
Location.position.altitude | .. | |
Location.hoursOfOperation | .. | |
Location.hoursOfOperation.daysOfWeek | .. | |
Location.hoursOfOperation.allDay | .. | |
Location.hoursOfOperation.openingTime | .. | |
Location.hoursOfOperation.closingTime | .. |
JSON View
{ "resourceType": "StructureDefinition", "id": "ca-on-eReferral-profile-Location", "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Location", "version": "1.0.1", "name": "EReferralLocation-v11", "title": "Location", "status": "draft", "description": "Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Location", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Location", "derivation": "constraint", "differential": { "element": [ { "id": "Location.meta", "path": "Location.meta", "min": 1, "mustSupport": true }, { "id": "Location.meta.profile", "path": "Location.meta.profile", "comment": "#### **_` FOR eREFERRAL USAGE: The meta.profile = http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Location|1.0.1 `_**\n\nIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.", "min": 1, "mustSupport": true }, { "id": "Location.extension", "path": "Location.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "min": 0 }, { "id": "Location.extension:GeoJSON", "path": "Location.extension", "sliceName": "GeoJSON", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/geolocation" ] } ], "mustSupport": true }, { "id": "Location.identifier", "path": "Location.identifier", "mustSupport": true }, { "id": "Location.identifier.system", "path": "Location.identifier.system", "mustSupport": true }, { "id": "Location.identifier.value", "path": "Location.identifier.value", "mustSupport": true }, { "id": "Location.status", "path": "Location.status", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/location-status" } }, { "id": "Location.name", "path": "Location.name", "mustSupport": true }, { "id": "Location.description", "path": "Location.description", "mustSupport": true }, { "id": "Location.mode", "path": "Location.mode", "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/location-mode" } }, { "id": "Location.type", "path": "Location.type", "mustSupport": true }, { "id": "Location.type.coding", "path": "Location.type.coding", "mustSupport": true }, { "id": "Location.type.coding.system", "path": "Location.type.coding.system", "mustSupport": true }, { "id": "Location.type.coding.code", "path": "Location.type.coding.code", "mustSupport": true }, { "id": "Location.type.coding.display", "path": "Location.type.coding.display", "mustSupport": true }, { "id": "Location.type.text", "path": "Location.type.text", "mustSupport": true }, { "id": "Location.telecom", "path": "Location.telecom", "mustSupport": true }, { "id": "Location.telecom.system", "path": "Location.telecom.system", "mustSupport": true }, { "id": "Location.telecom.value", "path": "Location.telecom.value", "mustSupport": true }, { "id": "Location.address", "path": "Location.address", "mustSupport": true }, { "id": "Location.address.use", "path": "Location.address.use", "mustSupport": true }, { "id": "Location.address.type", "path": "Location.address.type", "mustSupport": true }, { "id": "Location.address.text", "path": "Location.address.text", "mustSupport": true }, { "id": "Location.address.line", "path": "Location.address.line", "mustSupport": true }, { "id": "Location.address.city", "path": "Location.address.city", "mustSupport": true }, { "id": "Location.address.state", "path": "Location.address.state", "mustSupport": true }, { "id": "Location.address.postalCode", "path": "Location.address.postalCode", "mustSupport": true }, { "id": "Location.address.country", "path": "Location.address.country", "mustSupport": true }, { "id": "Location.physicalType", "path": "Location.physicalType", "mustSupport": true }, { "id": "Location.physicalType.coding", "path": "Location.physicalType.coding", "mustSupport": true }, { "id": "Location.physicalType.coding.system", "path": "Location.physicalType.coding.system", "mustSupport": true }, { "id": "Location.physicalType.coding.code", "path": "Location.physicalType.coding.code", "mustSupport": true }, { "id": "Location.physicalType.coding.display", "path": "Location.physicalType.coding.display", "mustSupport": true }, { "id": "Location.position", "path": "Location.position", "mustSupport": false }, { "id": "Location.position.longitude", "path": "Location.position.longitude", "mustSupport": true }, { "id": "Location.position.latitude", "path": "Location.position.latitude", "mustSupport": true }, { "id": "Location.position.altitude", "path": "Location.position.altitude", "mustSupport": true }, { "id": "Location.hoursOfOperation.daysOfWeek", "path": "Location.hoursOfOperation.daysOfWeek", "mustSupport": true }, { "id": "Location.hoursOfOperation.allDay", "path": "Location.hoursOfOperation.allDay", "mustSupport": true }, { "id": "Location.hoursOfOperation.openingTime", "path": "Location.hoursOfOperation.openingTime", "mustSupport": true }, { "id": "Location.hoursOfOperation.closingTime", "path": "Location.hoursOfOperation.closingTime", "mustSupport": true } ] } }
Usage
Location includes both incidental locations (a place which is used for healthcare without prior designation or authorization) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages.
Location is used in a variety of ways in an eReferral process:
In an eReferral ServiceRequest it is used to represent
- the Patient's general pracitioner's location
- the eReferral Requester's location
- an appointment provider's location
In a Provider or HealthcareService Registry, it is used to represent location of the provided service. In this case additional fields become useful, such as physicalType, position, managingOrganization, hoursOfOperation, and availabilityExceptions.
Notes
.id
- used to uniquely identify the resource
- if a persistent identity for the resource is not available to use when constructing a message Bundle for transmission via Direct Messaging, a UUID SHOULD be used in this element (with a corresponding value in
Bundle.entry.fullUrl
)
.meta.profile
- used to declare conformance to this profile
- populate with a fixed value:
http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Location|1.0.1
extension:GeoJSON
- HL7 FHIR defined extension used to locate the absolute longitude & latitude of a location
.telecom
- also included HealthcareService & PractitionerRole
Location.telecom value
takes precedence when provided