HL7 Europe Base and Core FHIR IG
0.1.0-snapshot - draft 150

HL7 Europe Base and Core FHIR IG - Local Development build (v0.1.0-snapshot) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: Location (EU base)

Official URL: http://hl7.eu/fhir/base-r5/StructureDefinition/location-eu | Version: 0.1.0-snapshot
Standards status: Draft | Maturity Level: 2 | Computable Name: LocationEu
Copyright/Legal: Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0).

This profile sets minimum expectations for the Location resource to be used for the purpose of this guide.

Usages:

- Refer to this Profile: PractitionerRole (EU base)
- Examples for this Profile: Best Location

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location |  | 0..* | Location | Details and position information for a place
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
contained |  | 0..* | Resource | Contained, inline Resources
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Location identifier
status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
name | Σ | 0..1 | string | Location name
type | Σ | 0..* | CodeableConcept | Location type Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
address |  | 0..1 | AddressEu | Physical location
managingOrganization | Σ | 0..1 | Reference(Organization (EU base)) | Managing organization
partOf |  | 0..1 | Reference(Location) | Location this one is physically a part of
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Location.status | required | LocationStatus `http://hl7.org/fhir/ValueSet/location-status|5.0.0` From the FHIR Standard
Location.type | extensible | ServiceDeliveryLocationRoleType `http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Location | 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 | error | Location | 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 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from Location

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location |  | 0..* | Location | Details and position information for a place
identifier |  | 0..* | Identifier | Location identifier
name |  | 0..1 | string | Location name
type |  | 0..* | CodeableConcept | Location type
contact |  |  |  |
telecom |  | 0..* | ContactPoint | Location telecom
address |  | 0..1 | AddressEu | Physical location
managingOrganization |  | 0..1 | Reference(Organization (EU base)) | Managing organization
partOf |  | 0..1 | Reference(Location) | Location this one is physically a part of
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location |  | 0..* | Location | Details and position information for a place
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Location identifier
status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).
name | Σ | 0..1 | string | Location name
alias |  | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past
description | Σ | 0..1 | markdown | Additional details about the location that could be displayed as further information to identify the location beyond its name
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
type | Σ | 0..* | CodeableConcept | Location type Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
contact |  | 0..* | ExtendedContactDetail | Official contact details for the location
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
purpose | Σ | 0..1 | CodeableConcept | The type of contact Binding: Contact entity type (preferred): The purpose for which an extended contact detail should be used.
name | Σ | 0..* | HumanName | Name of an individual to contact
telecom | Σ | 0..* | ContactPoint | Location telecom
address | Σ | 0..1 | Address | Address for the contact
organization | Σ | 0..1 | Reference(Organization) | This contact detail is handled/monitored by a specific organization
period | Σ | 0..1 | Period | Period that this contact was valid for usage
address |  | 0..1 | AddressEu | Physical location
form | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationForm (example): Physical form of the location.
position |  | 0..1 | BackboneElement | The absolute geographic location
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
longitude |  | 1..1 | decimal | Longitude with WGS84 datum
latitude |  | 1..1 | decimal | Latitude with WGS84 datum
altitude |  | 0..1 | decimal | Altitude with WGS84 datum
managingOrganization | Σ | 0..1 | Reference(Organization (EU base)) | Managing organization
partOf |  | 0..1 | Reference(Location) | Location this one is physically a part of
characteristic |  | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: LocationCharacteristic (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
hoursOfOperation |  | 0..* | Availability | What days/times during a week is this location usually open (including exceptions)
virtualService |  | 0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call)
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Location.language | required | AllLanguages `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` From the FHIR Standard
Location.status | required | LocationStatus `http://hl7.org/fhir/ValueSet/location-status|5.0.0` From the FHIR Standard
Location.operationalStatus | preferred | Hl7VSBedStatus `http://terminology.hl7.org/ValueSet/v2-0116`
Location.mode | required | LocationMode `http://hl7.org/fhir/ValueSet/location-mode|5.0.0` From the FHIR Standard
Location.type | extensible | ServiceDeliveryLocationRoleType `http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType`
Location.contact.purpose | preferred | ContactEntityType `http://terminology.hl7.org/ValueSet/contactentity-type`
Location.form | example | LocationForm `http://hl7.org/fhir/ValueSet/location-form|5.0.0` From the FHIR Standard
Location.characteristic | example | LocationCharacteristic `http://hl7.org/fhir/ValueSet/location-characteristic|5.0.0` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Location | 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 | error | Location | 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 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from Location

