HL7 Europe Base and Core FHIR IG
0.1.0 - trial-use 150

HL7 Europe Base and Core FHIR IG - Downloaded Version 0.1.0 See the Directory of published versions

## Resource Profile: LocationEuCore - Detailed Descriptions

Page standards status: Trial-use | Maturity Level: 2

Definitions for the location-eu-core resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Location
Definition | Details and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Short | Details and position information for a place
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Location.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Location.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
6. Location.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Location.identifier
Definition | Unique code or number identifying the location to its users.
Short | Location identifierUnique code or number identifying the location to its users
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Requirements | Organization label locations in registries, need to keep track of those.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Location.status
Definition | The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
Short | active | suspended | inactive
Control | 0..1
Binding | The codes SHALL be taken from LocationStatus http://hl7.org/fhir/ValueSet/location-status|5.0.0 (required to `http://hl7.org/fhir/ValueSet/location-status|5.0.0` ) Indicates whether the location is still in use.
Type | code
Is Modifier | true because This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Location.name
Definition | Name of the location as used by humans. Does not need to be unique.
Short | Location nameName of the location as used by humans
Comments | If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Location.type
Definition | Indicates the type of function performed at the location.
Short | Location typeType of function performed
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from ServiceDeliveryLocationRoleType http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType (extensible to `http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType` ) Indicates the type of function performed at the location.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Location.address
Definition | Physical location.
Short | Physical location
Comments | Additional addresses should be recorded using another instance of the Location resource, or via the Organization.
Control | 0..1
Type | Address(Address (EU))
Is Modifier | false
Must Support | false
Summary | false
Requirements | If locations can be visited, we need to keep track of their address.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Location.managingOrganization
Definition | The organization responsible for the provisioning and upkeep of the location.
Short | Managing organizationOrganization responsible for provisioning and upkeep
Comments | The managing organization is the organization responsible for the location, such as a hospital or clinic. 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.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Must Support | false
Summary | true
Requirements | Need to know who manages the location.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Location.partOf
Definition | Another Location of which this Location is physically a part of.
Short | Location this one is physically a part ofAnother Location this one is physically a part of
Control | 0..1
Type | Reference(Location)
Is Modifier | false
Must Support | false
Summary | false
Requirements | For purposes of location, display and identification, knowing which locations are located within other locations is important.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Location
2. Location.identifier
Short | Location identifier
Note | This is a business identifier, not a resource identifier (see discussion)
4. Location.name
Short | Location name
6. Location.type
Short | Location type
8. Location.contact
10. Location.contact.telecom
Short | Location telecom
12. Location.address
Type | Address(Address (EU))
14. Location.managingOrganization
Short | Managing organization
Comments | The managing organization is the organization responsible for the location, such as a hospital or clinic.
16. Location.partOf
Short | Location this one is physically a part of

Guidance on how to interpret the contents of this table can be foundhere

