Page Status: draft 2025-05-07
Ändringslogg
ID | Datum | Kommentar |
---|---|---|
1 | 2025-05-07 | Placeholder regler för namn och beskrivning |
Location
Information domain hvo-location, where this resource is represented as Plats
Page index
Introduction
The Location resource holds information about a delimited geographical location (point) or area (surface) with a definite position. A Location in this context is refers to the location from a geographical or physical perspective, not from a organization or business perspective.
A geographical area is described by the help of three or more positions in a ordered list that make up corners in the polygon which delimit the area geographically.
Regarding information about how the "must support"-property is used in the Swedish National Catalog of Organization, Offerings and Contracts, please refer to the page Profiles.
Overview
HVOLocation (Location) | I | Location | |
id | S Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 1..* | Extension |
period | S I | 1..1 | Extension(Period) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | S | 1..1 | uriFixed Value |
value[x] | S | 1..1 | |
valuePeriod | Period | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
start | S Σ I | 1..1 | dateTime |
end | S Σ I | 0..1 | dateTime |
modifierExtension | ?! I | 0..* | Extension |
identifier | S Σ | 0..1 | Identifier |
municipality | S Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | S Σ | 1..1 | uriPattern |
value | S Σ | 1..1 | stringBinding |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
county | S Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | S Σ | 1..1 | uriPattern |
value | S Σ | 1..1 | stringBinding |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
status | S Σ ?! | 1..1 | codeBinding |
operationalStatus | Σ | 0..1 | CodingBinding |
name | S Σ | 0..1 | string |
alias | 0..* | string | |
description | S Σ | 0..1 | string |
mode | Σ | 0..1 | codeBinding |
type | S Σ | 0..* | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
telecom | 0..* | ContactPoint | |
address | S | 0..1 | Address |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | S Σ | 1..1 | codeBindingFixed Value |
text | Σ | 0..1 | string |
line | S Σ I | 1..* | string |
city | Σ | 0..1 | string |
district | Σ | 0..1 | string |
state | Σ | 0..1 | string |
postalCode | Σ | 0..1 | string |
country | Σ | 0..1 | string |
period | Σ | 0..1 | Period |
physicalType | S Σ | 0..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
position | S | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
longitude | S | 1..1 | decimal |
latitude | S | 1..1 | decimal |
altitude | 0..1 | decimal | |
managingOrganization | Σ | 0..1 | Reference(Organization) |
partOf | S | 0..1 | Reference(HVOLocation) |
hoursOfOperation | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
daysOfWeek | 0..* | codeBinding | |
allDay | 0..1 | boolean | |
openingTime | 0..1 | time | |
closingTime | 0..1 | time | |
availabilityExceptions | 0..1 | string | |
endpoint | 0..* | Reference(Endpoint) |
Location | |
Definition | Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Location.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
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. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
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. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
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 it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Location.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
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). |
Invariants |
|
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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Location.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained 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. |
Mappings |
|
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 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. |
Cardinality | 1...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.extension:period | |
Definition | Extension for Location to express period of validity. |
Cardinality | 1...1 |
Type | Extension(Period) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Location.extension:period.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Location.extension:period.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 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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.extension:period.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://electronichealth.se/fhir/hvo/StructureDefinition/HVOLocationPeriodExtension |
Mappings |
|
Location.extension:period.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Period |
Must Support | True |
Invariants |
|
Mappings |
|
Location.extension:period.value[x].id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Location.extension:period.value[x].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 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.extension:period.value[x].start | |
Definition | The start of the period. The boundary is inclusive. |
Cardinality | 1...1 |
Type | dateTime |
Must Support | True |
Summary | True |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Invariants |
|
Mappings |
|
Location.extension:period.value[x].end | |
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Cardinality | 0...1 |
Type | dateTime |
Must Support | True |
Summary | True |
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
Invariants |
|
Mappings |
|
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
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. |
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. |
Invariants |
|
Mappings |
|
Location.identifier | |
Definition | Unique code or number identifying the location to its users. |
Cardinality | 0...1 |
Type | Identifier |
Must Support | True |
Summary | True |
Requirements | Organization label locations in registries, need to keep track of those. |
Slicing | Unordered, Open, by identifier.system(Value) |
Invariants |
|
Mappings |
|
Location.identifier:municipality | |
Definition | Unique code or number identifying the location to its users. |
Cardinality | 0...1 |
Type | Identifier |
Must Support | True |
Summary | True |
Requirements | Organization label locations in registries, need to keep track of those. |
Invariants |
|
Mappings |
|
Location.identifier:municipality.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Location.identifier:municipality.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 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.identifier:municipality.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
Location.identifier:municipality.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | 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. |
Invariants |
|
Mappings |
|
Location.identifier:municipality.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | Identifier.system is always case sensitive. |
Invariants |
|
Pattern | dummy.se/identifier/hvo-municipalities-scb |
Mappings |
|
Location.identifier:municipality.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Binding | hvo-municipalities-scb (required) |
Must Support | True |
Summary | True |
Comments | 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. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
Location.identifier:municipality.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
Location.identifier:municipality.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
Location.identifier:county | |
Definition | Unique code or number identifying the location to its users. |
Cardinality | 0...1 |
Type | Identifier |
Must Support | True |
Summary | True |
Requirements | Organization label locations in registries, need to keep track of those. |
Invariants |
|
Mappings |
|
Location.identifier:county.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Location.identifier:county.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 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.identifier:county.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
Location.identifier:county.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | 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. |
Invariants |
|
Mappings |
|
Location.identifier:county.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | Identifier.system is always case sensitive. |
Invariants |
|
Pattern | dummy.se/identifier/hvo-counties-scb |
Mappings |
|
Location.identifier:county.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Binding | hvo-counties-scb (required) |
Must Support | True |
Summary | True |
Comments | 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. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
Location.identifier:county.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
Location.identifier:county.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
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. |
Cardinality | 1...1 |
Type | code |
Binding | Indicates whether the location is still in use. |
Must Support | True |
Modifier | True |
Summary | True |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | Coding |
Binding | The operational status if the location (where typically a bed/room). |
Summary | True |
Invariants |
|
Mappings |
|
Location.name | |
Definition | Name of the location as used by humans. Does not need to be unique. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Location.alias | |
Definition | A list of alternate names that the location is known as, or was known as, in the past. |
Cardinality | 0...* |
Type | string |
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. |
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. |
Invariants |
|
Mappings |
|
Location.description | |
Definition | Description of the Location, which helps in finding or referencing the place. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Humans need additional information to verify a correct location has been identified. |
Invariants |
|
Mappings |
|
Location.mode | |
Definition | Indicates whether a resource instance represents a specific location or a class of locations. |
Cardinality | 0...1 |
Type | code |
Binding | Indicates whether a resource instance represents a specific location or a class of locations. |
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. |
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. |
Invariants |
|
Mappings |
|
Location.type | |
Definition | Indicates the type of function performed at the location. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Indicates the type of function performed at the location. |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Location.type.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Location.type.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 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | 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. |
Invariants |
|
Mappings |
|
Location.type.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Location.type.coding.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 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.type.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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. |
Invariants |
|
Mappings |
|
Location.type.coding.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
Location.type.coding.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Location.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Location.type.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
Location.type.text | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | 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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Location.telecom | |
Definition | The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. |
Cardinality | 0...* |
Type | ContactPoint |
Invariants |
|
Mappings |
|
Location.address | |
Definition | Physical location. |
Cardinality | 0...1 |
Type | Address |
Must Support | True |
Requirements | If locations can be visited, we need to keep track of their address. |
Comments | Additional addresses should be recorded using another instance of the Location resource, or via the Organization. |
Invariants |
|
Mappings |
|
Location.address.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Location.address.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 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.address.use | |
Definition | The purpose of this address. |
Cardinality | 0...1 |
Type | code |
Binding | The use of an address. |
Modifier | True |
Summary | True |
Requirements | Allows an appropriate address to be chosen from a list of many. |
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Examples | General home |
Mappings |
|
Location.address.type | |
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Cardinality | 1...1 |
Type | code |
Binding | The type of an address (physical / postal). |
Must Support | True |
Summary | True |
Comments | 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). |
Invariants |
|
Fixed Value | physical |
Mappings |
|
Location.address.text | |
Definition | Specifies 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | A renderable, unencoded form. |
Comments | 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. |
Invariants |
|
Examples | General 137 Nowhere Street, Erewhon 9132 |
Mappings |
|
Location.address.line | |
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
Cardinality | 1...* |
Type | string |
Must Support | True |
Summary | True |
Invariants |
|
Examples | General 137 Nowhere Street |
Mappings |
|
Location.address.city | |
Definition | The name of the city, town, suburb, village or other community or delivery center. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Municpality |
Invariants |
|
Examples | General Erewhon |
Mappings |
|
Location.address.district | |
Definition | The name of the administrative area (county). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | County |
Comments | 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. |
Invariants |
|
Examples | General Madison |
Mappings |
|
Location.address.state | |
Definition | Sub-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). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Province, Territory |
Invariants |
|
Mappings |
|
Location.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Zip |
Invariants |
|
Examples | General 9132 |
Mappings |
|
Location.address.country | |
Definition | Country - a nation as commonly understood or generally accepted. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. |
Invariants |
|
Mappings |
|
Location.address.period | |
Definition | Time period when address was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | Allows addresses to be placed in historical context. |
Invariants |
|
Examples | General { "start": "2010-03-23", "end": "2010-07-01" } |
Mappings |
|
Location.physicalType | |
Definition | Physical form of the location, e.g. building, room, vehicle, road. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Physical form of the location. |
Must Support | True |
Summary | True |
Requirements | For purposes of showing relevant locations in queries, we need to categorize locations. |
Invariants |
|
Mappings |
|
Location.physicalType.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Location.physicalType.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 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.physicalType.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | 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. |
Invariants |
|
Mappings |
|
Location.physicalType.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Location.physicalType.coding.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 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.physicalType.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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. |
Invariants |
|
Mappings |
|
Location.physicalType.coding.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
Location.physicalType.coding.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Location.physicalType.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Location.physicalType.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
Location.physicalType.text | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | 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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
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). |
Cardinality | 0...1 |
Type | BackboneElement |
Must Support | True |
Requirements | For mobile applications and automated route-finding knowing the exact location of the Location is required. |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
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 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
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 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. 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
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 below). |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Invariants |
|
Mappings |
|
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 below). |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Invariants |
|
Mappings |
|
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 below). |
Cardinality | 0...1 |
Type | decimal |
Invariants |
|
Mappings |
|
Location.managingOrganization | |
Definition | The organization responsible for the provisioning and upkeep of the location. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Requirements | Need to know who manages the location. |
Comments | 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. |
Invariants |
|
Mappings |
|
Location.partOf | |
Definition | Another Location of which this Location is physically a part of. |
Cardinality | 0...1 |
Type | Reference(HVOLocation) |
Must Support | True |
Requirements | For purposes of location, display and identification, knowing which locations are located within other locations is important. |
Invariants |
|
Mappings |
|
Location.hoursOfOperation | |
Definition | What days/times during a week is this location usually open. |
Cardinality | 0...* |
Type | BackboneElement |
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. |
Invariants |
|
Mappings |
|
Location.hoursOfOperation.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Location.hoursOfOperation.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 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Location.hoursOfOperation.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 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. 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
Location.hoursOfOperation.daysOfWeek | |
Definition | Indicates which days of the week are available between the start and end Times. |
Cardinality | 0...* |
Type | code |
Binding | The days of the week. |
Invariants |
|
Mappings |
|
Location.hoursOfOperation.allDay | |
Definition | The Location is open all day. |
Cardinality | 0...1 |
Type | boolean |
Invariants |
|
Mappings |
|
Location.hoursOfOperation.openingTime | |
Definition | Time that the Location opens. |
Cardinality | 0...1 |
Type | time |
Invariants |
|
Mappings |
|
Location.hoursOfOperation.closingTime | |
Definition | Time that the Location closes. |
Cardinality | 0...1 |
Type | time |
Invariants |
|
Mappings |
|
Location.availabilityExceptions | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Invariants |
|
Mappings |
|
Location.endpoint | |
Definition | Technical endpoints providing access to services operated for the location. |
Cardinality | 0...* |
Type | Reference(Endpoint) |
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 |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="HVOLocation" /> <url value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOLocation" /> <version value="0.1.0" /> <name value="HVOLocation" /> <status value="draft" /> <description value="Location profile for HVO" /> <fhirVersion value="4.0.1" /> <mapping> <identity value="LocationToHVOPlatsLogical" /> <uri value="HVOPlatsLogical" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="Location" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Location" /> <derivation value="constraint" /> <differential> <element id="Location.id"> <path value="Location.id" /> <mustSupport value="true" /> </element> <element id="Location.extension"> <path value="Location.extension" /> <min value="1" /> </element> <element id="Location.extension:period"> <path value="Location.extension" /> <sliceName value="period" /> <min value="1" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOLocationPeriodExtension" /> </type> <mustSupport value="true" /> </element> <element id="Location.extension:period.url"> <path value="Location.extension.url" /> <mustSupport value="true" /> </element> <element id="Location.extension:period.value[x]"> <path value="Location.extension.value[x]" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Location.extension:period.value[x].start"> <path value="Location.extension.value[x].start" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Location.extension:period.value[x].end"> <path value="Location.extension.value[x].end" /> <mustSupport value="true" /> </element> <element id="Location.identifier"> <path value="Location.identifier" /> <slicing> <discriminator> <type value="value" /> <path value="identifier.system" /> </discriminator> <description value="Slice on value based on the type code value" /> <ordered value="false" /> <rules value="open" /> </slicing> <max value="1" /> <mustSupport value="true" /> <mapping> <identity value="LocationToHVOPlatsLogical" /> <map value="id" /> </mapping> </element> <element id="Location.identifier:municipality"> <path value="Location.identifier" /> <sliceName value="municipality" /> <short value="Identifier when Location is a municipality (sv: kommun)" /> <min value="0" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Location.identifier:municipality.system"> <path value="Location.identifier.system" /> <min value="1" /> <patternUri value="dummy.se/identifier/hvo-municipalities-scb" /> <mustSupport value="true" /> </element> <element id="Location.identifier:municipality.value"> <path value="Location.identifier.value" /> <min value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://electronichealth.se/hvo/ValueSet/hvo-municipalities-scb" /> </binding> </element> <element id="Location.identifier:county"> <path value="Location.identifier" /> <sliceName value="county" /> <short value="Identifier when Location is a county (sv: län)" /> <min value="0" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Location.identifier:county.system"> <path value="Location.identifier.system" /> <min value="1" /> <patternUri value="dummy.se/identifier/hvo-counties-scb" /> <mustSupport value="true" /> </element> <element id="Location.identifier:county.value"> <path value="Location.identifier.value" /> <min value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://electronichealth.se/hvo/ValueSet/hvo-counties-scb" /> </binding> </element> <element id="Location.status"> <path value="Location.status" /> <min value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://hl7.org/fhir/ValueSet/location-status" /> </binding> <mapping> <identity value="LocationToHVOPlatsLogical" /> <map value="status" /> </mapping> </element> <element id="Location.name"> <path value="Location.name" /> <mustSupport value="true" /> <mapping> <identity value="LocationToHVOPlatsLogical" /> <map value="namn" /> </mapping> </element> <element id="Location.description"> <path value="Location.description" /> <mustSupport value="true" /> <mapping> <identity value="LocationToHVOPlatsLogical" /> <map value="beskrivning" /> </mapping> </element> <element id="Location.type"> <path value="Location.type" /> <short value="Code for functionality of location." /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://electronichealth.se/hvo/ValueSet/hvo-location-functionality" /> </binding> <mapping> <identity value="LocationToHVOPlatsLogical" /> <map value="funktion" /> </mapping> </element> <element id="Location.type.coding"> <path value="Location.type.coding" /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Location.type.coding.system"> <path value="Location.type.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Location.type.coding.code"> <path value="Location.type.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Location.address"> <path value="Location.address" /> <mustSupport value="true" /> </element> <element id="Location.address.type"> <path value="Location.address.type" /> <min value="1" /> <fixedCode value="physical" /> <mustSupport value="true" /> </element> <element id="Location.address.line"> <path value="Location.address.line" /> <short value="A line in an address, according to Swedish standard SS 637003:2015.\n For example: \nBacken Norrgården 1B, \nHedesunda, Gävle.\nThis repeating element order: The order in which lines should appear in an address label" /> <min value="1" /> <constraint> <key value="hvo-address-line-1" /> <severity value="warning" /> <human value="A line in an address should have max length of 128 characters" /> <expression value="$this.length() <= 128" /> <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOLocation" /> </constraint> <mustSupport value="true" /> <mapping> <identity value="LocationToHVOPlatsLogical" /> <map value="adressrad" /> </mapping> </element> <element id="Location.physicalType"> <path value="Location.physicalType" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://hl7.org/fhir/ValueSet/location-physical-type" /> </binding> <mapping> <identity value="LocationToHVOPlatsLogical" /> <map value="typ" /> </mapping> </element> <element id="Location.physicalType.coding"> <path value="Location.physicalType.coding" /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Location.physicalType.coding.system"> <path value="Location.physicalType.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Location.physicalType.coding.code"> <path value="Location.physicalType.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Location.position"> <path value="Location.position" /> <mustSupport value="true" /> <mapping> <identity value="LocationToHVOPlatsLogical" /> <map value="harPosition(HVOPositionLogical)" /> </mapping> </element> <element id="Location.position.longitude"> <path value="Location.position.longitude" /> <mustSupport value="true" /> </element> <element id="Location.position.latitude"> <path value="Location.position.latitude" /> <mustSupport value="true" /> </element> <element id="Location.partOf"> <path value="Location.partOf" /> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy"> <valueBoolean value="true" /> </extension> <code value="Reference" /> <targetProfile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOLocation" /> </type> <mustSupport value="true" /> <mapping> <identity value="LocationToHVOPlatsLogical" /> <map value="delAv(HVOPlatsLogical)" /> </mapping> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "HVOLocation", "url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOLocation", "version": "0.1.0", "name": "HVOLocation", "status": "draft", "description": "Location profile for HVO", "fhirVersion": "4.0.1", "mapping": [ { "identity": "LocationToHVOPlatsLogical", "uri": "HVOPlatsLogical" } ], "kind": "resource", "abstract": false, "type": "Location", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Location", "derivation": "constraint", "differential": { "element": [ { "id": "Location.id", "path": "Location.id", "mustSupport": true }, { "id": "Location.extension", "path": "Location.extension", "min": 1 }, { "id": "Location.extension:period", "path": "Location.extension", "sliceName": "period", "min": 1, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOLocationPeriodExtension" ] } ], "mustSupport": true }, { "id": "Location.extension:period.url", "path": "Location.extension.url", "mustSupport": true }, { "id": "Location.extension:period.value[x]", "path": "Location.extension.value[x]", "min": 1, "mustSupport": true }, { "id": "Location.extension:period.value[x].start", "path": "Location.extension.value[x].start", "min": 1, "mustSupport": true }, { "id": "Location.extension:period.value[x].end", "path": "Location.extension.value[x].end", "mustSupport": true }, { "id": "Location.identifier", "path": "Location.identifier", "slicing": { "discriminator": [ { "type": "value", "path": "identifier.system" } ], "rules": "open", "ordered": false, "description": "Slice on value based on the type code value" }, "max": "1", "mustSupport": true, "mapping": [ { "identity": "LocationToHVOPlatsLogical", "map": "id" } ] }, { "id": "Location.identifier:municipality", "path": "Location.identifier", "sliceName": "municipality", "short": "Identifier when Location is a municipality (sv: kommun)", "min": 0, "max": "1", "mustSupport": true }, { "id": "Location.identifier:municipality.system", "path": "Location.identifier.system", "min": 1, "patternUri": "dummy.se/identifier/hvo-municipalities-scb", "mustSupport": true }, { "id": "Location.identifier:municipality.value", "path": "Location.identifier.value", "min": 1, "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://electronichealth.se/hvo/ValueSet/hvo-municipalities-scb" } }, { "id": "Location.identifier:county", "path": "Location.identifier", "sliceName": "county", "short": "Identifier when Location is a county (sv: län)", "min": 0, "max": "1", "mustSupport": true }, { "id": "Location.identifier:county.system", "path": "Location.identifier.system", "min": 1, "patternUri": "dummy.se/identifier/hvo-counties-scb", "mustSupport": true }, { "id": "Location.identifier:county.value", "path": "Location.identifier.value", "min": 1, "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://electronichealth.se/hvo/ValueSet/hvo-counties-scb" } }, { "id": "Location.status", "path": "Location.status", "min": 1, "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/location-status" }, "mapping": [ { "identity": "LocationToHVOPlatsLogical", "map": "status" } ] }, { "id": "Location.name", "path": "Location.name", "mustSupport": true, "mapping": [ { "identity": "LocationToHVOPlatsLogical", "map": "namn" } ] }, { "id": "Location.description", "path": "Location.description", "mustSupport": true, "mapping": [ { "identity": "LocationToHVOPlatsLogical", "map": "beskrivning" } ] }, { "id": "Location.type", "path": "Location.type", "short": "Code for functionality of location.", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://electronichealth.se/hvo/ValueSet/hvo-location-functionality" }, "mapping": [ { "identity": "LocationToHVOPlatsLogical", "map": "funktion" } ] }, { "id": "Location.type.coding", "path": "Location.type.coding", "min": 1, "max": "1", "mustSupport": true }, { "id": "Location.type.coding.system", "path": "Location.type.coding.system", "min": 1, "mustSupport": true }, { "id": "Location.type.coding.code", "path": "Location.type.coding.code", "min": 1, "mustSupport": true }, { "id": "Location.address", "path": "Location.address", "mustSupport": true }, { "id": "Location.address.type", "path": "Location.address.type", "min": 1, "fixedCode": "physical", "mustSupport": true }, { "id": "Location.address.line", "path": "Location.address.line", "short": "A line in an address, according to Swedish standard SS 637003:2015.\n For example: \nBacken Norrgården 1B, \nHedesunda, Gävle.\nThis repeating element order: The order in which lines should appear in an address label", "min": 1, "constraint": [ { "key": "hvo-address-line-1", "human": "A line in an address should have max length of 128 characters", "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOLocation", "severity": "warning", "expression": "$this.length() <= 128" } ], "mustSupport": true, "mapping": [ { "identity": "LocationToHVOPlatsLogical", "map": "adressrad" } ] }, { "id": "Location.physicalType", "path": "Location.physicalType", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/location-physical-type" }, "mapping": [ { "identity": "LocationToHVOPlatsLogical", "map": "typ" } ] }, { "id": "Location.physicalType.coding", "path": "Location.physicalType.coding", "min": 1, "max": "1", "mustSupport": true }, { "id": "Location.physicalType.coding.system", "path": "Location.physicalType.coding.system", "min": 1, "mustSupport": true }, { "id": "Location.physicalType.coding.code", "path": "Location.physicalType.coding.code", "min": 1, "mustSupport": true }, { "id": "Location.position", "path": "Location.position", "mustSupport": true, "mapping": [ { "identity": "LocationToHVOPlatsLogical", "map": "harPosition(HVOPositionLogical)" } ] }, { "id": "Location.position.longitude", "path": "Location.position.longitude", "mustSupport": true }, { "id": "Location.position.latitude", "path": "Location.position.latitude", "mustSupport": true }, { "id": "Location.partOf", "path": "Location.partOf", "type": [ { "code": "Reference", "targetProfile": [ "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOLocation" ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", "valueBoolean": true } ] } ], "mustSupport": true, "mapping": [ { "identity": "LocationToHVOPlatsLogical", "map": "delAv(HVOPlatsLogical)" } ] } ] } }
Details
Validation rules
Rule ID | Element | Description | Expression | Error | Severity |
---|---|---|---|---|---|
hvo-dateTime-1 | period.start, period.end | DateTime should follow format YYYY-MM-DDThh:mm:ss+zz:zz, e.g. 1905-08-23T13:04:00+01:00 | $this.toString().matches('([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\\\.[0-9]{1,9})?(Z|(\\\\+|-)(0[0-9]|1[0-3]):([0-5][0-9]|14:00)') |
2-34-316: %s är ett ogiltigt format för datum (hvo-dateTime-1) | Error |
per-1 | period | If present, start SHALL have a lower value than end | start.hasValue().not() or end.hasValue().not() or (start <= end) |
2-34-318: Startdatumet i en period måste ha ett lägre värde än slutdatumet om båda är angivna (per-1) | Error |
hvo-address-line-1 | address.line | A line in an address should have max length of 128 characters | $this.length() <= 128 |
%s överskrider maxlängden för adressrad | Error |
hvo-location-name-1 | name | ||||
hvo-location-description-1 | description |
Supported operations
HTTP methods
Operation | Supported | Comment |
---|---|---|
Search (GET, POST) | yes | Only GET |
Insert (POST) | yes/no | |
Update (PUT) | yes/no | |
Delete (DEL) | no | |
Operation (GET, POST) | yes/no |
Query operations
Supported Queries
GET .../Location
returns a Bundle of all Locations.GET .../Location/[LogicalId]
returns the Location with the supplied logical ID.GET .../Location?[parameters]
Parameter options:
identifier.system=lan
returns Bundle of all Locations that are counties.identifier.system=kommun
returns Bundle of all Locations that are municipalities.
Search parameters
Parameter | Description | Comment |
---|---|---|
_id | Logical ID (UUID) of a Location. | |
identifier | External ID of a Location. | |
Location/[LogicalId] | A read based on the logical ID (UUID) of an Location. |