Location (model) - Definitions - Xt-EHR Logical Models Implementation Guide v0.1.0

LOGICAL MODELS

Xt-EHR Logical Models Implementation Guide
0.1.0 - ci-build

Xt-EHR Logical Models Implementation Guide, published by Xt-EHR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Xt-EHR/xt-ehr-common/ and changes regularly. See the Directory of published versions

Logical Model: EHDSLocation - Detailed Descriptions

Draft as of 2024-10-13

Definitions for the EHDSLocation logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

0. EHDSLocation
Definition	C.17 - EHDS refined base model for Details and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Short	Location (model)
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. EHDSLocation.identifier
Definition	Location identifier
Short	C.17.1 - Identifier
Note	This is a business identifier, not a resource identifier (see discussion)
Control	0..*
Type	Identifier
4. EHDSLocation.name
Definition	Name of the location as used by humans
Short	C.17.2 - Name
Control	0..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
6. EHDSLocation.description
Definition	Additional details about the location that could be displayed as further information to identify the location beyond its name
Short	C.17.3 - Description
Control	0..1
Type	Narrative
8. EHDSLocation.type
Definition	Type of function performed at the location
Short	C.17.4 - Type
Control	0..*
Binding	HL7 ServiceDeliveryLocationRoleType
Type	CodeableConcept
10. EHDSLocation.address
Definition	Physical location address
Short	C.17.5 - Address
Control	0..1
Type	https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAddress
12. EHDSLocation.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	C.17.6 - Position
Control	0..1
Type	BackboneElement
14. EHDSLocation.position.longitude
Definition	Longitude with WGS84 datum
Short	C.17.6.1 - Longitude
Control	1..1
Type	decimal
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. EHDSLocation.position.latitude
Definition	Latitude with WGS84 datum
Short	C.17.6.2 - Latitude
Control	1..1
Type	decimal
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. EHDSLocation.managingOrganization
Definition	The organization responsible for the provisioning and upkeep of the location
Short	C.17.7 - Managing organization
Control	0..1
Type	Reference(Organization (model))
20. EHDSLocation.partOf
Definition	Another Location of which this Location is physically a part of
Short	C.17.8 - Part of
Control	0..1
Type	Reference(Organization (model))

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

0. EHDSLocation
Definition	C.17 - EHDS refined base model for Details and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated. Base definition for all types defined in FHIR type system.
Short	Location (model)Base for all types and resources
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. EHDSLocation.identifier
Definition	Location identifier
Short	C.17.1 - Identifier
Note	This is a business identifier, not a resource identifier (see discussion)
Control	0..*
Type	Identifier
4. EHDSLocation.name
Definition	Name of the location as used by humans
Short	C.17.2 - Name
Control	0..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
6. EHDSLocation.description
Definition	Additional details about the location that could be displayed as further information to identify the location beyond its name
Short	C.17.3 - Description
Control	0..1
Type	Narrative
8. EHDSLocation.type
Definition	Type of function performed at the location
Short	C.17.4 - Type
Control	0..*
Binding	HL7 ServiceDeliveryLocationRoleType
Type	CodeableConcept
10. EHDSLocation.address
Definition	Physical location address
Short	C.17.5 - Address
Control	0..1
Type	https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAddress
12. EHDSLocation.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	C.17.6 - Position
Control	0..1
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. EHDSLocation.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())
16. EHDSLocation.position.longitude
Definition	Longitude with WGS84 datum
Short	C.17.6.1 - Longitude
Control	1..1
Type	decimal
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. EHDSLocation.position.latitude
Definition	Latitude with WGS84 datum
Short	C.17.6.2 - Latitude
Control	1..1
Type	decimal
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
20. EHDSLocation.managingOrganization
Definition	The organization responsible for the provisioning and upkeep of the location
Short	C.17.7 - Managing organization
Control	0..1
Type	Reference(Organization (model))
22. EHDSLocation.partOf
Definition	Another Location of which this Location is physically a part of
Short	C.17.8 - Part of
Control	0..1
Type	Reference(Organization (model))

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

0. EHDSLocation
Definition	C.17 - EHDS refined base model for Details and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Short	Location (model)
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. EHDSLocation.identifier
Definition	Location identifier
Short	C.17.1 - Identifier
Note	This is a business identifier, not a resource identifier (see discussion)
Control	0..*
Type	Identifier
4. EHDSLocation.name
Definition	Name of the location as used by humans
Short	C.17.2 - Name
Control	0..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
6. EHDSLocation.description
Definition	Additional details about the location that could be displayed as further information to identify the location beyond its name
Short	C.17.3 - Description
Control	0..1
Type	Narrative
8. EHDSLocation.type
Definition	Type of function performed at the location
Short	C.17.4 - Type
Control	0..*
Binding	HL7 ServiceDeliveryLocationRoleType
Type	CodeableConcept
10. EHDSLocation.address
Definition	Physical location address
Short	C.17.5 - Address
Control	0..1
Type	https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAddress
12. EHDSLocation.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	C.17.6 - Position
Control	0..1
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. EHDSLocation.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	id
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
16. EHDSLocation.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()`)
Slicing	This element introduces a set of slices on `EHDSLocation.position.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
18. EHDSLocation.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()`)
20. EHDSLocation.position.longitude
Definition	Longitude with WGS84 datum
Short	C.17.6.1 - Longitude
Control	1..1
Type	decimal
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
22. EHDSLocation.position.latitude
Definition	Latitude with WGS84 datum
Short	C.17.6.2 - Latitude
Control	1..1
Type	decimal
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
24. EHDSLocation.managingOrganization
Definition	The organization responsible for the provisioning and upkeep of the location
Short	C.17.7 - Managing organization
Control	0..1
Type	Reference(Organization (model))
26. EHDSLocation.partOf
Definition	Another Location of which this Location is physically a part of
Short	C.17.8 - Part of
Control	0..1
Type	Reference(Organization (model))

Links: Table of Contents | QA Report

The Xt-EHR action is co-funded by the European Union, EU4Health Program 2021-2027, under Grant Agreement Nr.º 101128085.