Summary

Structures

This structure refers to these other structures:

- Address (EU) (http://hl7.eu/fhir/base-r5/StructureDefinition/Address-eu)
- Organization (EU base) (http://hl7.eu/fhir/base-r5/StructureDefinition/organization-eu)

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location |  | 0..* | Location | Details and position information for a place
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
contained |  | 0..* | Resource | Contained, inline Resources
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Location identifier
status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
name | Σ | 0..1 | string | Location name
type | Σ | 0..* | CodeableConcept | Location type Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
address |  | 0..1 | AddressEu | Physical location
managingOrganization | Σ | 0..1 | Reference(Organization (EU base)) | Managing organization
partOf |  | 0..1 | Reference(Location) | Location this one is physically a part of
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Location.status | required | LocationStatus `http://hl7.org/fhir/ValueSet/location-status|5.0.0` From the FHIR Standard
Location.type | extensible | ServiceDeliveryLocationRoleType `http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Location | 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 | error | Location | 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 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

Differential View

This structure is derived from Location

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location |  | 0..* | Location | Details and position information for a place
identifier |  | 0..* | Identifier | Location identifier
name |  | 0..1 | string | Location name
type |  | 0..* | CodeableConcept | Location type
contact |  |  |  |
telecom |  | 0..* | ContactPoint | Location telecom
address |  | 0..1 | AddressEu | Physical location
managingOrganization |  | 0..1 | Reference(Organization (EU base)) | Managing organization
partOf |  | 0..1 | Reference(Location) | Location this one is physically a part of
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location |  | 0..* | Location | Details and position information for a place
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Location identifier
status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).
name | Σ | 0..1 | string | Location name
alias |  | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past
description | Σ | 0..1 | markdown | Additional details about the location that could be displayed as further information to identify the location beyond its name
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
type | Σ | 0..* | CodeableConcept | Location type Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
contact |  | 0..* | ExtendedContactDetail | Official contact details for the location
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
purpose | Σ | 0..1 | CodeableConcept | The type of contact Binding: Contact entity type (preferred): The purpose for which an extended contact detail should be used.
name | Σ | 0..* | HumanName | Name of an individual to contact
telecom | Σ | 0..* | ContactPoint | Location telecom
address | Σ | 0..1 | Address | Address for the contact
organization | Σ | 0..1 | Reference(Organization) | This contact detail is handled/monitored by a specific organization
period | Σ | 0..1 | Period | Period that this contact was valid for usage
address |  | 0..1 | AddressEu | Physical location
form | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationForm (example): Physical form of the location.
position |  | 0..1 | BackboneElement | The absolute geographic location
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
longitude |  | 1..1 | decimal | Longitude with WGS84 datum
latitude |  | 1..1 | decimal | Latitude with WGS84 datum
altitude |  | 0..1 | decimal | Altitude with WGS84 datum
managingOrganization | Σ | 0..1 | Reference(Organization (EU base)) | Managing organization
partOf |  | 0..1 | Reference(Location) | Location this one is physically a part of
characteristic |  | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: LocationCharacteristic (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
hoursOfOperation |  | 0..* | Availability | What days/times during a week is this location usually open (including exceptions)
virtualService |  | 0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call)
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Location.language | required | AllLanguages `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` From the FHIR Standard
Location.status | required | LocationStatus `http://hl7.org/fhir/ValueSet/location-status|5.0.0` From the FHIR Standard
Location.operationalStatus | preferred | Hl7VSBedStatus `http://terminology.hl7.org/ValueSet/v2-0116`
Location.mode | required | LocationMode `http://hl7.org/fhir/ValueSet/location-mode|5.0.0` From the FHIR Standard
Location.type | extensible | ServiceDeliveryLocationRoleType `http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType`
Location.contact.purpose | preferred | ContactEntityType `http://terminology.hl7.org/ValueSet/contactentity-type`
Location.form | example | LocationForm `http://hl7.org/fhir/ValueSet/location-form|5.0.0` From the FHIR Standard
Location.characteristic | example | LocationCharacteristic `http://hl7.org/fhir/ValueSet/location-characteristic|5.0.0` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Location | 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 | error | Location | 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 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from Location

Summary

Structures

This structure refers to these other structures:

- Address (EU) (http://hl7.eu/fhir/base-r5/StructureDefinition/Address-eu)
- Organization (EU base) (http://hl7.eu/fhir/base-r5/StructureDefinition/organization-eu)

Maturity: 2

Other representations of profile: CSV, Excel, Schematron