0. Location
Definition | Details and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Short | Details and position information for a place
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (`contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`)
2. Location.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
Control | 0..1
Type | id
Is Modifier | false
Must Support | false
Summary | true
4. Location.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. Location.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. Location.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` ) IETF language tag for a human language
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. Location.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..1 This element is affected by the following invariants: dom-6
Type | Narrative
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. Location.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. Location.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
16. Location.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. Location.identifier
Definition | Unique code or number identifying the location to its users.
Short | Location identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Requirements | Organization label locations in registries, need to keep track of those.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. Location.status
Definition | The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
Short | active | suspended | inactive
Control | 0..1
Binding | The codes SHALL be taken from LocationStatus (required to `http://hl7.org/fhir/ValueSet/location-status|5.0.0` ) Indicates whether the location is still in use.
Type | code
Is Modifier | true because This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. Location.operationalStatus
Definition | The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.
Short | The operational status of the location (typically only for a bed/room)
Control | 0..1
Binding | The codes SHOULD be taken from hl7VS-bedStatus (preferred to `http://terminology.hl7.org/ValueSet/v2-0116` ) The operational status if the location (where typically a bed/room).
Type | Coding
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. Location.name
Definition | Name of the location as used by humans. Does not need to be unique.
Short | Location name
Comments | If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Location.alias
Definition | A list of alternate names that the location is known as, or was known as, in the past.
Short | A list of alternate names that the location is known as, or was known as, in the past
Comments | There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location.
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the location was known by can be very useful.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. Location.description
Definition | Description of the Location, which helps in finding or referencing the place.
Short | Additional details about the location that could be displayed as further information to identify the location beyond its name
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | Humans need additional information to verify a correct location has been identified.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. Location.mode
Definition | Indicates whether a resource instance represents a specific location or a class of locations.
Short | instance | kind
Comments | This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood.
Control | 0..1
Binding | The codes SHALL be taken from LocationMode (required to `http://hl7.org/fhir/ValueSet/location-mode|5.0.0` ) Indicates whether a resource instance represents a specific location or a class of locations.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. Location.type
Definition | Indicates the type of function performed at the location.
Short | Location type
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from ServiceDeliveryLocationRoleType (extensible to `http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType` ) Indicates the type of function performed at the location.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. Location.contact
Definition | The contact details of communication devices available at the location. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.
Short | Official contact details for the location
Comments | The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the Healthcare itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc. If this is empty (or the type of interest is empty), refer to the organization's contacts.
Control | 0..*
Type | ExtendedContactDetail
Is Modifier | false
Must Support | false
Summary | false
Requirements | Need to keep track of both simple contact details and also assigned contacts within larger organizations.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. Location.contact.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
38. Location.contact.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Location.contact.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
40. Location.contact.purpose
Definition | The purpose/type of contact.
Short | The type of contact
Comments | If no purpose is defined, then these contact details may be used for any purpose.
Control | 0..1
Binding | The codes SHOULD be taken from Contact entity type (preferred to `http://terminology.hl7.org/ValueSet/contactentity-type` ) The purpose for which an extended contact detail should be used.
Type | CodeableConcept
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. Location.contact.name
Definition | The name of an individual to contact, some types of contact detail are usually blank.
Short | Name of an individual to contact
Comments | If there is no named individual, the telecom/address information is not generally monitored by a specific individual.
Control | 0..*
Type | HumanName
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. Location.contact.telecom
Definition | The contact details application for the purpose defined.
Short | Location telecom
Control | 0..*
Type | ContactPoint
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. Location.contact.address
Definition | Address for the contact.
Short | Address for the contact
Comments | More than 1 address would be for different purposes, and thus should be entered as a different entry,.
Control | 0..1
Type | Address
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. Location.contact.organization
Definition | This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization.
Short | This contact detail is handled/monitored by a specific organization
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
Requirements | Some specific types of contact information can be an handled by an organization (eg legal council is via a specific firm).
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. Location.contact.period
Definition | Period that this contact was valid for usage.
Short | Period that this contact was valid for usage
Comments | If the details have multiple periods, then enter in a new ExtendedContact with the new period.
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. Location.address
Definition | Physical location.
Short | Physical location
Comments | Additional addresses should be recorded using another instance of the Location resource, or via the Organization.
Control | 0..1
Type | Address(Address (EU))
Is Modifier | false
Must Support | false
Summary | false
Requirements | If locations can be visited, we need to keep track of their address.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. Location.form
Definition | Physical form of the location, e.g. building, room, vehicle, road, virtual.
Short | Physical form of the location
Control | 0..1
Binding | For example codes, see LocationForm (example to `http://hl7.org/fhir/ValueSet/location-form|5.0.0` ) Physical form of the location.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Requirements | For purposes of showing relevant locations in queries, we need to categorize locations.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. Location.position
Definition | The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
Short | The absolute geographic location
Comments | To define a boundary shape for this location use the standard extension `[http://hl7.org/fhir/StructureDefinition/location-boundary-geojson](http://hl7.org/fhir/extensions/StructureDefinition-location-boundary-geojson.html)`, and search using the `contains` special search parameter.
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Requirements | For mobile applications and automated route-finding knowing the exact location of the Location is required.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. Location.position.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
60. Location.position.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
62. Location.position.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
64. Location.position.longitude
Definition | Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes on Location main page).
Short | Longitude with WGS84 datum
Control | 1..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. Location.position.latitude
Definition | Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes on Location main page).
Short | Latitude with WGS84 datum
Control | 1..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. Location.position.altitude
Definition | Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes on Location main page).
Short | Altitude with WGS84 datum
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. Location.managingOrganization
Definition | The organization responsible for the provisioning and upkeep of the location.
Short | Managing organization
Comments | The managing organization is the organization responsible for the location, such as a hospital or clinic.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Must Support | false
Summary | true
Requirements | Need to know who manages the location.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. Location.partOf
Definition | Another Location of which this Location is physically a part of.
Short | Location this one is physically a part of
Control | 0..1
Type | Reference(Location)
Is Modifier | false
Must Support | false
Summary | false
Requirements | For purposes of location, display and identification, knowing which locations are located within other locations is important.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. Location.characteristic
Definition | Collection of characteristics (attributes).
Short | Collection of characteristics (attributes)
Comments | These could be such things as is wheelchair accessible.
Control | 0..*
Binding | For example codes, see LocationCharacteristic (example to `http://hl7.org/fhir/ValueSet/location-characteristic|5.0.0` ) A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. Location.hoursOfOperation
Definition | What days/times during a week is this location usually open, and any exceptions where the location is not available.
Short | What days/times during a week is this location usually open (including exceptions)
Comments | This type of information is commonly found published in directories and on websites informing customers when the facility is available. Specific services within the location may have their own hours which could be shorter (or longer) than the locations hours. Systems may choose to render availability differently than it is exchanged on the interface. For example, rather than "Mon, Tue, Wed, Thur, Fri from 9am-12am; Mon, Tue, Wed, Thur, Fri from 1pm-5pm" as would be implied by two availableTime repetitions, an application could render this information as "Mon-Fri 9-12am and 1-5pm". The availableStartTime is the opening time, and the availableEndTime is the closing time.
Control | 0..*
Type | Availability
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. Location.virtualService
Definition | Connection details of a virtual service (e.g. shared conference call facility with dedicated number/details).
Short | Connection details of a virtual service (e.g. conference call)
Comments | There are two types of virtual meetings that often exist: a persistent, virtual meeting room that can only be used for a single purpose at a time, and a dynamic virtual meeting room that is generated on demand for a specific purpose. Implementers may consider using Appointment.virtualService for virtual meeting rooms that are generated on-demand.
Control | 0..*
Type | VirtualServiceDetail
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
80. Location.endpoint
Definition | Technical endpoints providing access to services operated for the location.
Short | Technical endpoints providing access to services operated for the location
Control | 0..*
Type | Reference(Endpoint)
Is Modifier | false
Must Support | false
Summary | false
Requirements | Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)